Class PaginatedEpisodeResourceClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EpisodeResource collection resources.

public class PaginatedEpisodeResourceClient : PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>

Inheritance

object

ResourceClient<EpisodeResource>

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>

PaginatedEpisodeResourceClient

Inherited Members

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.PerPage(int)

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.Offset(int)

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.Filter(string)

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.PostAsync(EpisodeResource, CancellationToken)

PaginatedResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceCollectionResponse, EpisodeResourceResponse>.PostAsync(JsonApiDocument<EpisodeResourceResource>, CancellationToken)

ResourceClient<EpisodeResource>.AddQueryParameter(string, string)

ResourceClient<EpisodeResource>.ReplaceQueryParameter(string, string)

ResourceClient<EpisodeResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EpisodeResource>.Uri

ResourceClient<EpisodeResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEpisodeResourceClient(HttpClient, Uri)

Client for interacting with EpisodeResource collection resources.

public PaginatedEpisodeResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEpisodeResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEpisodeResourceClient

The current PaginatedEpisodeResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEpisodeResourceClient ClearParameters()

Returns

PaginatedEpisodeResourceClient

The current PaginatedEpisodeResourceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEpisodeResourceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEpisodeResourceClient

The current PaginatedEpisodeResourceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EpisodeResource resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEpisodeResourceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEpisodeResourceClient

The current PaginatedEpisodeResourceClient instance.

OrderByPosition()

Sort response items by the Position attribute.

public EpisodeResourceClient OrderByPosition()

Returns

EpisodeResourceClient

OrderByPositionDescending()

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

public EpisodeResourceClient OrderByPositionDescending()

Returns

EpisodeResourceClient

PerPage(int)

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

public PaginatedEpisodeResourceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEpisodeResourceClient

The current PaginatedEpisodeResourceClient instance.

PostAsync(EpisodeResource, CancellationToken)

Creates a new EpisodeResource resource asynchronously.

public Task<EpisodeResourceResponse> PostAsync(EpisodeResource resource, CancellationToken cancellationToken = default)

Parameters

resource EpisodeResource

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EpisodeResourceResource>, CancellationToken)

Creates a new EpisodeResource resource asynchronously.

public Task<EpisodeResourceResponse> PostAsync(JsonApiDocument<EpisodeResourceResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EpisodeResourceResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public EpisodeResourceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EpisodeResourceClient

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