Search Results for

    Show / Hide Table of Contents

    Class InfoClient

    Inheritance
    object
    ClientBase
    InfoClient
    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 InfoClient : ClientBase, IInfoClient

    Constructors

    InfoClient(IPictureparkServiceSettings, HttpClient)

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

    GetInfoAsync(CancellationToken)

    Get info

    Declaration
    public virtual Task<CustomerInfo> GetInfoAsync(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<CustomerInfo>

    CustomerInfo

    Implements
    IInfoClient.GetInfoAsync(CancellationToken)
    Remarks

    Get the customer specific configuration infos.

    Exceptions
    ApiException

    A server side error occurred.

    GetStatusAsync(CancellationToken)

    Get status

    Declaration
    public virtual Task<SystemStatus> 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<SystemStatus>

    SystemStatus

    Implements
    IInfoClient.GetStatusAsync(CancellationToken)
    Remarks

    Get the status of the system data compared to the schema model.

    Exceptions
    ApiException

    A server side error occurred.

    GetVersionAsync(CancellationToken)

    Get version

    Declaration
    public virtual Task<VersionInfo> GetVersionAsync(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<VersionInfo>

    VersionInfo

    Implements
    IInfoClient.GetVersionAsync(CancellationToken)
    Remarks

    Get the version information of the deployed application.

    Exceptions
    ApiException

    A server side error occurred.

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

    Declaration
    protected virtual Task<InfoClient.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<InfoClient.ObjectResponseResult<T>>

    Type Parameters
    T

    Back to top Generated by DocFX