Class ArchiveRequestBuilder
Builds and executes requests for operations under \docs{docId}\attachments\archive
Inherited Members
Namespace: Grist4NET.Kiota.Docs.Item.Attachments.Archive
Assembly: Grist4NET.Kiota.dll
Syntax
public class ArchiveRequestBuilder : BaseRequestBuilder
Constructors
ArchiveRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new ArchiveRequestBuilder and sets the default values.
Declaration
public ArchiveRequestBuilder(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. |
ArchiveRequestBuilder(string, IRequestAdapter)
Instantiates a new ArchiveRequestBuilder and sets the default values.
Declaration
public ArchiveRequestBuilder(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<ArchiveRequestBuilderGetQueryParameters>>, CancellationToken)
Download all attachments
Declaration
public Task<Stream> GetAsync(Action<RequestConfiguration<ArchiveRequestBuilder.ArchiveRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<ArchiveRequestBuilder.ArchiveRequestBuilderGetQueryParameters>> | 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 |
PostAsync(MultipartBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Restores attachments which are missing from external storage.
Declaration
public Task<ArchivePostResponse> PostAsync(MultipartBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| MultipartBody | 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<ArchivePostResponse> |
ToGetRequestInformation(Action<RequestConfiguration<ArchiveRequestBuilderGetQueryParameters>>)
Download all attachments
Declaration
public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<ArchiveRequestBuilder.ArchiveRequestBuilderGetQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<ArchiveRequestBuilder.ArchiveRequestBuilderGetQueryParameters>> | requestConfiguration | Configuration for the request such as headers, query parameters, and middleware options. |
Returns
| Type | Description |
|---|---|
| RequestInformation | A Microsoft.Kiota.Abstractions.RequestInformation |
ToPostRequestInformation(MultipartBody, Action<RequestConfiguration<DefaultQueryParameters>>)
Restores attachments which are missing from external storage.
Declaration
public RequestInformation ToPostRequestInformation(MultipartBody body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| MultipartBody | 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 ArchiveRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| ArchiveRequestBuilder |