Class PaginatedScheduledPersonClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ScheduledPerson collection resources.

public class PaginatedScheduledPersonClient : PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>

Inheritance

object

ResourceClient<ScheduledPerson>

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>

PaginatedScheduledPersonClient

Inherited Members

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.PerPage(int)

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.Offset(int)

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.Filter(string)

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.PostAsync(ScheduledPerson, CancellationToken)

PaginatedResourceClient<ScheduledPerson, ScheduledPersonResource, ScheduledPersonCollectionResponse, ScheduledPersonResponse>.PostAsync(JsonApiDocument<ScheduledPersonResource>, CancellationToken)

ResourceClient<ScheduledPerson>.AddQueryParameter(string, string)

ResourceClient<ScheduledPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ScheduledPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ScheduledPerson>.Uri

ResourceClient<ScheduledPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedScheduledPersonClient(HttpClient, Uri)

Client for interacting with ScheduledPerson collection resources.

public PaginatedScheduledPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedScheduledPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedScheduledPersonClient

The current PaginatedScheduledPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedScheduledPersonClient ClearParameters()

Returns

PaginatedScheduledPersonClient

The current PaginatedScheduledPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedScheduledPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedScheduledPersonClient

The current PaginatedScheduledPersonClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ScheduledPerson resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ScheduledPersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedScheduledPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedScheduledPersonClient

The current PaginatedScheduledPersonClient instance.

PerPage(int)

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

public PaginatedScheduledPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedScheduledPersonClient

The current PaginatedScheduledPersonClient instance.

WithId(string)

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

public ScheduledPersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ScheduledPersonClient

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