Class PaginatedListResultClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_02

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

ResourceClient<ListResult>.ClearParameters()

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

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.

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

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.