Class SchedulingPreferenceClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SchedulingPreference resource.

public class SchedulingPreferenceClient : SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>

Inheritance

object

ResourceClient<SchedulingPreference>

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>

SchedulingPreferenceClient

Inherited Members

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>.PatchAsync(SchedulingPreference, CancellationToken)

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>.PatchAsync(JsonApiDocument<SchedulingPreferenceResource>, CancellationToken)

SingletonResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceResponse>.DeleteAsync(CancellationToken)

ResourceClient<SchedulingPreference>.AddQueryParameter(string, string)

ResourceClient<SchedulingPreference>.ReplaceQueryParameter(string, string)

ResourceClient<SchedulingPreference>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SchedulingPreference>.Uri

ResourceClient<SchedulingPreference>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SchedulingPreferenceClient(HttpClient, Uri)

Client for interacting with the SchedulingPreference resource.

public SchedulingPreferenceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SchedulingPreferenceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SchedulingPreferenceClient

The current SchedulingPreferenceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SchedulingPreferenceClient ClearParameters()

Returns

SchedulingPreferenceClient

The current SchedulingPreferenceClient instance.

GetAsync(CancellationToken)

Fetches the SchedulingPreference resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SchedulingPreferenceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.