Search Results for

    Show / Hide Table of Contents

    Class MetadataClient

    Inheritance
    object
    ClientBase
    MetadataClient
    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 MetadataClient : ClientBase, IMetadataClient

    Constructors

    MetadataClient(IPictureparkServiceSettings, HttpClient)

    Declaration
    public MetadataClient(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<MetadataStatus> 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<MetadataStatus>

    The overall status of the contents and list items in comparison to the actual schemas' structure

    Implements
    IMetadataClient.GetStatusAsync(CancellationToken)
    Remarks

    Get the status of the metadata items (contents and list items) 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<MetadataClient.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<MetadataClient.ObjectResponseResult<T>>

    Type Parameters
    T

    UpdateOutdatedAsync(CancellationToken)

    Update outdated

    Declaration
    public virtual Task<BusinessProcess> UpdateOutdatedAsync(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>

    Business process

    Implements
    IMetadataClient.UpdateOutdatedAsync(CancellationToken)
    Remarks

    Update outdated metadata items (contents and list items). The changes to the schemas are enforced: data related to removed fields are deleted; eventual references to removed fields are dropped; calculated values are recalculated;
    the ids of the schemas' fields the could not be reused become available again.
    The operation can take a long time and it is therefore executed asynchronously and not awaited. Call WaitForCompletion to wait for the process to finish. The operation is executed asynchronously and 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