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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttendanceTypeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttendanceTypeClient

The current PaginatedAttendanceTypeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttendanceTypeClient ClearParameters()

Returns

PaginatedAttendanceTypeClient

The current PaginatedAttendanceTypeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttendanceTypeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttendanceTypeClient

The current PaginatedAttendanceTypeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttendanceTypeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttendanceTypeClient

The current PaginatedAttendanceTypeClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedAttendanceTypeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttendanceTypeClient

The current PaginatedAttendanceTypeClient instance.

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.