Class EpisodeStatisticsClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EpisodeStatistics resource.

public class EpisodeStatisticsClient : SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>

Inheritance

object

ResourceClient<EpisodeStatistics>

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>

EpisodeStatisticsClient

Inherited Members

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>.PatchAsync(EpisodeStatistics, CancellationToken)

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>.PatchAsync(JsonApiDocument<EpisodeStatisticsResource>, CancellationToken)

SingletonResourceClient<EpisodeStatistics, EpisodeStatisticsResource, EpisodeStatisticsResponse>.DeleteAsync(CancellationToken)

ResourceClient<EpisodeStatistics>.AddQueryParameter(string, string)

ResourceClient<EpisodeStatistics>.ReplaceQueryParameter(string, string)

ResourceClient<EpisodeStatistics>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EpisodeStatistics>.Uri

ResourceClient<EpisodeStatistics>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EpisodeStatisticsClient(HttpClient, Uri)

Client for interacting with the EpisodeStatistics resource.

public EpisodeStatisticsClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EpisodeStatisticsClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EpisodeStatisticsClient

The current EpisodeStatisticsClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EpisodeStatisticsClient ClearParameters()

Returns

EpisodeStatisticsClient

The current EpisodeStatisticsClient instance.

GetAsync(CancellationToken)

Fetches the EpisodeStatistics resource asynchronously.

public Task<EpisodeStatisticsResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeStatisticsResponse>

A task representing the asynchronous operation, containing the EpisodeStatistics resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.