Class AttendanceClient

Namespace

Crews.PlanningCenter.Api.Groups.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Attendance resource.

public class AttendanceClient : SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>

Inheritance

object

ResourceClient<Attendance>

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>

AttendanceClient

Inherited Members

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>.PatchAsync(Attendance, CancellationToken)

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>.PatchAsync(JsonApiDocument<AttendanceResource>, CancellationToken)

SingletonResourceClient<Attendance, AttendanceResource, AttendanceResponse>.DeleteAsync(CancellationToken)

ResourceClient<Attendance>.AddQueryParameter(string, string)

ResourceClient<Attendance>.ReplaceQueryParameter(string, string)

ResourceClient<Attendance>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Attendance>.Uri

ResourceClient<Attendance>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AttendanceClient(HttpClient, Uri)

Client for interacting with the Attendance resource.

public AttendanceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public AttendanceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

AttendanceClient

The current AttendanceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public AttendanceClient ClearParameters()

Returns

AttendanceClient

The current AttendanceClient instance.

GetAsync(CancellationToken)

Fetches the Attendance resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendanceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public AttendanceClient IncludePerson()

Returns

AttendanceClient