Class WithDocItemRequestBuilder

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

Inheritance

object

BaseRequestBuilder

WithDocItemRequestBuilder

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

Assembly: Grist4NET.Kiota.dll

Syntax

public class WithDocItemRequestBuilder : BaseRequestBuilder

Constructors

WithDocItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithDocItemRequestBuilder and sets the default values.

Declaration

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

WithDocItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithDocItemRequestBuilder and sets the default values.

Declaration

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

Access

The access property

Declaration

public AccessRequestBuilder Access { get; }

Property Value

Type	Description
AccessRequestBuilder

Apply

The apply property

Declaration

public ApplyRequestBuilder Apply { get; }

Property Value

Type	Description
ApplyRequestBuilder

Assign

The assign property

Declaration

public AssignRequestBuilder Assign { get; }

Property Value

Type	Description
AssignRequestBuilder

Attachments

The attachments property

Declaration

public AttachmentsRequestBuilder Attachments { get; }

Property Value

Type	Description
AttachmentsRequestBuilder

Compare

The compare property

Declaration

public CompareRequestBuilder Compare { get; }

Property Value

Type	Description
CompareRequestBuilder

Copy

The copy property

Declaration

public CopyRequestBuilder Copy { get; }

Property Value

Type	Description
CopyRequestBuilder

Disable

The disable property

Declaration

public DisableRequestBuilder Disable { get; }

Property Value

Type	Description
DisableRequestBuilder

Download

The download property

Declaration

public DownloadRequestBuilder Download { get; }

Property Value

Type	Description
DownloadRequestBuilder

Enable

The enable property

Declaration

public EnableRequestBuilder Enable { get; }

Property Value

Type	Description
EnableRequestBuilder

Flush

The flush property

Declaration

public FlushRequestBuilder Flush { get; }

Property Value

Type	Description
FlushRequestBuilder

ForceReload

The forceReload property

Declaration

public ForceReloadRequestBuilder ForceReload { get; }

Property Value

Type	Description
ForceReloadRequestBuilder

Fork

The fork property

Declaration

public ForkRequestBuilder Fork { get; }

Property Value

Type	Description
ForkRequestBuilder

Forms

The forms property

Declaration

public FormsRequestBuilder Forms { get; }

Property Value

Type	Description
FormsRequestBuilder

Move

The move property

Declaration

public MoveRequestBuilder Move { get; }

Property Value

Type	Description
MoveRequestBuilder

Pin

The pin property

Declaration

public PinRequestBuilder Pin { get; }

Property Value

Type	Description
PinRequestBuilder

Proposals

The proposals property

Declaration

public ProposalsRequestBuilder Proposals { get; }

Property Value

Type	Description
ProposalsRequestBuilder

Propose

The propose property

Declaration

public ProposeRequestBuilder Propose { get; }

Property Value

Type	Description
ProposeRequestBuilder

Recover

The recover property

Declaration

public RecoverRequestBuilder Recover { get; }

Property Value

Type	Description
RecoverRequestBuilder

Remove

The remove property

Declaration

public RemoveRequestBuilder Remove { get; }

Property Value

Type	Description
RemoveRequestBuilder

Replace

The replace property

Declaration

public ReplaceRequestBuilder Replace { get; }

Property Value

Type	Description
ReplaceRequestBuilder

Snapshots

The snapshots property

Declaration

public SnapshotsRequestBuilder Snapshots { get; }

Property Value

Type	Description
SnapshotsRequestBuilder

Sql

The sql property

Declaration

public SqlRequestBuilder Sql { get; }

Property Value

Type	Description
SqlRequestBuilder

States

The states property

Declaration

public StatesRequestBuilder States { get; }

Property Value

Type	Description
StatesRequestBuilder

Tables

The tables property

Declaration

public TablesRequestBuilder Tables { get; }

Property Value

Type	Description
TablesRequestBuilder

Timing

The timing property

Declaration

public TimingRequestBuilder Timing { get; }

Property Value

Type	Description
TimingRequestBuilder

Unpin

The unpin property

Declaration

public UnpinRequestBuilder Unpin { get; }

Property Value

Type	Description
UnpinRequestBuilder

Unremove

The unremove property

Declaration

public UnremoveRequestBuilder Unremove { get; }

Property Value

Type	Description
UnremoveRequestBuilder

UsersForViewAs

The usersForViewAs property

Declaration

public UsersForViewAsRequestBuilder UsersForViewAs { get; }

Property Value

Type	Description
UsersForViewAsRequestBuilder

Webhooks

The webhooks property

Declaration

public WebhooksRequestBuilder Webhooks { get; }

Property Value

Type	Description
WebhooksRequestBuilder

Methods

DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

Delete a document

Declaration

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

Parameters

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

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

Describe a document

Declaration

public Task<DocWithWorkspace> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

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

Modify document metadata (but not its contents)

Declaration

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

Parameters

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

ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

Delete a document

Declaration

public RequestInformation ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)

Parameters

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

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

Describe a document

Declaration

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)

Parameters

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

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

Modify document metadata (but not its contents)

Declaration

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

Parameters

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

Parameters

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

Returns

Type	Description
WithDocItemRequestBuilder	A WithDocItemRequestBuilder