Class CheckInTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the CheckInTime resource.

public class CheckInTimeClient : SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>

Inheritance

object

ResourceClient<CheckInTime>

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>

CheckInTimeClient

Inherited Members

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>.PatchAsync(CheckInTime, CancellationToken)

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>.PatchAsync(JsonApiDocument<CheckInTimeResource>, CancellationToken)

SingletonResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<CheckInTime>.AddQueryParameter(string, string)

ResourceClient<CheckInTime>.ReplaceQueryParameter(string, string)

ResourceClient<CheckInTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckInTime>.Uri

ResourceClient<CheckInTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CheckInTimeClient(HttpClient, Uri)

Client for interacting with the CheckInTime resource.

public CheckInTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public CheckInTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

CheckInTimeClient

The current CheckInTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public CheckInTimeClient ClearParameters()

Returns

CheckInTimeClient

The current CheckInTimeClient instance.

GetAsync(CancellationToken)

Fetches the CheckInTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.