Class PaginatedAppClient

Namespace

Crews.PlanningCenter.Api.People.V2019_10_10

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>.AddCustomParameter(string, string)

ResourceClient<App>.ClearParameters()

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

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.

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

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.