Class WidgetsRequestBuilder

Builds and executes requests for operations under \widgets

Inheritance

object

BaseRequestBuilder

WidgetsRequestBuilder

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

Assembly: Grist4NET.Kiota.dll

Syntax

public class WidgetsRequestBuilder : BaseRequestBuilder

Constructors

WidgetsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WidgetsRequestBuilder and sets the default values.

Declaration

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

WidgetsRequestBuilder(string, IRequestAdapter)

Instantiates a new WidgetsRequestBuilder and sets the default values.

Declaration

public WidgetsRequestBuilder(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<DefaultQueryParameters>>, CancellationToken)

Get all widget definitions from the configured widget repository.Custom widgets extend Grist's functionality with specialized views.

Declaration

public Task<List<Widgets>> 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<List<Widgets>>	A List<global::Grist4NET.Kiota.Widgets.Widgets>

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

Get all widget definitions from the configured widget repository.Custom widgets extend Grist's functionality with specialized views.

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 WidgetsRequestBuilder WithUrl(string rawUrl)

Parameters

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

Returns

Type	Description
WidgetsRequestBuilder	A WidgetsRequestBuilder