Class PreCheckClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2019_07_17

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PreCheckClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PreCheckClient

The current PreCheckClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PreCheckClient ClearParameters()

Returns

PreCheckClient

The current PreCheckClient instance.

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.