Show / Hide Table of Contents

    Class RequestDecision

    A request decision for a common user.

    Inheritance
    System.Object
    RequestDecision
    Namespace: DocuWare.Platform.ServerClient
    Assembly: DocuWare.Platform.ServerClient.dll
    Syntax
    public class RequestDecision : IRelationsWithProxy

    Properties

    ConfirmRelationLink

    Gets the Uri of the link for the relation “confirm”.

    Declaration
    public string ConfirmRelationLink { get; }
    Property Value
    Type Description
    System.String
    Remarks

    Returns the uri of the link for the relation “confirm” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

    Id

    Sequential order number of the decision in the request. Decision identifier.

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    System.String

    Label

    Label of the decision.

    Declaration
    public string Label { get; set; }
    Property Value
    Type Description
    System.String

    Links

    Declaration
    public Link[] Links { get; set; }
    Property Value
    Type Description
    Link[]

    SelfRelationLink

    Gets the Uri of the link for the relation “self”.

    Declaration
    public string SelfRelationLink { get; }
    Property Value
    Type Description
    System.String
    Remarks

    Returns the uri of the link for the relation “self” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

    Methods

    GetRequestDecisionFromSelfRelation()

    Calls the HTTP Get method on the link for the relation “self”.

    Declaration
    public RequestDecision GetRequestDecisionFromSelfRelation()
    Returns
    Type Description
    RequestDecision

    The content of the response.

    GetRequestDecisionFromSelfRelationAsync()

    Calls the HTTP Get method on the link for the relation “self” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestDecision>> GetRequestDecisionFromSelfRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<RequestDecision>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “self”.

    GetRequestDecisionFromSelfRelationAsync(System.Threading.CancellationToken)

    Calls the HTTP Get method on the link for the relation “self” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<RequestDecision>> GetRequestDecisionFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token to cancel the request.

    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<RequestDecision>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “self”.

    PostToConfirmRelationForString(RequestConfirmedData)

    Calls the HTTP Post method on the link for the relation “confirm”.

    Declaration
    public string PostToConfirmRelationForString(RequestConfirmedData dataToSend)
    Parameters
    Type Name Description
    RequestConfirmedData dataToSend

    The data to send. This data is written into the request body.

    Returns
    Type Description
    System.String

    The content of the response.

    PostToConfirmRelationForStringAsync(RequestConfirmedData)

    Calls the HTTP Post method on the link for the relation “confirm” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(RequestConfirmedData dataToSend)
    Parameters
    Type Name Description
    RequestConfirmedData dataToSend

    The data to send. This data is written into the request body.

    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “confirm”.

    PostToConfirmRelationForStringAsync(System.Threading.CancellationToken, RequestConfirmedData)

    Calls the HTTP Post method on the link for the relation “confirm” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(System.Threading.CancellationToken cancellationToken, RequestConfirmedData dataToSend)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token to cancel the request.

    RequestConfirmedData dataToSend

    The data to send. This data is written into the request body.

    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.String>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “confirm”.

    SetProxy(HttpClientProxy)

    Sets the HTTP communication proxy which is used in further HTTP communication.

    Declaration
    public void SetProxy(HttpClientProxy proxy)
    Parameters
    Type Name Description
    HttpClientProxy proxy

    The instance which is used in further HTTP communication.

    Remarks

    The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.

    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top