Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class AccessRequestBuilder

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

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

    Constructors

    AccessRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new AccessRequestBuilder and sets the default values.

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

    AccessRequestBuilder(string, IRequestAdapter)

    Instantiates a new AccessRequestBuilder and sets the default values.

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

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

    List users with access to document

    Declaration
    public Task<DocAccessRead> 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<DocAccessRead>

    A DocAccessRead

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

    Change who has access to document

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

    ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    List users with access to 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(AccessPatchRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

    Change who has access to document

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    AccessRequestBuilder

    A AccessRequestBuilder

    In this article
    Back to top Generated by DocFX