Search Results for

    Show / Hide Table of Contents

    Class DisplayValueClient

    Inheritance
    object
    ClientBase
    DisplayValueClient
    Inherited Members
    ClientBase.BaseUrl
    ClientBase.CustomerAlias
    ClientBase.CreateHttpRequestMessageAsync(CancellationToken)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class DisplayValueClient : ClientBase, IDisplayValueClient

    Constructors

    DisplayValueClient(IPictureparkServiceSettings, HttpClient)

    Declaration
    public DisplayValueClient(IPictureparkServiceSettings configuration, HttpClient httpClient)
    Parameters
    IPictureparkServiceSettings configuration

    HttpClient httpClient

    Properties

    JsonSerializerSettings

    Declaration
    protected JsonSerializerSettings JsonSerializerSettings { get; }
    Property Value
    JsonSerializerSettings

    ReadResponseAsString

    Declaration
    public bool ReadResponseAsString { get; set; }
    Property Value
    bool

    Methods

    GetStatusAsync(CancellationToken)

    Get status

    Declaration
    public virtual Task<DisplayValueStatus> GetStatusAsync(CancellationToken cancellationToken = default)
    Parameters
    CancellationToken cancellationToken

    A cancellation token that can be used by other objects or threads to receive notice of cancellation.

    Returns
    Task<DisplayValueStatus>

    VersionInfo

    Implements
    IDisplayValueClient.GetStatusAsync(CancellationToken)
    Remarks

    Get the status of the display values compared to the schema model.

    Exceptions
    ApiException

    A server side error occurred.

    PictureparkValidationException

    Validation exception

    PictureparkForbiddenException

    Forbidden

    PictureparkNotFoundException

    Entity not found

    PictureparkConflictException

    Version conflict

    PictureparkTooManyRequestsException

    Too many requests

    PictureparkException

    Internal server error

    ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

    Declaration
    protected virtual Task<DisplayValueClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
    Parameters
    HttpResponseMessage response

    IReadOnlyDictionary<string, IEnumerable<string>> headers

    CancellationToken cancellationToken

    Returns
    Task<DisplayValueClient.ObjectResponseResult<T>>

    Type Parameters
    T

    RerenderAsync(CancellationToken)

    Re-render the display values

    Declaration
    public virtual Task<BusinessProcess> RerenderAsync(CancellationToken cancellationToken = default)
    Parameters
    CancellationToken cancellationToken

    A cancellation token that can be used by other objects or threads to receive notice of cancellation.

    Returns
    Task<BusinessProcess>

    VersionInfo

    Implements
    IDisplayValueClient.RerenderAsync(CancellationToken)
    Remarks

    The re-rendering only work on those display values that are out of date or not created yet. The process is therefore based on the information returned by the "status" endpoint: if the status is red, the display values of the data
    corresponding to the ContentOrLayerSchemaIds and ListSchemaIds are recalculated.
    The operation is executed asynchronously and it is not awaited. Call WaitForCompletion to wait for the process to finish.

    Exceptions
    ApiException

    A server side error occurred.

    PictureparkValidationException

    Validation exception

    PictureparkForbiddenException

    Forbidden

    PictureparkNotFoundException

    Entity not found

    PictureparkConflictException

    Version conflict

    PictureparkTooManyRequestsException

    Too many requests

    PictureparkException

    Internal server error

    Back to top Generated by DocFX