Class PaginatedSignupLocationClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SignupLocation collection resources.

public class PaginatedSignupLocationClient : PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>

Inheritance

object

ResourceClient<SignupLocation>

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>

PaginatedSignupLocationClient

Inherited Members

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.PerPage(int)

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.Offset(int)

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.Filter(string)

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.PostAsync(SignupLocation, CancellationToken)

PaginatedResourceClient<SignupLocation, SignupLocationResource, SignupLocationCollectionResponse, SignupLocationResponse>.PostAsync(JsonApiDocument<SignupLocationResource>, 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

PaginatedSignupLocationClient(HttpClient, Uri)

Client for interacting with SignupLocation collection resources.

public PaginatedSignupLocationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSignupLocationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSignupLocationClient

The current PaginatedSignupLocationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSignupLocationClient ClearParameters()

Returns

PaginatedSignupLocationClient

The current PaginatedSignupLocationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSignupLocationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSignupLocationClient

The current PaginatedSignupLocationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SignupLocation resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SignupLocationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSignupLocationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSignupLocationClient

The current PaginatedSignupLocationClient instance.

PerPage(int)

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

public PaginatedSignupLocationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSignupLocationClient

The current PaginatedSignupLocationClient instance.

WithId(string)

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

public SignupLocationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SignupLocationClient

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