Class PaginatedHeadcountClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Headcount collection resources.

public class PaginatedHeadcountClient : PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>

Inheritance

object

ResourceClient<Headcount>

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>

PaginatedHeadcountClient

Inherited Members

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.PerPage(int)

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.Offset(int)

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.Filter(string)

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.PostAsync(Headcount, CancellationToken)

PaginatedResourceClient<Headcount, HeadcountResource, HeadcountCollectionResponse, HeadcountResponse>.PostAsync(JsonApiDocument<HeadcountResource>, CancellationToken)

ResourceClient<Headcount>.AddQueryParameter(string, string)

ResourceClient<Headcount>.ReplaceQueryParameter(string, string)

ResourceClient<Headcount>.AddCustomParameter(string, string)

ResourceClient<Headcount>.ClearParameters()

ResourceClient<Headcount>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Headcount>.Uri

ResourceClient<Headcount>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedHeadcountClient(HttpClient, Uri)

Client for interacting with Headcount collection resources.

public PaginatedHeadcountClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Headcount resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<HeadcountCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAttendanceType()

Include related AttendanceType resources in the response.

public HeadcountClient IncludeAttendanceType()

Returns

HeadcountClient

IncludeEventTime()

Include related EventTime resources in the response.

public HeadcountClient IncludeEventTime()

Returns

HeadcountClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public HeadcountClient OrderByCreatedAt()

Returns

HeadcountClient

OrderByCreatedAtDescending()

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

public HeadcountClient OrderByCreatedAtDescending()

Returns

HeadcountClient

OrderByTotal()

Sort response items by the Total attribute.

public HeadcountClient OrderByTotal()

Returns

HeadcountClient

OrderByTotalDescending()

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

public HeadcountClient OrderByTotalDescending()

Returns

HeadcountClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public HeadcountClient OrderByUpdatedAt()

Returns

HeadcountClient

OrderByUpdatedAtDescending()

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

public HeadcountClient OrderByUpdatedAtDescending()

Returns

HeadcountClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public HeadcountClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

HeadcountClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public HeadcountClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

HeadcountClient

WithId(string)

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

public HeadcountClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

HeadcountClient

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