Class PaginatedAttendanceClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAttendanceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAttendanceClient

The current PaginatedAttendanceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAttendanceClient ClearParameters()

Returns

PaginatedAttendanceClient

The current PaginatedAttendanceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAttendanceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAttendanceClient

The current PaginatedAttendanceClient instance.

Remarks

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

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.

IncludePerson()

Include related Person resources in the response.

public AttendanceClient IncludePerson()

Returns

AttendanceClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAttendanceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAttendanceClient

The current PaginatedAttendanceClient instance.

OrderByFirstName()

Sort response items by the FirstName attribute.

public AttendanceClient OrderByFirstName()

Returns

AttendanceClient

OrderByFirstNameDescending()

Sort response items by the FirstName attribute. Use reverse order.

public AttendanceClient OrderByFirstNameDescending()

Returns

AttendanceClient

OrderByLastName()

Sort response items by the LastName attribute.

public AttendanceClient OrderByLastName()

Returns

AttendanceClient

OrderByLastNameDescending()

Sort response items by the LastName attribute. Use reverse order.

public AttendanceClient OrderByLastNameDescending()

Returns

AttendanceClient

OrderByRole()

Sort response items by the Role attribute.

public AttendanceClient OrderByRole()

Returns

AttendanceClient

OrderByRoleDescending()

Sort response items by the Role attribute. Use reverse order.

public AttendanceClient OrderByRoleDescending()

Returns

AttendanceClient

PerPage(int)

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

public PaginatedAttendanceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAttendanceClient

The current PaginatedAttendanceClient instance.

WhereRole(string)

Query response items by the Role attribute.

public AttendanceClient WhereRole(string value)

Parameters

value string

Returns

AttendanceClient