Class PaginatedPlanPersonClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PlanPerson collection resources.

public class PaginatedPlanPersonClient : PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>

Inheritance

object

ResourceClient<PlanPerson>

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>

PaginatedPlanPersonClient

Inherited Members

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.PerPage(int)

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.Offset(int)

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.Filter(string)

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.PostAsync(PlanPerson, CancellationToken)

PaginatedResourceClient<PlanPerson, PlanPersonResource, PlanPersonCollectionResponse, PlanPersonResponse>.PostAsync(JsonApiDocument<PlanPersonResource>, CancellationToken)

ResourceClient<PlanPerson>.AddQueryParameter(string, string)

ResourceClient<PlanPerson>.ReplaceQueryParameter(string, string)

ResourceClient<PlanPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanPerson>.Uri

ResourceClient<PlanPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPlanPersonClient(HttpClient, Uri)

Client for interacting with PlanPerson collection resources.

public PaginatedPlanPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPlanPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPlanPersonClient

The current PaginatedPlanPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPlanPersonClient ClearParameters()

Returns

PaginatedPlanPersonClient

The current PaginatedPlanPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPlanPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPlanPersonClient

The current PaginatedPlanPersonClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PlanPerson resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDeclinedPlanTimes()

Include related DeclinedPlanTimes resources in the response.

public PlanPersonClient IncludeDeclinedPlanTimes()

Returns

PlanPersonClient

IncludePerson()

Include related Person resources in the response.

public PlanPersonClient IncludePerson()

Returns

PlanPersonClient

IncludePlan()

Include related Plan resources in the response.

public PlanPersonClient IncludePlan()

Returns

PlanPersonClient

IncludeTeam()

Include related Team resources in the response.

public PlanPersonClient IncludeTeam()

Returns

PlanPersonClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPlanPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPlanPersonClient

The current PaginatedPlanPersonClient instance.

PerPage(int)

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

public PaginatedPlanPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPlanPersonClient

The current PaginatedPlanPersonClient instance.

PostAsync(PlanPerson, CancellationToken)

Creates a new PlanPerson resource asynchronously.

public Task<PlanPersonResponse> PostAsync(PlanPerson resource, CancellationToken cancellationToken = default)

Parameters

resource PlanPerson

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonResponse>

A task representing the asynchronous operation, containing the created PlanPerson resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PlanPersonResource>, CancellationToken)

Creates a new PlanPerson resource asynchronously.

public Task<PlanPersonResponse> PostAsync(JsonApiDocument<PlanPersonResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PlanPersonResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanPersonResponse>

A task representing the asynchronous operation, containing the created PlanPerson resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereTeamId(int)

Query response items by the TeamId attribute.

public PlanPersonClient WhereTeamId(int value)

Parameters

value int

Returns

PlanPersonClient

WithId(string)

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

public PlanPersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PlanPersonClient

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