Class CheckInGroupClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the CheckInGroup resource.

public class CheckInGroupClient : SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>

Inheritance

object

ResourceClient<CheckInGroup>

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>

CheckInGroupClient

Inherited Members

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>.GetAsync(CancellationToken)

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>.PatchAsync(CheckInGroup, CancellationToken)

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>.PatchAsync(JsonApiDocument<CheckInGroupResource>, CancellationToken)

SingletonResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupResponse>.DeleteAsync(CancellationToken)

ResourceClient<CheckInGroup>.AddQueryParameter(string, string)

ResourceClient<CheckInGroup>.ReplaceQueryParameter(string, string)

ResourceClient<CheckInGroup>.AddCustomParameter(string, string)

ResourceClient<CheckInGroup>.ClearParameters()

ResourceClient<CheckInGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckInGroup>.Uri

ResourceClient<CheckInGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CheckInGroupClient(HttpClient, Uri)

Client for interacting with the CheckInGroup resource.

public CheckInGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

EventPeriod

Associated EventPeriod.

public EventPeriodClient EventPeriod { get; }

Property Value

EventPeriodClient

PrintStation

Associated PrintStation.

public StationClient PrintStation { get; }

Property Value

StationClient

Methods

GetAsync(CancellationToken)

Fetches the CheckInGroup resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInGroupResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCheckIns()

Include related CheckIns resources in the response.

public CheckInGroupClient IncludeCheckIns()

Returns

CheckInGroupClient

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public CheckInGroupClient IncludeEventPeriod()

Returns

CheckInGroupClient

IncludePrintStation()

Include related PrintStation resources in the response.

public CheckInGroupClient IncludePrintStation()

Returns

CheckInGroupClient