Class ApikeyRequestBuilder
Builds and executes requests for operations under \profile\apikey
Inherited Members
Namespace: Grist4NET.Kiota.Profile.Apikey
Assembly: Grist4NET.Kiota.dll
Syntax
public class ApikeyRequestBuilder : BaseRequestBuilder
Constructors
ApikeyRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new ApikeyRequestBuilder and sets the default values.
Declaration
public ApikeyRequestBuilder(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. |
ApikeyRequestBuilder(string, IRequestAdapter)
Instantiates a new ApikeyRequestBuilder and sets the default values.
Declaration
public ApikeyRequestBuilder(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
DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Delete the current user's API key.
Declaration
public Task<Stream> DeleteAsync(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<Stream> | A Stream |
GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Returns the current user's API key if one exists.
Declaration
public Task<string> 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<string> | A string |
PostAsync(ApikeyPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Create a new API key or regenerate an existing one.
Declaration
public Task<string> PostAsync(ApikeyPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ApikeyPostRequestBody | 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<string> | A string |
ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)
Delete the current user's API key.
Declaration
public RequestInformation ToDeleteRequestInformation(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 |
ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)
Returns the current user's API key if one exists.
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(ApikeyPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)
Create a new API key or regenerate an existing one.
Declaration
public RequestInformation ToPostRequestInformation(ApikeyPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ApikeyPostRequestBody | 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 ApikeyRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| ApikeyRequestBuilder |