Class PaginatedSignupTimeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SignupTime collection resources.

public class PaginatedSignupTimeClient : PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>

Inheritance

object

ResourceClient<SignupTime>

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>

PaginatedSignupTimeClient

Inherited Members

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.PerPage(int)

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.Offset(int)

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.Filter(string)

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.PostAsync(SignupTime, CancellationToken)

PaginatedResourceClient<SignupTime, SignupTimeResource, SignupTimeCollectionResponse, SignupTimeResponse>.PostAsync(JsonApiDocument<SignupTimeResource>, CancellationToken)

ResourceClient<SignupTime>.AddQueryParameter(string, string)

ResourceClient<SignupTime>.ReplaceQueryParameter(string, string)

ResourceClient<SignupTime>.AddCustomParameter(string, string)

ResourceClient<SignupTime>.ClearParameters()

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

PaginatedSignupTimeClient(HttpClient, Uri)

Client for interacting with SignupTime collection resources.

public PaginatedSignupTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of SignupTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public SignupTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SignupTimeClient

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