Class EnrollmentClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Enrollment resource.

public class EnrollmentClient : SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>

Inheritance

object

ResourceClient<Enrollment>

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>

EnrollmentClient

Inherited Members

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PatchAsync(Enrollment, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PatchAsync(JsonApiDocument<EnrollmentResource>, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.DeleteAsync(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

EnrollmentClient(HttpClient, Uri)

Client for interacting with the Enrollment resource.

public EnrollmentClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the Enrollment resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EnrollmentResponse>

A task representing the asynchronous operation, containing the Enrollment resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.