Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class WithDocItemRequestBuilder

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

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

    Constructors

    WithDocItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new WithDocItemRequestBuilder and sets the default values.

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

    WithDocItemRequestBuilder(string, IRequestAdapter)

    Instantiates a new WithDocItemRequestBuilder and sets the default values.

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

    Methods

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

    Compare this document with another document. Useful for comparinga fork with its trunk document.

    Declaration
    public Task<DocComparison> GetAsync(Action<RequestConfiguration<WithDocItemRequestBuilder.WithDocItemRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<WithDocItemRequestBuilder.WithDocItemRequestBuilderGetQueryParameters>> 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<DocComparison>

    A DocComparison

    ToGetRequestInformation(Action<RequestConfiguration<WithDocItemRequestBuilderGetQueryParameters>>)

    Compare this document with another document. Useful for comparinga fork with its trunk document.

    Declaration
    public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<WithDocItemRequestBuilder.WithDocItemRequestBuilderGetQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<WithDocItemRequestBuilder.WithDocItemRequestBuilderGetQueryParameters>> 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 WithDocItemRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    WithDocItemRequestBuilder

    A WithDocItemRequestBuilder

    In this article
    Back to top Generated by DocFX