Class PaginatedAttendeeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Attendee collection resources.

public class PaginatedAttendeeClient : PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>

Inheritance

object

ResourceClient<Attendee>

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>

PaginatedAttendeeClient

Inherited Members

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.PerPage(int)

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.Offset(int)

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.Filter(string)

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.PostAsync(Attendee, CancellationToken)

PaginatedResourceClient<Attendee, AttendeeResource, AttendeeCollectionResponse, AttendeeResponse>.PostAsync(JsonApiDocument<AttendeeResource>, CancellationToken)

ResourceClient<Attendee>.AddQueryParameter(string, string)

ResourceClient<Attendee>.ReplaceQueryParameter(string, string)

ResourceClient<Attendee>.AddCustomParameter(string, string)

ResourceClient<Attendee>.ClearParameters()

ResourceClient<Attendee>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Attendee>.Uri

ResourceClient<Attendee>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAttendeeClient(HttpClient, Uri)

Client for interacting with Attendee collection resources.

public PaginatedAttendeeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Attendee resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendeeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEmergencyContact()

Include related EmergencyContact resources in the response.

public AttendeeClient IncludeEmergencyContact()

Returns

AttendeeClient

IncludePerson()

Include related Person resources in the response.

public AttendeeClient IncludePerson()

Returns

AttendeeClient

IncludeRegistration()

Include related Registration resources in the response.

public AttendeeClient IncludeRegistration()

Returns

AttendeeClient

IncludeSelectionType()

Include related SelectionType resources in the response.

public AttendeeClient IncludeSelectionType()

Returns

AttendeeClient

WithId(string)

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

public AttendeeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttendeeClient

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