Class DocsRequestBuilder

Builds and executes requests for operations under \docs

Inheritance

object

BaseRequestBuilder

DocsRequestBuilder

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.Docs

Assembly: Grist4NET.Kiota.dll

Syntax

public class DocsRequestBuilder : BaseRequestBuilder

Constructors

DocsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new DocsRequestBuilder and sets the default values.

Declaration

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

DocsRequestBuilder(string, IRequestAdapter)

Instantiates a new DocsRequestBuilder and sets the default values.

Declaration

public DocsRequestBuilder(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

this[string]

Gets an item from the Grist4NET.Kiota.docs.item collection

Declaration

public WithDocItemRequestBuilder this[string position] { get; }

Parameters

Type	Name	Description
string	position	A string id (UUID)

Property Value

Type	Description
WithDocItemRequestBuilder	A WithDocItemRequestBuilder

Methods

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

A unified endpoint for creating documents. Can create an empty document,copy an existing document, or import a file.- To create an empty unsaved document: provide no parameters- To create an empty saved document: provide workspaceId- To copy an existing document: provide sourceDocumentId, workspaceId, and documentName- To import a file: use multipart/form-data with a file upload and optional workspaceId

Declaration

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

Parameters

Type	Name	Description
DocsPostRequestBody	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

ToPostRequestInformation(DocsPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

A unified endpoint for creating documents. Can create an empty document,copy an existing document, or import a file.- To create an empty unsaved document: provide no parameters- To create an empty saved document: provide workspaceId- To copy an existing document: provide sourceDocumentId, workspaceId, and documentName- To import a file: use multipart/form-data with a file upload and optional workspaceId

Declaration

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

Parameters

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

Parameters

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

Returns

Type	Description
DocsRequestBuilder	A DocsRequestBuilder