Class PaginatedConnectedApplicationClient

Namespace

Crews.PlanningCenter.Api.Api.V2025_09_30

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ConnectedApplication collection resources.

public class PaginatedConnectedApplicationClient : PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>

Inheritance

object

ResourceClient<ConnectedApplication>

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>

PaginatedConnectedApplicationClient

Inherited Members

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.PerPage(int)

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.Offset(int)

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.Filter(string)

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.PostAsync(ConnectedApplication, CancellationToken)

PaginatedResourceClient<ConnectedApplication, ConnectedApplicationResource, ConnectedApplicationCollectionResponse, ConnectedApplicationResponse>.PostAsync(JsonApiDocument<ConnectedApplicationResource>, CancellationToken)

ResourceClient<ConnectedApplication>.AddQueryParameter(string, string)

ResourceClient<ConnectedApplication>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedApplication>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedApplication>.Uri

ResourceClient<ConnectedApplication>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedConnectedApplicationClient(HttpClient, Uri)

Client for interacting with ConnectedApplication collection resources.

public PaginatedConnectedApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedConnectedApplicationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedConnectedApplicationClient

The current PaginatedConnectedApplicationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedConnectedApplicationClient ClearParameters()

Returns

PaginatedConnectedApplicationClient

The current PaginatedConnectedApplicationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedConnectedApplicationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedConnectedApplicationClient

The current PaginatedConnectedApplicationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of ConnectedApplication resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedApplicationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedConnectedApplicationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedConnectedApplicationClient

The current PaginatedConnectedApplicationClient instance.

PerPage(int)

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

public PaginatedConnectedApplicationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedConnectedApplicationClient

The current PaginatedConnectedApplicationClient instance.

WithId(string)

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

public ConnectedApplicationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ConnectedApplicationClient

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