Class PaginatedConnectedPersonClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ConnectedPerson collection resources.

public class PaginatedConnectedPersonClient : PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>

Inheritance

object

ResourceClient<ConnectedPerson>

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>

PaginatedConnectedPersonClient

Inherited Members

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.PerPage(int)

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.Offset(int)

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.Filter(string)

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.PostAsync(ConnectedPerson, CancellationToken)

PaginatedResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonCollectionResponse, ConnectedPersonResponse>.PostAsync(JsonApiDocument<ConnectedPersonResource>, CancellationToken)

ResourceClient<ConnectedPerson>.AddQueryParameter(string, string)

ResourceClient<ConnectedPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedPerson>.AddCustomParameter(string, string)

ResourceClient<ConnectedPerson>.ClearParameters()

ResourceClient<ConnectedPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedPerson>.Uri

ResourceClient<ConnectedPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedConnectedPersonClient(HttpClient, Uri)

Client for interacting with ConnectedPerson collection resources.

public PaginatedConnectedPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ConnectedPerson resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedPersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ConnectedPersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ConnectedPersonClient

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