Class PaginatedAttendanceTypeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AttendanceType collection resources.

public class PaginatedAttendanceTypeClient : PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>

Inheritance

object

ResourceClient<AttendanceType>

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>

PaginatedAttendanceTypeClient

Inherited Members

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.PerPage(int)

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.Offset(int)

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.Filter(string)

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.PostAsync(AttendanceType, CancellationToken)

PaginatedResourceClient<AttendanceType, AttendanceTypeResource, AttendanceTypeCollectionResponse, AttendanceTypeResponse>.PostAsync(JsonApiDocument<AttendanceTypeResource>, CancellationToken)

ResourceClient<AttendanceType>.AddQueryParameter(string, string)

ResourceClient<AttendanceType>.ReplaceQueryParameter(string, string)

ResourceClient<AttendanceType>.AddCustomParameter(string, string)

ResourceClient<AttendanceType>.ClearParameters()

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

PaginatedAttendanceTypeClient(HttpClient, Uri)

Client for interacting with AttendanceType collection resources.

public PaginatedAttendanceTypeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of AttendanceType resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AttendanceTypeCollectionResponse>

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

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

WhereId(string)

Query response items by the Id attribute.

public AttendanceTypeClient WhereId(string value)

Parameters

value string

Returns

AttendanceTypeClient

WhereName(string)

Query response items by the Name attribute.

public AttendanceTypeClient WhereName(string value)

Parameters

value string

Returns

AttendanceTypeClient

WithId(string)

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

public AttendanceTypeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

AttendanceTypeClient

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