Class PaginatedSelectionTypeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SelectionType collection resources.

public class PaginatedSelectionTypeClient : PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>

Inheritance

object

ResourceClient<SelectionType>

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>

PaginatedSelectionTypeClient

Inherited Members

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.PerPage(int)

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.Offset(int)

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.Filter(string)

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.PostAsync(SelectionType, CancellationToken)

PaginatedResourceClient<SelectionType, SelectionTypeResource, SelectionTypeCollectionResponse, SelectionTypeResponse>.PostAsync(JsonApiDocument<SelectionTypeResource>, CancellationToken)

ResourceClient<SelectionType>.AddQueryParameter(string, string)

ResourceClient<SelectionType>.ReplaceQueryParameter(string, string)

ResourceClient<SelectionType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SelectionType>.Uri

ResourceClient<SelectionType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSelectionTypeClient(HttpClient, Uri)

Client for interacting with SelectionType collection resources.

public PaginatedSelectionTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSelectionTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSelectionTypeClient

The current PaginatedSelectionTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSelectionTypeClient ClearParameters()

Returns

PaginatedSelectionTypeClient

The current PaginatedSelectionTypeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSelectionTypeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSelectionTypeClient

The current PaginatedSelectionTypeClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SelectionType resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SelectionTypeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSelectionTypeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSelectionTypeClient

The current PaginatedSelectionTypeClient instance.

PerPage(int)

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

public PaginatedSelectionTypeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSelectionTypeClient

The current PaginatedSelectionTypeClient instance.

WithId(string)

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

public SelectionTypeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SelectionTypeClient

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