Class CheckInClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the CheckIn resource.

public class CheckInClient : SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>

Inheritance

object

ResourceClient<CheckIn>

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>

CheckInClient

Inherited Members

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>.GetAsync(CancellationToken)

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>.PatchAsync(CheckIn, CancellationToken)

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>.PatchAsync(JsonApiDocument<CheckInResource>, CancellationToken)

SingletonResourceClient<CheckIn, CheckInResource, CheckInResponse>.DeleteAsync(CancellationToken)

ResourceClient<CheckIn>.AddQueryParameter(string, string)

ResourceClient<CheckIn>.ReplaceQueryParameter(string, string)

ResourceClient<CheckIn>.AddCustomParameter(string, string)

ResourceClient<CheckIn>.ClearParameters()

ResourceClient<CheckIn>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckIn>.Uri

ResourceClient<CheckIn>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CheckInClient(HttpClient, Uri)

Client for interacting with the CheckIn resource.

public CheckInClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckInGroup

Associated CheckInGroup.

public CheckInGroupClient CheckInGroup { get; }

Property Value

CheckInGroupClient

CheckedInAt

Associated CheckedInAt.

public StationClient CheckedInAt { get; }

Property Value

StationClient

CheckedInBy

Associated CheckedInBy.

public PersonClient CheckedInBy { get; }

Property Value

PersonClient

CheckedOutBy

Associated CheckedOutBy.

public PersonClient CheckedOutBy { get; }

Property Value

PersonClient

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

EventPeriod

Associated EventPeriod.

public EventPeriodClient EventPeriod { get; }

Property Value

EventPeriodClient

EventTimes

Associated EventTimes.

public PaginatedEventTimeClient EventTimes { get; }

Property Value

PaginatedEventTimeClient

Location

Associated Location.

[Obsolete("This endpoint is deprecated and may be removed in a future release.")]
public LocationClient Location { get; }

Property Value

LocationClient

Options

Associated Options.

public PaginatedOptionClient Options { get; }

Property Value

PaginatedOptionClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

GetAsync(CancellationToken)

Fetches the CheckIn resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCheckedInAt()

Include related CheckedInAt resources in the response.

public CheckInClient IncludeCheckedInAt()

Returns

CheckInClient

IncludeCheckedInBy()

Include related CheckedInBy resources in the response.

public CheckInClient IncludeCheckedInBy()

Returns

CheckInClient

IncludeCheckedOutBy()

Include related CheckedOutBy resources in the response.

public CheckInClient IncludeCheckedOutBy()

Returns

CheckInClient

IncludeEvent()

Include related Event resources in the response.

public CheckInClient IncludeEvent()

Returns

CheckInClient

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public CheckInClient IncludeEventPeriod()

Returns

CheckInClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public CheckInClient IncludeEventTimes()

Returns

CheckInClient

IncludeLocation()

Include related Location resources in the response.

public CheckInClient IncludeLocation()

Returns

CheckInClient

IncludeOptions()

Include related Options resources in the response.

public CheckInClient IncludeOptions()

Returns

CheckInClient

IncludePerson()

Include related Person resources in the response.

public CheckInClient IncludePerson()

Returns

CheckInClient