Class TimePreferenceOptionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the TimePreferenceOption resource.

public class TimePreferenceOptionClient : SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>

Inheritance

object

ResourceClient<TimePreferenceOption>

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>

TimePreferenceOptionClient

Inherited Members

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>.PatchAsync(TimePreferenceOption, CancellationToken)

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>.PatchAsync(JsonApiDocument<TimePreferenceOptionResource>, CancellationToken)

SingletonResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionResponse>.DeleteAsync(CancellationToken)

ResourceClient<TimePreferenceOption>.AddQueryParameter(string, string)

ResourceClient<TimePreferenceOption>.ReplaceQueryParameter(string, string)

ResourceClient<TimePreferenceOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TimePreferenceOption>.Uri

ResourceClient<TimePreferenceOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TimePreferenceOptionClient(HttpClient, Uri)

Client for interacting with the TimePreferenceOption resource.

public TimePreferenceOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public TimePreferenceOptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

TimePreferenceOptionClient

The current TimePreferenceOptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public TimePreferenceOptionClient ClearParameters()

Returns

TimePreferenceOptionClient

The current TimePreferenceOptionClient instance.

GetAsync(CancellationToken)

Fetches the TimePreferenceOption resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TimePreferenceOptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.