Class EpisodeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Episode resource.

public class EpisodeClient : SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>

Inheritance

object

ResourceClient<Episode>

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>

EpisodeClient

Inherited Members

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>.PatchAsync(Episode, CancellationToken)

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>.PatchAsync(JsonApiDocument<EpisodeApiResource>, CancellationToken)

SingletonResourceClient<Episode, EpisodeApiResource, EpisodeResponse>.DeleteAsync(CancellationToken)

ResourceClient<Episode>.AddQueryParameter(string, string)

ResourceClient<Episode>.ReplaceQueryParameter(string, string)

ResourceClient<Episode>.AddCustomParameter(string, string)

ResourceClient<Episode>.ClearParameters()

ResourceClient<Episode>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Episode>.Uri

ResourceClient<Episode>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EpisodeClient(HttpClient, Uri)

Client for interacting with the Episode resource.

public EpisodeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Channel

Associated Channel.

public ChannelClient Channel { get; }

Property Value

ChannelClient

EpisodeResources

Associated EpisodeResources.

public PaginatedEpisodeResourceClient EpisodeResources { get; }

Property Value

PaginatedEpisodeResourceClient

EpisodeTimes

Associated EpisodeTimes.

public PaginatedEpisodeTimeClient EpisodeTimes { get; }

Property Value

PaginatedEpisodeTimeClient

NoteTemplate

Associated NoteTemplate.

public NoteTemplateClient NoteTemplate { get; }

Property Value

NoteTemplateClient

Series

Associated Series.

public SeriesClient Series { get; }

Property Value

SeriesClient

Speakerships

Associated Speakerships.

public PaginatedSpeakershipClient Speakerships { get; }

Property Value

PaginatedSpeakershipClient

Methods

DeleteAsync(CancellationToken)

Deletes the Episode 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 Episode resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeChannel()

Include related Channel resources in the response.

public EpisodeClient IncludeChannel()

Returns

EpisodeClient

IncludeEpisodeResources()

Include related EpisodeResources resources in the response.

public EpisodeClient IncludeEpisodeResources()

Returns

EpisodeClient

IncludeEpisodeTimes()

Include related EpisodeTimes resources in the response.

public EpisodeClient IncludeEpisodeTimes()

Returns

EpisodeClient

IncludeSeries()

Include related Series resources in the response.

public EpisodeClient IncludeSeries()

Returns

EpisodeClient

IncludeSpeakerships()

Include related Speakerships resources in the response.

public EpisodeClient IncludeSpeakerships()

Returns

EpisodeClient

PatchAsync(Episode, CancellationToken)

Updates an existing Episode resource asynchronously.

public Task<EpisodeResponse> PatchAsync(Episode resource, CancellationToken cancellationToken = default)

Parameters

resource Episode

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<EpisodeApiResource>, CancellationToken)

Updates an existing Episode resource asynchronously.

public Task<EpisodeResponse> PatchAsync(JsonApiDocument<EpisodeApiResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EpisodeApiResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.