Class PaginatedBackgroundCheckClient

Namespace

Crews.PlanningCenter.Api.People.V2025_03_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BackgroundCheck collection resources.

public class PaginatedBackgroundCheckClient : PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>

Inheritance

object

ResourceClient<BackgroundCheck>

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>

PaginatedBackgroundCheckClient

Inherited Members

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.PerPage(int)

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.Offset(int)

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.Filter(string)

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.PostAsync(BackgroundCheck, CancellationToken)

PaginatedResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckCollectionResponse, BackgroundCheckResponse>.PostAsync(JsonApiDocument<BackgroundCheckResource>, CancellationToken)

ResourceClient<BackgroundCheck>.AddQueryParameter(string, string)

ResourceClient<BackgroundCheck>.ReplaceQueryParameter(string, string)

ResourceClient<BackgroundCheck>.AddCustomParameter(string, string)

ResourceClient<BackgroundCheck>.ClearParameters()

ResourceClient<BackgroundCheck>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BackgroundCheck>.Uri

ResourceClient<BackgroundCheck>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBackgroundCheckClient(HttpClient, Uri)

Client for interacting with BackgroundCheck collection resources.

public PaginatedBackgroundCheckClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of BackgroundCheck resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public BackgroundCheckClient IncludePerson()

Returns

BackgroundCheckClient

PostAsync(BackgroundCheck, CancellationToken)

Creates a new BackgroundCheck resource asynchronously.

public Task<BackgroundCheckResponse> PostAsync(BackgroundCheck resource, CancellationToken cancellationToken = default)

Parameters

resource BackgroundCheck

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckResponse>

A task representing the asynchronous operation, containing the created BackgroundCheck resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<BackgroundCheckResource>, CancellationToken)

Creates a new BackgroundCheck resource asynchronously.

public Task<BackgroundCheckResponse> PostAsync(JsonApiDocument<BackgroundCheckResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<BackgroundCheckResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckResponse>

A task representing the asynchronous operation, containing the created BackgroundCheck resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public BackgroundCheckClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

BackgroundCheckClient

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