Class PreCheckClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PreCheck resource.

public class PreCheckClient : SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>

Inheritance

object

ResourceClient<PreCheck>

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>

PreCheckClient

Inherited Members

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>.PatchAsync(PreCheck, CancellationToken)

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>.PatchAsync(JsonApiDocument<PreCheckResource>, CancellationToken)

SingletonResourceClient<PreCheck, PreCheckResource, PreCheckResponse>.DeleteAsync(CancellationToken)

ResourceClient<PreCheck>.AddQueryParameter(string, string)

ResourceClient<PreCheck>.ReplaceQueryParameter(string, string)

ResourceClient<PreCheck>.AddCustomParameter(string, string)

ResourceClient<PreCheck>.ClearParameters()

ResourceClient<PreCheck>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PreCheck>.Uri

ResourceClient<PreCheck>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PreCheckClient(HttpClient, Uri)

Client for interacting with the PreCheck resource.

public PreCheckClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the PreCheck resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PreCheckResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.