Search Results for

    Show / Hide Table of Contents

    Class JsonSchemaClient

    Inheritance
    object
    ClientBase
    JsonSchemaClient
    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 JsonSchemaClient : ClientBase, IJsonSchemaClient

    Constructors

    JsonSchemaClient(IPictureparkServiceSettings, HttpClient)

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

    GetAsync(string, CancellationToken)

    Gets an existing JSON Schema by schema ID.

    Declaration
    public Task<JObject> GetAsync(string schemaId, CancellationToken cancellationToken = default)
    Parameters
    string schemaId

    The schema ID.

    CancellationToken cancellationToken

    The cancellation token.

    Returns
    Task<JObject>

    The JSON Schema as Newtonsoft.Json.Linq.JObject.

    Implements
    IJsonSchemaClient.GetAsync(string, CancellationToken)
    Exceptions
    ApiException

    A server side error occurred.

    GetCoreAsync(string, CancellationToken)

    Get json schema

    Declaration
    protected virtual Task<object> GetCoreAsync(string id, CancellationToken cancellationToken = default)
    Parameters
    string id

    The ID of the schema whose json schema to retrieve.

    CancellationToken cancellationToken

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

    Returns
    Task<object>

    Remarks

    Gets the json schema for the specified schema.

    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<JsonSchemaClient.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<JsonSchemaClient.ObjectResponseResult<T>>

    Type Parameters
    T

    Back to top Generated by DocFX