Class TablesRequestBuilder

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

Inheritance

object

BaseRequestBuilder

TablesRequestBuilder

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

Assembly: Grist4NET.Kiota.dll

Syntax

public class TablesRequestBuilder : BaseRequestBuilder

Constructors

TablesRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new TablesRequestBuilder and sets the default values.

Declaration

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

TablesRequestBuilder(string, IRequestAdapter)

Instantiates a new TablesRequestBuilder and sets the default values.

Declaration

public TablesRequestBuilder(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 collection

Declaration

public WithTableItemRequestBuilder this[string position] { get; }

Parameters

Type	Name	Description
string	position	normalized table name (see TABLE ID in Raw Data) or numeric row ID in _grist_Tables

Property Value

Type	Description
WithTableItemRequestBuilder	A WithTableItemRequestBuilder

Methods

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

List tables in a document

Declaration

public Task<TablesList> GetAsync(Action<RequestConfiguration<TablesRequestBuilder.TablesRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Action<RequestConfiguration<TablesRequestBuilder.TablesRequestBuilderGetQueryParameters>>	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<TablesList>	A TablesList

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

Modify metadata for existing tables. This endpoint is primarily useful for:- Renaming tables (via the tableId field)- Setting on-demand loading (via the onDemand field)

Declaration

public Task<Stream> PatchAsync(UpdateTables body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
UpdateTables	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(CreateTables, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

Add tables to a document

Declaration

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

Parameters

Type	Name	Description
CreateTables	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<TablesWithoutFields>	A TablesWithoutFields

ToGetRequestInformation(Action<RequestConfiguration<TablesRequestBuilderGetQueryParameters>>)

List tables in a document

Declaration

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<TablesRequestBuilder.TablesRequestBuilderGetQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
Action<RequestConfiguration<TablesRequestBuilder.TablesRequestBuilderGetQueryParameters>>	requestConfiguration	Configuration for the request such as headers, query parameters, and middleware options.

Returns

Type	Description
RequestInformation	A Microsoft.Kiota.Abstractions.RequestInformation

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

Modify metadata for existing tables. This endpoint is primarily useful for:- Renaming tables (via the tableId field)- Setting on-demand loading (via the onDemand field)

Declaration

public RequestInformation ToPatchRequestInformation(UpdateTables body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
UpdateTables	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(CreateTables, Action<RequestConfiguration<DefaultQueryParameters>>)

Add tables to a document

Declaration

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

Parameters

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

Parameters

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

Returns

Type	Description
TablesRequestBuilder	A TablesRequestBuilder