Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class UserRequestBuilder

    Builds and executes requests for operations under \profile\user

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

    Constructors

    UserRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new UserRequestBuilder and sets the default values.

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

    UserRequestBuilder(string, IRequestAdapter)

    Instantiates a new UserRequestBuilder and sets the default values.

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

    Locale

    The locale property

    Declaration
    public LocaleRequestBuilder Locale { get; }
    Property Value
    Type Description
    LocaleRequestBuilder

    Name

    The name property

    Declaration
    public NameRequestBuilder Name { get; }
    Property Value
    Type Description
    NameRequestBuilder

    Methods

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

    Returns the profile information of the currently authenticated user.

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

    A User

    ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>)

    Returns the profile information of the currently authenticated user.

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    UserRequestBuilder

    A UserRequestBuilder

    In this article
    Back to top Generated by DocFX