Class EpisodeTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EpisodeTime resource.

public class EpisodeTimeClient : SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>

Inheritance

object

ResourceClient<EpisodeTime>

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>

EpisodeTimeClient

Inherited Members

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>.PatchAsync(EpisodeTime, CancellationToken)

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>.PatchAsync(JsonApiDocument<EpisodeTimeResource>, CancellationToken)

SingletonResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<EpisodeTime>.AddQueryParameter(string, string)

ResourceClient<EpisodeTime>.ReplaceQueryParameter(string, string)

ResourceClient<EpisodeTime>.AddCustomParameter(string, string)

ResourceClient<EpisodeTime>.ClearParameters()

ResourceClient<EpisodeTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EpisodeTime>.Uri

ResourceClient<EpisodeTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EpisodeTimeClient(HttpClient, Uri)

Client for interacting with the EpisodeTime resource.

public EpisodeTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

DeleteAsync(CancellationToken)

Deletes the EpisodeTime resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the EpisodeTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(EpisodeTime, CancellationToken)

Updates an existing EpisodeTime resource asynchronously.

public Task<EpisodeTimeResponse> PatchAsync(EpisodeTime resource, CancellationToken cancellationToken = default)

Parameters

resource EpisodeTime

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeResponse>

A task representing the asynchronous operation, containing the updated EpisodeTime resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<EpisodeTimeResource>, CancellationToken)

Updates an existing EpisodeTime resource asynchronously.

public Task<EpisodeTimeResponse> PatchAsync(JsonApiDocument<EpisodeTimeResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EpisodeTimeResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeResponse>

A task representing the asynchronous operation, containing the updated EpisodeTime resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.