Class OptionClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Option resource.

public class OptionClient : SingletonResourceClient<Option, OptionResource, OptionResponse>

Inheritance

object

ResourceClient<Option>

SingletonResourceClient<Option, OptionResource, OptionResponse>

OptionClient

Inherited Members

SingletonResourceClient<Option, OptionResource, OptionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Option, OptionResource, OptionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Option, OptionResource, OptionResponse>.PatchAsync(Option, CancellationToken)

SingletonResourceClient<Option, OptionResource, OptionResponse>.PatchAsync(JsonApiDocument<OptionResource>, CancellationToken)

SingletonResourceClient<Option, OptionResource, OptionResponse>.DeleteAsync(CancellationToken)

ResourceClient<Option>.AddQueryParameter(string, string)

ResourceClient<Option>.ReplaceQueryParameter(string, string)

ResourceClient<Option>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Option>.Uri

ResourceClient<Option>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OptionClient(HttpClient, Uri)

Client for interacting with the Option resource.

public OptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

Label

Associated Label.

public LabelClient Label { get; }

Property Value

LabelClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public OptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

OptionClient

The current OptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public OptionClient ClearParameters()

Returns

OptionClient

The current OptionClient instance.

GetAsync(CancellationToken)

Fetches the Option resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLabel()

Include related Label resources in the response.

public OptionClient IncludeLabel()

Returns

OptionClient