Class DownloadRequestBuilder

Builds and executes requests for operations under \docs{docId}\download

Inheritance

object

BaseRequestBuilder

DownloadRequestBuilder

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.Item.Download

Assembly: Grist4NET.Kiota.dll

Syntax

public class DownloadRequestBuilder : BaseRequestBuilder

Constructors

DownloadRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new DownloadRequestBuilder and sets the default values.

Declaration

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

DownloadRequestBuilder(string, IRequestAdapter)

Instantiates a new DownloadRequestBuilder and sets the default values.

Declaration

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

Csv

The csv property

Declaration

public CsvRequestBuilder Csv { get; }

Property Value

Type	Description
CsvRequestBuilder

Dsv

The dsv property

Declaration

public DsvRequestBuilder Dsv { get; }

Property Value

Type	Description
DsvRequestBuilder

TableSchema

The tableSchema property

Declaration

public TableSchemaRequestBuilder TableSchema { get; }

Property Value

Type	Description
TableSchemaRequestBuilder

Tsv

The tsv property

Declaration

public TsvRequestBuilder Tsv { get; }

Property Value

Type	Description
TsvRequestBuilder

Xlsx

The xlsx property

Declaration

public XlsxRequestBuilder Xlsx { get; }

Property Value

Type	Description
XlsxRequestBuilder

Methods

GetAsync(Action<RequestConfiguration<DownloadRequestBuilderGetQueryParameters>>, CancellationToken)

Content of document, as an Sqlite file

Declaration

public Task<Stream> GetAsync(Action<RequestConfiguration<DownloadRequestBuilder.DownloadRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Action<RequestConfiguration<DownloadRequestBuilder.DownloadRequestBuilderGetQueryParameters>>	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

ToGetRequestInformation(Action<RequestConfiguration<DownloadRequestBuilderGetQueryParameters>>)

Content of document, as an Sqlite file

Declaration

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DownloadRequestBuilder.DownloadRequestBuilderGetQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
Action<RequestConfiguration<DownloadRequestBuilder.DownloadRequestBuilderGetQueryParameters>>	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 DownloadRequestBuilder WithUrl(string rawUrl)

Parameters

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

Returns

Type	Description
DownloadRequestBuilder	A DownloadRequestBuilder