Class PaginatedAppClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with App collection resources.

public class PaginatedAppClient : PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>

Inheritance

object

ResourceClient<App>

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>

PaginatedAppClient

Inherited Members

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.PerPage(int)

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.Offset(int)

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.Filter(string)

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.PostAsync(App, CancellationToken)

PaginatedResourceClient<App, AppResource, AppCollectionResponse, AppResponse>.PostAsync(JsonApiDocument<AppResource>, CancellationToken)

ResourceClient<App>.AddQueryParameter(string, string)

ResourceClient<App>.ReplaceQueryParameter(string, string)

ResourceClient<App>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<App>.Uri

ResourceClient<App>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAppClient(HttpClient, Uri)

Client for interacting with App collection resources.

public PaginatedAppClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAppClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAppClient

The current PaginatedAppClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAppClient ClearParameters()

Returns

PaginatedAppClient

The current PaginatedAppClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAppClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAppClient

The current PaginatedAppClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of App resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AppCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAppClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAppClient

The current PaginatedAppClient instance.

OrderByName()

Sort response items by the Name attribute.

public AppClient OrderByName()

Returns

AppClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public AppClient OrderByNameDescending()

Returns

AppClient

OrderByUrl()

Sort response items by the Url attribute.

public AppClient OrderByUrl()

Returns

AppClient

OrderByUrlDescending()

Sort response items by the Url attribute. Use reverse order.

public AppClient OrderByUrlDescending()

Returns

AppClient

PerPage(int)

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

public PaginatedAppClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAppClient

The current PaginatedAppClient instance.

WhereName(string)

Query response items by the Name attribute.

public AppClient WhereName(string value)

Parameters

value string

Returns

AppClient

WhereUrl(string)

Query response items by the Url attribute.

public AppClient WhereUrl(string value)

Parameters

value string

Returns

AppClient

WithId(string)

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

public AppClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AppClient

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