Class PaginatedBackgroundCheckClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBackgroundCheckClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBackgroundCheckClient

The current PaginatedBackgroundCheckClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBackgroundCheckClient ClearParameters()

Returns

PaginatedBackgroundCheckClient

The current PaginatedBackgroundCheckClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBackgroundCheckClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBackgroundCheckClient

The current PaginatedBackgroundCheckClient instance.

Remarks

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

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.

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public BackgroundCheckClient IncludeCreatedBy()

Returns

BackgroundCheckClient

IncludePerson()

Include related Person resources in the response.

public BackgroundCheckClient IncludePerson()

Returns

BackgroundCheckClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBackgroundCheckClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBackgroundCheckClient

The current PaginatedBackgroundCheckClient instance.

OrderByExpiresOn()

Sort response items by the ExpiresOn attribute.

public BackgroundCheckClient OrderByExpiresOn()

Returns

BackgroundCheckClient

OrderByExpiresOnDescending()

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

public BackgroundCheckClient OrderByExpiresOnDescending()

Returns

BackgroundCheckClient

OrderByStatusUpdatedAt()

Sort response items by the StatusUpdatedAt attribute.

public BackgroundCheckClient OrderByStatusUpdatedAt()

Returns

BackgroundCheckClient

OrderByStatusUpdatedAtDescending()

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

public BackgroundCheckClient OrderByStatusUpdatedAtDescending()

Returns

BackgroundCheckClient

PerPage(int)

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

public PaginatedBackgroundCheckClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBackgroundCheckClient

The current PaginatedBackgroundCheckClient instance.

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.

WhereExpiresOn(DateOnly)

Query response items by the ExpiresOn attribute.

public BackgroundCheckClient WhereExpiresOn(DateOnly value)

Parameters

value DateOnly

Returns

BackgroundCheckClient

WhereStatusUpdatedAt(DateTime)

Query response items by the StatusUpdatedAt attribute.

public BackgroundCheckClient WhereStatusUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

BackgroundCheckClient

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.