Class SignupTimeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SignupTime resource.

public class SignupTimeClient : SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>

Inheritance

object

ResourceClient<SignupTime>

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>

SignupTimeClient

Inherited Members

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>.PatchAsync(SignupTime, CancellationToken)

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>.PatchAsync(JsonApiDocument<SignupTimeResource>, CancellationToken)

SingletonResourceClient<SignupTime, SignupTimeResource, SignupTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<SignupTime>.AddQueryParameter(string, string)

ResourceClient<SignupTime>.ReplaceQueryParameter(string, string)

ResourceClient<SignupTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SignupTime>.Uri

ResourceClient<SignupTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SignupTimeClient(HttpClient, Uri)

Client for interacting with the SignupTime resource.

public SignupTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SignupTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SignupTimeClient

The current SignupTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SignupTimeClient ClearParameters()

Returns

SignupTimeClient

The current SignupTimeClient instance.

GetAsync(CancellationToken)

Fetches the SignupTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.