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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSignupTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSignupTimeClient

The current PaginatedSignupTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSignupTimeClient ClearParameters()

Returns

PaginatedSignupTimeClient

The current PaginatedSignupTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSignupTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSignupTimeClient

The current PaginatedSignupTimeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSignupTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSignupTimeClient

The current PaginatedSignupTimeClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedSignupTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSignupTimeClient

The current PaginatedSignupTimeClient instance.

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.