Class SelectionTypeClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SelectionType resource.

public class SelectionTypeClient : SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>

Inheritance

object

ResourceClient<SelectionType>

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>

SelectionTypeClient

Inherited Members

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>.PatchAsync(SelectionType, CancellationToken)

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>.PatchAsync(JsonApiDocument<SelectionTypeResource>, CancellationToken)

SingletonResourceClient<SelectionType, SelectionTypeResource, SelectionTypeResponse>.DeleteAsync(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

SelectionTypeClient(HttpClient, Uri)

Client for interacting with the SelectionType resource.

public SelectionTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SelectionTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SelectionTypeClient

The current SelectionTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SelectionTypeClient ClearParameters()

Returns

SelectionTypeClient

The current SelectionTypeClient instance.

GetAsync(CancellationToken)

Fetches the SelectionType resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SelectionTypeResponse>

A task representing the asynchronous operation, containing the SelectionType resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.