Class PaginatedCampusClient

Namespace

Crews.PlanningCenter.Api.Giving.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Campus collection resources.

public class PaginatedCampusClient : PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>

Inheritance

object

ResourceClient<Campus>

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>

PaginatedCampusClient

Inherited Members

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.PerPage(int)

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.Offset(int)

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.Filter(string)

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.PostAsync(Campus, CancellationToken)

PaginatedResourceClient<Campus, CampusResource, CampusCollectionResponse, CampusResponse>.PostAsync(JsonApiDocument<CampusResource>, CancellationToken)

ResourceClient<Campus>.AddQueryParameter(string, string)

ResourceClient<Campus>.ReplaceQueryParameter(string, string)

ResourceClient<Campus>.AddCustomParameter(string, string)

ResourceClient<Campus>.ClearParameters()

ResourceClient<Campus>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Campus>.Uri

ResourceClient<Campus>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCampusClient(HttpClient, Uri)

Client for interacting with Campus collection resources.

public PaginatedCampusClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Campus resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CampusCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public CampusClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CampusClient

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