Class PaginatedEnrollmentClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Enrollment collection resources.

public class PaginatedEnrollmentClient : PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>

Inheritance

object

ResourceClient<Enrollment>

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>

PaginatedEnrollmentClient

Inherited Members

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.PerPage(int)

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.Offset(int)

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.Filter(string)

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.PostAsync(Enrollment, CancellationToken)

PaginatedResourceClient<Enrollment, EnrollmentResource, EnrollmentCollectionResponse, EnrollmentResponse>.PostAsync(JsonApiDocument<EnrollmentResource>, CancellationToken)

ResourceClient<Enrollment>.AddQueryParameter(string, string)

ResourceClient<Enrollment>.ReplaceQueryParameter(string, string)

ResourceClient<Enrollment>.AddCustomParameter(string, string)

ResourceClient<Enrollment>.ClearParameters()

ResourceClient<Enrollment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Enrollment>.Uri

ResourceClient<Enrollment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEnrollmentClient(HttpClient, Uri)

Client for interacting with Enrollment collection resources.

public PaginatedEnrollmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Enrollment resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EnrollmentCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public EnrollmentClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EnrollmentClient

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