Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class WithOrgItemRequestBuilder

    Builds and executes requests for operations under \orgs{orgId}

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

    Constructors

    WithOrgItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new WithOrgItemRequestBuilder and sets the default values.

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

    WithOrgItemRequestBuilder(string, IRequestAdapter)

    Instantiates a new WithOrgItemRequestBuilder and sets the default values.

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

    this[string]

    Gets an item from the Grist4NET.Kiota.orgs.item.item collection

    Declaration
    public WithNameItemRequestBuilder this[string position] { get; }
    Parameters
    Type Name Description
    string position

    The organization name

    Property Value
    Type Description
    WithNameItemRequestBuilder

    A WithNameItemRequestBuilder

    Usage

    The usage property

    Declaration
    public UsageRequestBuilder Usage { get; }
    Property Value
    Type Description
    UsageRequestBuilder

    Workspaces

    The workspaces property

    Declaration
    public WorkspacesRequestBuilder Workspaces { get; }
    Property Value
    Type Description
    WorkspacesRequestBuilder

    Methods

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

    Describe an org

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

    A Org

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

    Modify an org

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

    Describe an org

    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(OrgParameters, Action<RequestConfiguration<DefaultQueryParameters>>)

    Modify an org

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    WithOrgItemRequestBuilder

    A WithOrgItemRequestBuilder

    In this article
    Back to top Generated by DocFX