Class CompareRequestBuilder

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

Inheritance

object

BaseRequestBuilder

CompareRequestBuilder

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

Assembly: Grist4NET.Kiota.dll

Syntax

public class CompareRequestBuilder : BaseRequestBuilder

Constructors

CompareRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new CompareRequestBuilder and sets the default values.

Declaration

public CompareRequestBuilder(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.

CompareRequestBuilder(string, IRequestAdapter)

Instantiates a new CompareRequestBuilder and sets the default values.

Declaration

public CompareRequestBuilder(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

this[string]

Gets an item from the Grist4NET.Kiota.docs.item.compare.item collection

Declaration

public WithDocItemRequestBuilder this[string position] { get; }

Parameters

Type	Name	Description
string	position	ID of the document to compare with

Property Value

Type	Description
WithDocItemRequestBuilder	A WithDocItemRequestBuilder

Methods

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

Compare two versions of the same document by their state hashes.Returns details about what changed between the versions.

Declaration

public Task<DocComparison> GetAsync(Action<RequestConfiguration<CompareRequestBuilder.CompareRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Action<RequestConfiguration<CompareRequestBuilder.CompareRequestBuilderGetQueryParameters>>	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<CompareRequestBuilderGetQueryParameters>>)

Compare two versions of the same document by their state hashes.Returns details about what changed between the versions.

Declaration

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<CompareRequestBuilder.CompareRequestBuilderGetQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
Action<RequestConfiguration<CompareRequestBuilder.CompareRequestBuilderGetQueryParameters>>	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 CompareRequestBuilder WithUrl(string rawUrl)

Parameters

Type	Name	Description
string	rawUrl	The raw URL to use for the request builder.

Returns

Type	Description
CompareRequestBuilder	A CompareRequestBuilder