Class PaginatedSeriesClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Series collection resources.

public class PaginatedSeriesClient : PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>

Inheritance

object

ResourceClient<Series>

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>

PaginatedSeriesClient

Inherited Members

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.PerPage(int)

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.Offset(int)

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.Filter(string)

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.PostAsync(Series, CancellationToken)

PaginatedResourceClient<Series, SeriesResource, SeriesCollectionResponse, SeriesResponse>.PostAsync(JsonApiDocument<SeriesResource>, CancellationToken)

ResourceClient<Series>.AddQueryParameter(string, string)

ResourceClient<Series>.ReplaceQueryParameter(string, string)

ResourceClient<Series>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Series>.Uri

ResourceClient<Series>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSeriesClient(HttpClient, Uri)

Client for interacting with Series collection resources.

public PaginatedSeriesClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSeriesClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSeriesClient

The current PaginatedSeriesClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSeriesClient ClearParameters()

Returns

PaginatedSeriesClient

The current PaginatedSeriesClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSeriesClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSeriesClient

The current PaginatedSeriesClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Series resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeChannel()

Include related Channel resources in the response.

public SeriesClient IncludeChannel()

Returns

SeriesClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSeriesClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSeriesClient

The current PaginatedSeriesClient instance.

OrderByEndedAt()

Sort response items by the EndedAt attribute.

public SeriesClient OrderByEndedAt()

Returns

SeriesClient

OrderByEndedAtDescending()

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

public SeriesClient OrderByEndedAtDescending()

Returns

SeriesClient

OrderByEpisodesCount()

Sort response items by the EpisodesCount attribute.

public SeriesClient OrderByEpisodesCount()

Returns

SeriesClient

OrderByEpisodesCountDescending()

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

public SeriesClient OrderByEpisodesCountDescending()

Returns

SeriesClient

OrderByStartedAt()

Sort response items by the StartedAt attribute.

public SeriesClient OrderByStartedAt()

Returns

SeriesClient

OrderByStartedAtDescending()

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

public SeriesClient OrderByStartedAtDescending()

Returns

SeriesClient

OrderByTitle()

Sort response items by the Title attribute.

public SeriesClient OrderByTitle()

Returns

SeriesClient

OrderByTitleDescending()

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

public SeriesClient OrderByTitleDescending()

Returns

SeriesClient

PerPage(int)

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

public PaginatedSeriesClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSeriesClient

The current PaginatedSeriesClient instance.

PostAsync(Series, CancellationToken)

Creates a new Series resource asynchronously.

public Task<SeriesResponse> PostAsync(Series resource, CancellationToken cancellationToken = default)

Parameters

resource Series

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<SeriesResource>, CancellationToken)

Creates a new Series resource asynchronously.

public Task<SeriesResponse> PostAsync(JsonApiDocument<SeriesResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SeriesResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SeriesResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereId(string)

Query response items by the Id attribute.

public SeriesClient WhereId(string value)

Parameters

value string

Returns

SeriesClient

WithId(string)

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

public SeriesClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SeriesClient

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