Class SignupClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Signup resource.

public class SignupClient : SingletonResourceClient<Signup, SignupResource, SignupResponse>

Inheritance

object

ResourceClient<Signup>

SingletonResourceClient<Signup, SignupResource, SignupResponse>

SignupClient

Inherited Members

SingletonResourceClient<Signup, SignupResource, SignupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Signup, SignupResource, SignupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Signup, SignupResource, SignupResponse>.PatchAsync(Signup, CancellationToken)

SingletonResourceClient<Signup, SignupResource, SignupResponse>.PatchAsync(JsonApiDocument<SignupResource>, CancellationToken)

SingletonResourceClient<Signup, SignupResource, SignupResponse>.DeleteAsync(CancellationToken)

ResourceClient<Signup>.AddQueryParameter(string, string)

ResourceClient<Signup>.ReplaceQueryParameter(string, string)

ResourceClient<Signup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Signup>.Uri

ResourceClient<Signup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SignupClient(HttpClient, Uri)

Client for interacting with the Signup resource.

public SignupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Attendees

Associated Attendees.

public PaginatedAttendeeClient Attendees { get; }

Property Value

PaginatedAttendeeClient

Campuses

Associated Campuses.

public PaginatedCampusClient Campuses { get; }

Property Value

PaginatedCampusClient

Categories

Associated Categories.

public PaginatedCategoryClient Categories { get; }

Property Value

PaginatedCategoryClient

NextSignupTime

Associated NextSignupTime.

public SignupTimeClient NextSignupTime { get; }

Property Value

SignupTimeClient

Registrations

Associated Registrations.

public PaginatedRegistrationClient Registrations { get; }

Property Value

PaginatedRegistrationClient

SelectionTypes

Associated SelectionTypes.

public PaginatedSelectionTypeClient SelectionTypes { get; }

Property Value

PaginatedSelectionTypeClient

SignupLocation

Associated SignupLocation.

public SignupLocationClient SignupLocation { get; }

Property Value

SignupLocationClient

SignupTimes

Associated SignupTimes.

public PaginatedSignupTimeClient SignupTimes { get; }

Property Value

PaginatedSignupTimeClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SignupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SignupClient

The current SignupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SignupClient ClearParameters()

Returns

SignupClient

The current SignupClient instance.

GetAsync(CancellationToken)

Fetches the Signup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampuses()

Include related Campuses resources in the response.

public SignupClient IncludeCampuses()

Returns

SignupClient

IncludeCategories()

Include related Categories resources in the response.

public SignupClient IncludeCategories()

Returns

SignupClient

IncludeNextSignupTime()

Include related NextSignupTime resources in the response.

public SignupClient IncludeNextSignupTime()

Returns

SignupClient

IncludeSignupLocation()

Include related SignupLocation resources in the response.

public SignupClient IncludeSignupLocation()

Returns

SignupClient

IncludeSignupTimes()

Include related SignupTimes resources in the response.

public SignupClient IncludeSignupTimes()

Returns

SignupClient