Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class ProposeRequestBuilder

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

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

    Constructors

    ProposeRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new ProposeRequestBuilder and sets the default values.

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

    ProposeRequestBuilder(string, IRequestAdapter)

    Instantiates a new ProposeRequestBuilder and sets the default values.

    Declaration
    public ProposeRequestBuilder(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(ProposePostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>, CancellationToken)

    Create a proposal from a fork to its trunk document. The proposal containsthe comparison of changes between the fork and trunk.This endpoint can only be called on a fork document.

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

    A ProposePostResponse

    ToPostRequestInformation(ProposePostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>)

    Create a proposal from a fork to its trunk document. The proposal containsthe comparison of changes between the fork and trunk.This endpoint can only be called on a fork document.

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

    The raw URL to use for the request builder.

    Returns
    Type Description
    ProposeRequestBuilder

    A ProposeRequestBuilder

    In this article
    Back to top Generated by DocFX