Class ActiveRequestBuilder

Builds and executes requests for operations under \session\access\active

Inheritance

object

BaseRequestBuilder

ActiveRequestBuilder

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.Session.Access.Active

Assembly: Grist4NET.Kiota.dll

Syntax

public class ActiveRequestBuilder : BaseRequestBuilder

Constructors

ActiveRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new ActiveRequestBuilder and sets the default values.

Declaration

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

ActiveRequestBuilder(string, IRequestAdapter)

Instantiates a new ActiveRequestBuilder and sets the default values.

Declaration

public ActiveRequestBuilder(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)

Returns information about the active user and organization for the current session.

Declaration

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

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

Switch which user account is active for a given organization.Useful when a user has multiple accounts logged in.

Declaration

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

Parameters

Type	Name	Description
ActivePostRequestBody	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<ActivePostResponse>	A ActivePostResponse

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

Returns information about the active user and organization for the current session.

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(ActivePostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

Switch which user account is active for a given organization.Useful when a user has multiple accounts logged in.

Declaration

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

Parameters

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

Parameters

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

Returns

Type	Description
ActiveRequestBuilder	A ActiveRequestBuilder