Class SignupLocationClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SignupLocation resource.

public class SignupLocationClient : SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>

Inheritance

object

ResourceClient<SignupLocation>

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>

SignupLocationClient

Inherited Members

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>.PatchAsync(SignupLocation, CancellationToken)

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>.PatchAsync(JsonApiDocument<SignupLocationResource>, CancellationToken)

SingletonResourceClient<SignupLocation, SignupLocationResource, SignupLocationResponse>.DeleteAsync(CancellationToken)

ResourceClient<SignupLocation>.AddQueryParameter(string, string)

ResourceClient<SignupLocation>.ReplaceQueryParameter(string, string)

ResourceClient<SignupLocation>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SignupLocation>.Uri

ResourceClient<SignupLocation>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SignupLocationClient(HttpClient, Uri)

Client for interacting with the SignupLocation resource.

public SignupLocationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SignupLocationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SignupLocationClient

The current SignupLocationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SignupLocationClient ClearParameters()

Returns

SignupLocationClient

The current SignupLocationClient instance.

GetAsync(CancellationToken)

Fetches the SignupLocation resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupLocationResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.