Class PaginatedResourceClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Resource collection resources.

public class PaginatedResourceClient : PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>

Inheritance

object

ResourceClient<Resource>

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>

PaginatedResourceClient

Inherited Members

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.PerPage(int)

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.Offset(int)

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.Filter(string)

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.PostAsync(Resource, CancellationToken)

PaginatedResourceClient<Resource, ResourceResource, ResourceCollectionResponse, ResourceResponse>.PostAsync(JsonApiDocument<ResourceResource>, CancellationToken)

ResourceClient<Resource>.AddQueryParameter(string, string)

ResourceClient<Resource>.ReplaceQueryParameter(string, string)

ResourceClient<Resource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Resource>.Uri

ResourceClient<Resource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedResourceClient(HttpClient, Uri)

Client for interacting with Resource collection resources.

public PaginatedResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedResourceClient

The current PaginatedResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedResourceClient ClearParameters()

Returns

PaginatedResourceClient

The current PaginatedResourceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedResourceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedResourceClient

The current PaginatedResourceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Resource resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ResourceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedResourceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedResourceClient

The current PaginatedResourceClient instance.

OrderByLastUpdated()

Sort response items by the LastUpdated attribute.

public ResourceClient OrderByLastUpdated()

Returns

ResourceClient

OrderByLastUpdatedDescending()

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

public ResourceClient OrderByLastUpdatedDescending()

Returns

ResourceClient

OrderByName()

Sort response items by the Name attribute.

public ResourceClient OrderByName()

Returns

ResourceClient

OrderByNameDescending()

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

public ResourceClient OrderByNameDescending()

Returns

ResourceClient

PerPage(int)

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

public PaginatedResourceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedResourceClient

The current PaginatedResourceClient instance.

WithId(string)

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

public ResourceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ResourceClient

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