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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEpisodeTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEpisodeTimeClient

The current PaginatedEpisodeTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEpisodeTimeClient ClearParameters()

Returns

PaginatedEpisodeTimeClient

The current PaginatedEpisodeTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEpisodeTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEpisodeTimeClient

The current PaginatedEpisodeTimeClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEpisodeTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEpisodeTimeClient

The current PaginatedEpisodeTimeClient instance.

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

PerPage(int)

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

public PaginatedEpisodeTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEpisodeTimeClient

The current PaginatedEpisodeTimeClient instance.

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.