Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class RemoveRequestBuilder

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

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

    Constructors

    RemoveRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new RemoveRequestBuilder and sets the default values.

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

    RemoveRequestBuilder(string, IRequestAdapter)

    Instantiates a new RemoveRequestBuilder and sets the default values.

    Declaration
    public RemoveRequestBuilder(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

    PostAsync(Action<RequestConfiguration<RemoveRequestBuilderPostQueryParameters>>, CancellationToken)

    Soft-delete the document by moving it to trash. The document can berestored using the unremove endpoint. If the permanent query parameteris set to true, the document is permanently deleted instead.

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

    ToPostRequestInformation(Action<RequestConfiguration<RemoveRequestBuilderPostQueryParameters>>)

    Soft-delete the document by moving it to trash. The document can berestored using the unremove endpoint. If the permanent query parameteris set to true, the document is permanently deleted instead.

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    RemoveRequestBuilder

    A RemoveRequestBuilder

    In this article
    Back to top Generated by DocFX