Class AttachmentsRequestBuilder
Builds and executes requests for operations under \docs{docId}\attachments
Inherited Members
Namespace: Grist4NET.Kiota.Docs.Item.Attachments
Assembly: Grist4NET.Kiota.dll
Syntax
public class AttachmentsRequestBuilder : BaseRequestBuilder
Constructors
AttachmentsRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new AttachmentsRequestBuilder and sets the default values.
Declaration
public AttachmentsRequestBuilder(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. |
AttachmentsRequestBuilder(string, IRequestAdapter)
Instantiates a new AttachmentsRequestBuilder and sets the default values.
Declaration
public AttachmentsRequestBuilder(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. |
Properties
Archive
The archive property
Declaration
public ArchiveRequestBuilder Archive { get; }
Property Value
| Type | Description |
|---|---|
| ArchiveRequestBuilder |
this[double]
Gets an item from the Grist4NET.Kiota.docs.item.attachments.item collection
Declaration
public WithAttachmentItemRequestBuilder this[double position] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| double | position | Unique identifier of the item |
Property Value
| Type | Description |
|---|---|
| WithAttachmentItemRequestBuilder |
RemoveUnused
The removeUnused property
Declaration
public RemoveUnusedRequestBuilder RemoveUnused { get; }
Property Value
| Type | Description |
|---|---|
| RemoveUnusedRequestBuilder |
Store
The store property
Declaration
public StoreRequestBuilder Store { get; }
Property Value
| Type | Description |
|---|---|
| StoreRequestBuilder |
Stores
The stores property
Declaration
public StoresRequestBuilder Stores { get; }
Property Value
| Type | Description |
|---|---|
| StoresRequestBuilder |
TransferAll
The transferAll property
Declaration
public TransferAllRequestBuilder TransferAll { get; }
Property Value
| Type | Description |
|---|---|
| TransferAllRequestBuilder |
TransferStatus
The transferStatus property
Declaration
public TransferStatusRequestBuilder TransferStatus { get; }
Property Value
| Type | Description |
|---|---|
| TransferStatusRequestBuilder |
UpdateUsed
The updateUsed property
Declaration
public UpdateUsedRequestBuilder UpdateUsed { get; }
Property Value
| Type | Description |
|---|---|
| UpdateUsedRequestBuilder |
VerifyFiles
The verifyFiles property
Declaration
public VerifyFilesRequestBuilder VerifyFiles { get; }
Property Value
| Type | Description |
|---|---|
| VerifyFilesRequestBuilder |
Methods
GetAsync(Action<RequestConfiguration<AttachmentsRequestBuilderGetQueryParameters>>, CancellationToken)
List metadata of all attachments in a doc
Declaration
public Task<AttachmentMetadataList> GetAsync(Action<RequestConfiguration<AttachmentsRequestBuilder.AttachmentsRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<AttachmentsRequestBuilder.AttachmentsRequestBuilderGetQueryParameters>> | 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<AttachmentMetadataList> |
PostAsync(MultipartBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Upload attachments to a doc
Declaration
public Task<List<int?>> 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<List<int?>> | A List<int> |
ToGetRequestInformation(Action<RequestConfiguration<AttachmentsRequestBuilderGetQueryParameters>>)
List metadata of all attachments in a doc
Declaration
public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<AttachmentsRequestBuilder.AttachmentsRequestBuilderGetQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<AttachmentsRequestBuilder.AttachmentsRequestBuilderGetQueryParameters>> | 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>>)
Upload attachments to a doc
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 AttachmentsRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| AttachmentsRequestBuilder |