Class WithWorkspaceItemRequestBuilder
Builds and executes requests for operations under \workspaces{workspaceId}
Inherited Members
Namespace: Grist4NET.Kiota.Workspaces.Item
Assembly: Grist4NET.Kiota.dll
Syntax
public class WithWorkspaceItemRequestBuilder : BaseRequestBuilder
Constructors
WithWorkspaceItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new WithWorkspaceItemRequestBuilder and sets the default values.
Declaration
public WithWorkspaceItemRequestBuilder(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. |
WithWorkspaceItemRequestBuilder(string, IRequestAdapter)
Instantiates a new WithWorkspaceItemRequestBuilder and sets the default values.
Declaration
public WithWorkspaceItemRequestBuilder(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 |
Docs
The docs property
Declaration
public DocsRequestBuilder Docs { get; }
Property Value
| Type | Description |
|---|---|
| DocsRequestBuilder |
Import
The import property
Declaration
public ImportRequestBuilder Import { get; }
Property Value
| Type | Description |
|---|---|
| ImportRequestBuilder |
Remove
The remove property
Declaration
public RemoveRequestBuilder Remove { get; }
Property Value
| Type | Description |
|---|---|
| RemoveRequestBuilder |
Unremove
The unremove property
Declaration
public UnremoveRequestBuilder Unremove { get; }
Property Value
| Type | Description |
|---|---|
| UnremoveRequestBuilder |
Methods
DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Delete a workspace
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 workspace
Declaration
public Task<WorkspaceWithDocsAndOrg> 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<WorkspaceWithDocsAndOrg> |
PatchAsync(WorkspaceParameters, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)
Modify a workspace
Declaration
public Task<Stream> PatchAsync(WorkspaceParameters body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| WorkspaceParameters | 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 workspace
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 workspace
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(WorkspaceParameters, Action<RequestConfiguration<DefaultQueryParameters>>)
Modify a workspace
Declaration
public RequestInformation ToPatchRequestInformation(WorkspaceParameters body, Action<RequestConfiguration<DefaultQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| WorkspaceParameters | 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 WithWorkspaceItemRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| WithWorkspaceItemRequestBuilder |