Class PaginatedConnectedPersonClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedConnectedPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedConnectedPersonClient

The current PaginatedConnectedPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedConnectedPersonClient ClearParameters()

Returns

PaginatedConnectedPersonClient

The current PaginatedConnectedPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedConnectedPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedConnectedPersonClient

The current PaginatedConnectedPersonClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedConnectedPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedConnectedPersonClient

The current PaginatedConnectedPersonClient instance.

PerPage(int)

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

public PaginatedConnectedPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedConnectedPersonClient

The current PaginatedConnectedPersonClient instance.

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.