Class PaginatedPersonAppClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PersonApp collection resources.

public class PaginatedPersonAppClient : PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>

Inheritance

object

ResourceClient<PersonApp>

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>

PaginatedPersonAppClient

Inherited Members

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.PerPage(int)

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.Offset(int)

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.Filter(string)

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.PostAsync(PersonApp, CancellationToken)

PaginatedResourceClient<PersonApp, PersonAppResource, PersonAppCollectionResponse, PersonAppResponse>.PostAsync(JsonApiDocument<PersonAppResource>, CancellationToken)

ResourceClient<PersonApp>.AddQueryParameter(string, string)

ResourceClient<PersonApp>.ReplaceQueryParameter(string, string)

ResourceClient<PersonApp>.AddCustomParameter(string, string)

ResourceClient<PersonApp>.ClearParameters()

ResourceClient<PersonApp>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonApp>.Uri

ResourceClient<PersonApp>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPersonAppClient(HttpClient, Uri)

Client for interacting with PersonApp collection resources.

public PaginatedPersonAppClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PersonApp resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonAppCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeApp()

Include related App resources in the response.

public PersonAppClient IncludeApp()

Returns

PersonAppClient

PostAsync(PersonApp, CancellationToken)

Creates a new PersonApp resource asynchronously.

public Task<PersonAppResponse> PostAsync(PersonApp resource, CancellationToken cancellationToken = default)

Parameters

resource PersonApp

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonAppResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<PersonAppResource>, CancellationToken)

Creates a new PersonApp resource asynchronously.

public Task<PersonAppResponse> PostAsync(JsonApiDocument<PersonAppResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PersonAppResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonAppResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public PersonAppClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonAppClient

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