Class WebhooksRequestBuilder

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

Inheritance

object

BaseRequestBuilder

WebhooksRequestBuilder

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.Webhooks

Assembly: Grist4NET.Kiota.dll

Syntax

public class WebhooksRequestBuilder : BaseRequestBuilder

Constructors

WebhooksRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WebhooksRequestBuilder and sets the default values.

Declaration

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

WebhooksRequestBuilder(string, IRequestAdapter)

Instantiates a new WebhooksRequestBuilder and sets the default values.

Declaration

public WebhooksRequestBuilder(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.webhooks.item collection

Declaration

public WithWebhookItemRequestBuilder this[string position] { get; }

Parameters

Type	Name	Description
string	position	Unique identifier of the item

Property Value

Type	Description
WithWebhookItemRequestBuilder	A WithWebhookItemRequestBuilder

Queue

The queue property

Declaration

public QueueRequestBuilder Queue { get; }

Property Value

Type	Description
QueueRequestBuilder

Methods

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

Returns all webhooks configured for this document, including theirsettings and delivery statistics.

Declaration

public Task<WebhooksGetResponse> 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<WebhooksGetResponse>	A WebhooksGetResponse

PostAsync(WebhooksPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

Creates one or more webhooks that will POST to specified URLs whendata in the document changes. Returns the IDs of the created webhooks.

Declaration

public Task<WebhooksPostResponse> PostAsync(WebhooksPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
WebhooksPostRequestBody	body	The request body
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<WebhooksPostResponse>	A WebhooksPostResponse

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

Returns all webhooks configured for this document, including theirsettings and delivery statistics.

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

ToPostRequestInformation(WebhooksPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

Creates one or more webhooks that will POST to specified URLs whendata in the document changes. Returns the IDs of the created webhooks.

Declaration

public RequestInformation ToPostRequestInformation(WebhooksPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
WebhooksPostRequestBody	body	The request body
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 WebhooksRequestBuilder WithUrl(string rawUrl)

Parameters

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

Returns

Type	Description
WebhooksRequestBuilder	A WebhooksRequestBuilder