Class AttendanceTypeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2019_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the AttendanceType resource.

public class AttendanceTypeClient : SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>

Inheritance

object

ResourceClient<AttendanceType>

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>

AttendanceTypeClient

Inherited Members

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>.PatchAsync(AttendanceType, CancellationToken)

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>.PatchAsync(JsonApiDocument<AttendanceTypeResource>, CancellationToken)

SingletonResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeResponse>.DeleteAsync(CancellationToken)

ResourceClient<AttendanceType>.AddQueryParameter(string, string)

ResourceClient<AttendanceType>.ReplaceQueryParameter(string, string)

ResourceClient<AttendanceType>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AttendanceType>.Uri

ResourceClient<AttendanceType>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AttendanceTypeClient(HttpClient, Uri)

Client for interacting with the AttendanceType resource.

public AttendanceTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

Headcounts

Associated Headcounts.

public PaginatedHeadcountClient Headcounts { get; }

Property Value

PaginatedHeadcountClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttendanceTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttendanceTypeClient

The current AttendanceTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttendanceTypeClient ClearParameters()

Returns

AttendanceTypeClient

The current AttendanceTypeClient instance.

GetAsync(CancellationToken)

Fetches the AttendanceType resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendanceTypeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public AttendanceTypeClient IncludeEvent()

Returns

AttendanceTypeClient