Class PaginatedHeadcountClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2019_07_17

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedHeadcountClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedHeadcountClient

The current PaginatedHeadcountClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedHeadcountClient ClearParameters()

Returns

PaginatedHeadcountClient

The current PaginatedHeadcountClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedHeadcountClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedHeadcountClient

The current PaginatedHeadcountClient instance.

Remarks

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

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedHeadcountClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedHeadcountClient

The current PaginatedHeadcountClient instance.

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

PerPage(int)

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

public PaginatedHeadcountClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedHeadcountClient

The current PaginatedHeadcountClient instance.

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.