Class PinRequestBuilder
Builds and executes requests for operations under \docs{docId}\pin
Inherited Members
Namespace: Grist4NET.Kiota.Docs.Item.Pin
Assembly: Grist4NET.Kiota.dll
Syntax
public class PinRequestBuilder : BaseRequestBuilder
Constructors
PinRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new PinRequestBuilder and sets the default values.
Declaration
public PinRequestBuilder(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. |
PinRequestBuilder(string, IRequestAdapter)
Instantiates a new PinRequestBuilder and sets the default values.
Declaration
public PinRequestBuilder(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
PatchAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Pin the document so it appears in a prominent location. Pinned documentsare displayed at the top of workspace listings for easy access.
Declaration
public Task<Stream> PatchAsync(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 |
ToPatchRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)
Pin the document so it appears in a prominent location. Pinned documentsare displayed at the top of workspace listings for easy access.
Declaration
public RequestInformation ToPatchRequestInformation(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 PinRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| PinRequestBuilder |