Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class XlsxRequestBuilder

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

    Inheritance
    object
    BaseRequestBuilder
    XlsxRequestBuilder
    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.Xlsx
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class XlsxRequestBuilder : BaseRequestBuilder

    Constructors

    XlsxRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new XlsxRequestBuilder and sets the default values.

    Declaration
    public XlsxRequestBuilder(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.

    XlsxRequestBuilder(string, IRequestAdapter)

    Instantiates a new XlsxRequestBuilder and sets the default values.

    Declaration
    public XlsxRequestBuilder(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<XlsxRequestBuilderGetQueryParameters>>, CancellationToken)

    Content of document, as an Excel file

    Declaration
    public Task<Stream> GetAsync(Action<RequestConfiguration<XlsxRequestBuilder.XlsxRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<XlsxRequestBuilder.XlsxRequestBuilderGetQueryParameters>> 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<XlsxRequestBuilderGetQueryParameters>>)

    Content of document, as an Excel file

    Declaration
    public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<XlsxRequestBuilder.XlsxRequestBuilderGetQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<XlsxRequestBuilder.XlsxRequestBuilderGetQueryParameters>> 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 XlsxRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    XlsxRequestBuilder

    A XlsxRequestBuilder

    In this article
    Back to top Generated by DocFX