Class PaginatedRegistrationClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Registration collection resources.

public class PaginatedRegistrationClient : PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>

Inheritance

object

ResourceClient<Registration>

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>

PaginatedRegistrationClient

Inherited Members

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.PerPage(int)

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.Offset(int)

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.Filter(string)

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.PostAsync(Registration, CancellationToken)

PaginatedResourceClient<Registration, RegistrationResource, RegistrationCollectionResponse, RegistrationResponse>.PostAsync(JsonApiDocument<RegistrationResource>, CancellationToken)

ResourceClient<Registration>.AddQueryParameter(string, string)

ResourceClient<Registration>.ReplaceQueryParameter(string, string)

ResourceClient<Registration>.AddCustomParameter(string, string)

ResourceClient<Registration>.ClearParameters()

ResourceClient<Registration>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Registration>.Uri

ResourceClient<Registration>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedRegistrationClient(HttpClient, Uri)

Client for interacting with Registration collection resources.

public PaginatedRegistrationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Registration resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<RegistrationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public RegistrationClient IncludeCreatedBy()

Returns

RegistrationClient

IncludeRegistrantContact()

Include related RegistrantContact resources in the response.

public RegistrationClient IncludeRegistrantContact()

Returns

RegistrationClient

WithId(string)

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

public RegistrationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

RegistrationClient

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