Class PaginatedSignupClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Signup collection resources.

public class PaginatedSignupClient : PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>

Inheritance

object

ResourceClient<Signup>

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>

PaginatedSignupClient

Inherited Members

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.PerPage(int)

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.Offset(int)

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.Filter(string)

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.PostAsync(Signup, CancellationToken)

PaginatedResourceClient<Signup, SignupResource, SignupCollectionResponse, SignupResponse>.PostAsync(JsonApiDocument<SignupResource>, 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

PaginatedSignupClient(HttpClient, Uri)

Client for interacting with Signup collection resources.

public PaginatedSignupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSignupClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSignupClient

The current PaginatedSignupClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSignupClient ClearParameters()

Returns

PaginatedSignupClient

The current PaginatedSignupClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSignupClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSignupClient

The current PaginatedSignupClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Signup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupCollectionResponse>

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSignupClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSignupClient

The current PaginatedSignupClient instance.

PerPage(int)

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

public PaginatedSignupClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSignupClient

The current PaginatedSignupClient instance.

WhereId(string)

Query response items by the Id attribute.

public SignupClient WhereId(string value)

Parameters

value string

Returns

SignupClient

WithId(string)

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

public SignupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SignupClient

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