Class PaginatedConnectedApplicationPersonClient

Namespace

Crews.PlanningCenter.Api.Api.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ConnectedApplicationPerson collection resources.

public class PaginatedConnectedApplicationPersonClient : PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>

Inheritance

object

ResourceClient<ConnectedApplicationPerson>

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>

PaginatedConnectedApplicationPersonClient

Inherited Members

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.PerPage(int)

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.Offset(int)

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.Filter(string)

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.PostAsync(ConnectedApplicationPerson, CancellationToken)

PaginatedResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonCollectionResponse, ConnectedApplicationPersonResponse>.PostAsync(JsonApiDocument<ConnectedApplicationPersonResource>, CancellationToken)

ResourceClient<ConnectedApplicationPerson>.AddQueryParameter(string, string)

ResourceClient<ConnectedApplicationPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedApplicationPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedApplicationPerson>.Uri

ResourceClient<ConnectedApplicationPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedConnectedApplicationPersonClient(HttpClient, Uri)

Client for interacting with ConnectedApplicationPerson collection resources.

public PaginatedConnectedApplicationPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedConnectedApplicationPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedConnectedApplicationPersonClient

The current PaginatedConnectedApplicationPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedConnectedApplicationPersonClient ClearParameters()

Returns

PaginatedConnectedApplicationPersonClient

The current PaginatedConnectedApplicationPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedConnectedApplicationPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedConnectedApplicationPersonClient

The current PaginatedConnectedApplicationPersonClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ConnectedApplicationPerson resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedApplicationPersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedConnectedApplicationPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedConnectedApplicationPersonClient

The current PaginatedConnectedApplicationPersonClient instance.

PerPage(int)

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

public PaginatedConnectedApplicationPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedConnectedApplicationPersonClient

The current PaginatedConnectedApplicationPersonClient instance.

WithId(string)

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

public ConnectedApplicationPersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ConnectedApplicationPersonClient

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