Class PaginatedRosterListPersonClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with RosterListPerson collection resources.

public class PaginatedRosterListPersonClient : PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>

Inheritance

object

ResourceClient<RosterListPerson>

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>

PaginatedRosterListPersonClient

Inherited Members

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.PerPage(int)

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.Offset(int)

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.Filter(string)

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.PostAsync(RosterListPerson, CancellationToken)

PaginatedResourceClient<RosterListPerson, RosterListPersonResource, RosterListPersonCollectionResponse, RosterListPersonResponse>.PostAsync(JsonApiDocument<RosterListPersonResource>, CancellationToken)

ResourceClient<RosterListPerson>.AddQueryParameter(string, string)

ResourceClient<RosterListPerson>.ReplaceQueryParameter(string, string)

ResourceClient<RosterListPerson>.AddCustomParameter(string, string)

ResourceClient<RosterListPerson>.ClearParameters()

ResourceClient<RosterListPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<RosterListPerson>.Uri

ResourceClient<RosterListPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRosterListPersonClient(HttpClient, Uri)

Client for interacting with RosterListPerson collection resources.

public PaginatedRosterListPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of RosterListPerson resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RosterListPersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public RosterListPersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RosterListPersonClient

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