Class AttendeeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Attendee resource.

public class AttendeeClient : SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>

Inheritance

object

ResourceClient<Attendee>

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>

AttendeeClient

Inherited Members

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>.PatchAsync(Attendee, CancellationToken)

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>.PatchAsync(JsonApiDocument<AttendeeResource>, CancellationToken)

SingletonResourceClient<Attendee, AttendeeResource, AttendeeResponse>.DeleteAsync(CancellationToken)

ResourceClient<Attendee>.AddQueryParameter(string, string)

ResourceClient<Attendee>.ReplaceQueryParameter(string, string)

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

AttendeeClient(HttpClient, Uri)

Client for interacting with the Attendee resource.

public AttendeeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

EmergencyContact

Associated EmergencyContact.

public EmergencyContactClient EmergencyContact { get; }

Property Value

EmergencyContactClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Registration

Associated Registration.

public RegistrationClient Registration { get; }

Property Value

RegistrationClient

SelectionType

Associated SelectionType.

public SelectionTypeClient SelectionType { get; }

Property Value

SelectionTypeClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttendeeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttendeeClient

The current AttendeeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttendeeClient ClearParameters()

Returns

AttendeeClient

The current AttendeeClient instance.

GetAsync(CancellationToken)

Fetches the Attendee resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendeeResponse>

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

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