Class PaginatedEpisodeTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EpisodeTime collection resources.

public class PaginatedEpisodeTimeClient : PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>

Inheritance

object

ResourceClient<EpisodeTime>

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>

PaginatedEpisodeTimeClient

Inherited Members

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.PerPage(int)

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.Offset(int)

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.Filter(string)

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.PostAsync(EpisodeTime, CancellationToken)

PaginatedResourceClient<EpisodeTime, EpisodeTimeResource, EpisodeTimeCollectionResponse, EpisodeTimeResponse>.PostAsync(JsonApiDocument<EpisodeTimeResource>, 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

PaginatedEpisodeTimeClient(HttpClient, Uri)

Client for interacting with EpisodeTime collection resources.

public PaginatedEpisodeTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of EpisodeTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public EpisodeTimeClient OrderByStartsAt()

Returns

EpisodeTimeClient

OrderByStartsAtDescending()

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

public EpisodeTimeClient OrderByStartsAtDescending()

Returns

EpisodeTimeClient

PostAsync(EpisodeTime, CancellationToken)

Creates a new EpisodeTime resource asynchronously.

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

Parameters

resource EpisodeTime

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EpisodeTimeResource>, CancellationToken)

Creates a new EpisodeTime resource asynchronously.

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

Parameters

document JsonApiDocument<EpisodeTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public EpisodeTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EpisodeTimeClient

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