Class PaginatedOauthApplicationClient

Namespace

Crews.PlanningCenter.Api.Api.V2025_09_30

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with OauthApplication collection resources.

public class PaginatedOauthApplicationClient : PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>

Inheritance

object

ResourceClient<OauthApplication>

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>

PaginatedOauthApplicationClient

Inherited Members

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.PerPage(int)

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.Offset(int)

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.Filter(string)

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.PostAsync(OauthApplication, CancellationToken)

PaginatedResourceClient<OauthApplication, OauthApplicationResource, OauthApplicationCollectionResponse, OauthApplicationResponse>.PostAsync(JsonApiDocument<OauthApplicationResource>, CancellationToken)

ResourceClient<OauthApplication>.AddQueryParameter(string, string)

ResourceClient<OauthApplication>.ReplaceQueryParameter(string, string)

ResourceClient<OauthApplication>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<OauthApplication>.Uri

ResourceClient<OauthApplication>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOauthApplicationClient(HttpClient, Uri)

Client for interacting with OauthApplication collection resources.

public PaginatedOauthApplicationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedOauthApplicationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedOauthApplicationClient

The current PaginatedOauthApplicationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedOauthApplicationClient ClearParameters()

Returns

PaginatedOauthApplicationClient

The current PaginatedOauthApplicationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedOauthApplicationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedOauthApplicationClient

The current PaginatedOauthApplicationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of OauthApplication resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OauthApplicationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedOauthApplicationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedOauthApplicationClient

The current PaginatedOauthApplicationClient instance.

PerPage(int)

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

public PaginatedOauthApplicationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedOauthApplicationClient

The current PaginatedOauthApplicationClient instance.

WithId(string)

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

public OauthApplicationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

OauthApplicationClient

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