Class PaginatedEpisodeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Episode collection resources.

public class PaginatedEpisodeClient : PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>

Inheritance

object

ResourceClient<Episode>

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>

PaginatedEpisodeClient

Inherited Members

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.PerPage(int)

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.Offset(int)

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.Filter(string)

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.PostAsync(Episode, CancellationToken)

PaginatedResourceClient<Episode, EpisodeApiResource, EpisodeCollectionResponse, EpisodeResponse>.PostAsync(JsonApiDocument<EpisodeApiResource>, CancellationToken)

ResourceClient<Episode>.AddQueryParameter(string, string)

ResourceClient<Episode>.ReplaceQueryParameter(string, string)

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

PaginatedEpisodeClient(HttpClient, Uri)

Client for interacting with Episode collection resources.

public PaginatedEpisodeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEpisodeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEpisodeClient

The current PaginatedEpisodeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEpisodeClient ClearParameters()

Returns

PaginatedEpisodeClient

The current PaginatedEpisodeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEpisodeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEpisodeClient

The current PaginatedEpisodeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of Episode resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of Episode resources.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEpisodeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEpisodeClient

The current PaginatedEpisodeClient instance.

OrderByPublishedLiveAt()

Sort response items by the PublishedLiveAt attribute.

public EpisodeClient OrderByPublishedLiveAt()

Returns

EpisodeClient

OrderByPublishedLiveAtDescending()

Sort response items by the PublishedLiveAt attribute. Use reverse order.

public EpisodeClient OrderByPublishedLiveAtDescending()

Returns

EpisodeClient

OrderByPublishedToLibraryAt()

Sort response items by the PublishedToLibraryAt attribute.

public EpisodeClient OrderByPublishedToLibraryAt()

Returns

EpisodeClient

OrderByPublishedToLibraryAtDescending()

Sort response items by the PublishedToLibraryAt attribute. Use reverse order.

public EpisodeClient OrderByPublishedToLibraryAtDescending()

Returns

EpisodeClient

OrderByStreamType()

Sort response items by the StreamType attribute.

public EpisodeClient OrderByStreamType()

Returns

EpisodeClient

OrderByStreamTypeDescending()

Sort response items by the StreamType attribute. Use reverse order.

public EpisodeClient OrderByStreamTypeDescending()

Returns

EpisodeClient

OrderByTitle()

Sort response items by the Title attribute.

public EpisodeClient OrderByTitle()

Returns

EpisodeClient

OrderByTitleDescending()

Sort response items by the Title attribute. Use reverse order.

public EpisodeClient OrderByTitleDescending()

Returns

EpisodeClient

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedEpisodeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEpisodeClient

The current PaginatedEpisodeClient instance.

PostAsync(Episode, CancellationToken)

Creates a new Episode resource asynchronously.

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

Parameters

resource Episode

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EpisodeApiResource>, CancellationToken)

Creates a new Episode resource asynchronously.

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

Parameters

document JsonApiDocument<EpisodeApiResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereSeriesId(int)

Query response items by the SeriesId attribute.

public EpisodeClient WhereSeriesId(int value)

Parameters

value int

Returns

EpisodeClient

WhereServicesPlanRemoteIdentifier(string)

Query response items by the ServicesPlanRemoteIdentifier attribute.

public EpisodeClient WhereServicesPlanRemoteIdentifier(string value)

Parameters

value string

Returns

EpisodeClient

WhereServicesServiceTypeRemoteIdentifier(string)

Query response items by the ServicesServiceTypeRemoteIdentifier attribute.

public EpisodeClient WhereServicesServiceTypeRemoteIdentifier(string value)

Parameters

value string

Returns

EpisodeClient

WithId(string)

Creates a new instance of a Episode client for a specific resource ID.

public EpisodeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EpisodeClient

A new instance of the resource client for the specified resource ID.