Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class ColumnsRequestBuilder

    Builds and executes requests for operations under \docs{docId}\tables{tableId}\columns

    Inheritance
    object
    BaseRequestBuilder
    ColumnsRequestBuilder
    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.Tables.Item.Columns
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class ColumnsRequestBuilder : BaseRequestBuilder

    Constructors

    ColumnsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new ColumnsRequestBuilder and sets the default values.

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

    ColumnsRequestBuilder(string, IRequestAdapter)

    Instantiates a new ColumnsRequestBuilder and sets the default values.

    Declaration
    public ColumnsRequestBuilder(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.tables.item.columns.item collection

    Declaration
    public WithColItemRequestBuilder this[string position] { get; }
    Parameters
    Type Name Description
    string position

    The column id (without the starting $) as shown in the column configuration below the label

    Property Value
    Type Description
    WithColItemRequestBuilder

    A WithColItemRequestBuilder

    Methods

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

    List columns in a table

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

    A ColumnsList

    PatchAsync(UpdateColumns, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

    Modify columns of a table

    Declaration
    public Task<Stream> PatchAsync(UpdateColumns body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    UpdateColumns 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<Stream>

    A Stream

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

    Add columns to a table

    Declaration
    public Task<ColumnsWithoutFields> PostAsync(CreateColumns body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateColumns 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<ColumnsWithoutFields>

    A ColumnsWithoutFields

    PutAsync(UpdateColumns, Action<RequestConfiguration<ColumnsRequestBuilderPutQueryParameters>>, CancellationToken)

    Add or update columns of a table

    Declaration
    public Task<Stream> PutAsync(UpdateColumns body, Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderPutQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    UpdateColumns body

    The request body

    Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderPutQueryParameters>> 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<ColumnsRequestBuilderGetQueryParameters>>)

    List columns in a table

    Declaration
    public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderGetQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderGetQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    ToPatchRequestInformation(UpdateColumns, Action<RequestConfiguration<DefaultQueryParameters>>)

    Modify columns of a table

    Declaration
    public RequestInformation ToPatchRequestInformation(UpdateColumns body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    UpdateColumns 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

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

    Add columns to a table

    Declaration
    public RequestInformation ToPostRequestInformation(CreateColumns body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    CreateColumns 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

    ToPutRequestInformation(UpdateColumns, Action<RequestConfiguration<ColumnsRequestBuilderPutQueryParameters>>)

    Add or update columns of a table

    Declaration
    public RequestInformation ToPutRequestInformation(UpdateColumns body, Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderPutQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    UpdateColumns body

    The request body

    Action<RequestConfiguration<ColumnsRequestBuilder.ColumnsRequestBuilderPutQueryParameters>> 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 ColumnsRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    ColumnsRequestBuilder

    A ColumnsRequestBuilder

    In this article
    Back to top Generated by DocFX