Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class OrgsRequestBuilder

    Builds and executes requests for operations under \orgs

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

    Constructors

    OrgsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new OrgsRequestBuilder and sets the default values.

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

    OrgsRequestBuilder(string, IRequestAdapter)

    Instantiates a new OrgsRequestBuilder and sets the default values.

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

    this[int]

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

    Declaration
    public WithOrgItemRequestBuilder this[int position] { get; }
    Parameters
    Type Name Description
    int position

    This can be an integer id, or a string subdomain (e.g. gristlabs), or current if the org is implied by the domain in the url

    Property Value
    Type Description
    WithOrgItemRequestBuilder

    A WithOrgItemRequestBuilder

    Methods

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

    This enumerates all the team sites or personal areas available.

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

    A List<global::Grist4NET.Kiota.Models.Org>

    ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    This enumerates all the team sites or personal areas available.

    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

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    OrgsRequestBuilder

    A OrgsRequestBuilder

    In this article
    Back to top Generated by DocFX