Class PaginatedListResultClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ListResult collection resources.

public class PaginatedListResultClient : PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>

Inheritance

object

ResourceClient<ListResult>

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>

PaginatedListResultClient

Inherited Members

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.PerPage(int)

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.Offset(int)

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.Filter(string)

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.PostAsync(ListResult, CancellationToken)

PaginatedResourceClient<ListResult, ListResultResource, ListResultCollectionResponse, ListResultResponse>.PostAsync(JsonApiDocument<ListResultResource>, CancellationToken)

ResourceClient<ListResult>.AddQueryParameter(string, string)

ResourceClient<ListResult>.ReplaceQueryParameter(string, string)

ResourceClient<ListResult>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListResult>.Uri

ResourceClient<ListResult>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedListResultClient(HttpClient, Uri)

Client for interacting with ListResult collection resources.

public PaginatedListResultClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedListResultClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedListResultClient

The current PaginatedListResultClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedListResultClient ClearParameters()

Returns

PaginatedListResultClient

The current PaginatedListResultClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedListResultClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedListResultClient

The current PaginatedListResultClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ListResult resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListResultCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public ListResultClient IncludePerson()

Returns

ListResultClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedListResultClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedListResultClient

The current PaginatedListResultClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public ListResultClient OrderByCreatedAt()

Returns

ListResultClient

OrderByCreatedAtDescending()

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

public ListResultClient OrderByCreatedAtDescending()

Returns

ListResultClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public ListResultClient OrderByUpdatedAt()

Returns

ListResultClient

OrderByUpdatedAtDescending()

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

public ListResultClient OrderByUpdatedAtDescending()

Returns

ListResultClient

PerPage(int)

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

public PaginatedListResultClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedListResultClient

The current PaginatedListResultClient instance.

WherePersonId(int)

Query response items by the PersonId attribute.

public ListResultClient WherePersonId(int value)

Parameters

value int

Returns

ListResultClient

WithId(string)

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

public ListResultClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ListResultClient

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