Class PaginatedSeriesClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

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>.AddCustomParameter(string, string)

ResourceClient<Series>.ClearParameters()

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

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.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public SeriesClient OrderByCreatedAt()

Returns

SeriesClient

OrderByCreatedAtDescending()

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

public SeriesClient OrderByCreatedAtDescending()

Returns

SeriesClient

WhereTitle(string)

Query response items by the Title attribute.

public SeriesClient WhereTitle(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.