Class LiveStreamClient

Inheritance

object

ClientBase

LiveStreamClient

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 LiveStreamClient : ClientBase, ILiveStreamClient

Constructors

LiveStreamClient(IPictureparkServiceSettings, HttpClient)

Declaration

public LiveStreamClient(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

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

Declaration

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

Type Parameters

T

SearchAsync(LiveStreamSearchRequest, CancellationToken)

Search

Declaration

public virtual Task<LiveStreamSearchResult> SearchAsync(LiveStreamSearchRequest request, CancellationToken cancellationToken = default)

Parameters

LiveStreamSearchRequest request Parameters for the search

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

Returns

Task<LiveStreamSearchResult> Resulting live stream events

Implements

ILiveStreamClient.SearchAsync(LiveStreamSearchRequest, CancellationToken)

Remarks

Search for live stream events with optional parameters to limit time, document type or use more complex filtering.

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