Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class StatesRequestBuilder

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

    Inheritance
    object
    BaseRequestBuilder
    StatesRequestBuilder
    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.States
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class StatesRequestBuilder : BaseRequestBuilder

    Constructors

    StatesRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new StatesRequestBuilder and sets the default values.

    Declaration
    public StatesRequestBuilder(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.

    StatesRequestBuilder(string, IRequestAdapter)

    Instantiates a new StatesRequestBuilder and sets the default values.

    Declaration
    public StatesRequestBuilder(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

    Remove

    The remove property

    Declaration
    public RemoveRequestBuilder Remove { get; }
    Property Value
    Type Description
    RemoveRequestBuilder

    Methods

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

    Returns a list of document states representing the action history.Each state has a sequential number (n) and a hash (h) that uniquelyidentifies that point in history. Most recent state is first.

    Declaration
    public Task<StatesGetResponse> 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<StatesGetResponse>

    A StatesGetResponse

    ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    Returns a list of document states representing the action history.Each state has a sequential number (n) and a hash (h) that uniquelyidentifies that point in history. Most recent state is first.

    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 StatesRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    StatesRequestBuilder

    A StatesRequestBuilder

    In this article
    Back to top Generated by DocFX