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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedRosterListPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedRosterListPersonClient

The current PaginatedRosterListPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedRosterListPersonClient ClearParameters()

Returns

PaginatedRosterListPersonClient

The current PaginatedRosterListPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedRosterListPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedRosterListPersonClient

The current PaginatedRosterListPersonClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedRosterListPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedRosterListPersonClient

The current PaginatedRosterListPersonClient instance.

PerPage(int)

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

public PaginatedRosterListPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedRosterListPersonClient

The current PaginatedRosterListPersonClient instance.

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.