Class PaginatedPreCheckClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PreCheck collection resources.

public class PaginatedPreCheckClient : PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>

Inheritance

object

ResourceClient<PreCheck>

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>

PaginatedPreCheckClient

Inherited Members

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.PerPage(int)

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.Offset(int)

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.Filter(string)

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.PostAsync(PreCheck, CancellationToken)

PaginatedResourceClient<PreCheck, PreCheckResource, PreCheckCollectionResponse, PreCheckResponse>.PostAsync(JsonApiDocument<PreCheckResource>, CancellationToken)

ResourceClient<PreCheck>.AddQueryParameter(string, string)

ResourceClient<PreCheck>.ReplaceQueryParameter(string, string)

ResourceClient<PreCheck>.AddCustomParameter(string, string)

ResourceClient<PreCheck>.ClearParameters()

ResourceClient<PreCheck>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PreCheck>.Uri

ResourceClient<PreCheck>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPreCheckClient(HttpClient, Uri)

Client for interacting with PreCheck collection resources.

public PaginatedPreCheckClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PreCheck resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PreCheckCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public PreCheckClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PreCheckClient

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