Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class TimingRequestBuilder

    Builds and executes requests for operations under \docs{docId}\timing

    Inheritance
    object
    BaseRequestBuilder
    TimingRequestBuilder
    Inherited Members
    BaseRequestBuilder.PathParameters
    BaseRequestBuilder.RequestAdapter
    BaseRequestBuilder.UrlTemplate
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Grist4NET.Kiota.Docs.Item.Timing
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class TimingRequestBuilder : BaseRequestBuilder

    Constructors

    TimingRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new TimingRequestBuilder and sets the default values.

    Declaration
    public TimingRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    Dictionary<string, object> pathParameters

    Path parameters for the request

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    TimingRequestBuilder(string, IRequestAdapter)

    Instantiates a new TimingRequestBuilder and sets the default values.

    Declaration
    public TimingRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    Properties

    Start

    The start property

    Declaration
    public StartRequestBuilder Start { get; }
    Property Value
    Type Description
    StartRequestBuilder

    Stop

    The stop property

    Declaration
    public StopRequestBuilder Stop { get; }
    Property Value
    Type Description
    StopRequestBuilder

    Methods

    GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

    Check if formula timing is enabled for a document and retrieve timing dataif available. Only document owners can access timing information.

    Declaration
    public Task<TimingGetResponse> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<TimingGetResponse>

    A TimingGetResponse

    ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    Check if formula timing is enabled for a document and retrieve timing dataif available. Only document owners can access timing information.

    Declaration
    public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    WithUrl(string)

    Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

    Declaration
    public TimingRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    TimingRequestBuilder

    A TimingRequestBuilder

    In this article
    Back to top Generated by DocFX