Class PaginatedAttendanceClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Attendance collection resources.

public class PaginatedAttendanceClient : PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>

Inheritance

object

ResourceClient<Attendance>

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>

PaginatedAttendanceClient

Inherited Members

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.PerPage(int)

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.Offset(int)

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.Filter(string)

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.PostAsync(Attendance, CancellationToken)

PaginatedResourceClient<Attendance, AttendanceResource, AttendanceCollectionResponse, AttendanceResponse>.PostAsync(JsonApiDocument<AttendanceResource>, CancellationToken)

ResourceClient<Attendance>.AddQueryParameter(string, string)

ResourceClient<Attendance>.ReplaceQueryParameter(string, string)

ResourceClient<Attendance>.AddCustomParameter(string, string)

ResourceClient<Attendance>.ClearParameters()

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

PaginatedAttendanceClient(HttpClient, Uri)

Client for interacting with Attendance collection resources.

public PaginatedAttendanceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Attendance resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendanceCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of Attendance resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a Attendance client for a specific resource ID.

public AttendanceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttendanceClient

A new instance of the resource client for the specified resource ID.