Class BackgroundCheckClient

Namespace

Crews.PlanningCenter.Api.People.V2023_03_21

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the BackgroundCheck resource.

public class BackgroundCheckClient : SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>

Inheritance

object

ResourceClient<BackgroundCheck>

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>

BackgroundCheckClient

Inherited Members

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>.GetAsync(CancellationToken)

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>.PatchAsync(BackgroundCheck, CancellationToken)

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>.PatchAsync(JsonApiDocument<BackgroundCheckResource>, CancellationToken)

SingletonResourceClient<BackgroundCheck, BackgroundCheckResource, BackgroundCheckResponse>.DeleteAsync(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

BackgroundCheckClient(HttpClient, Uri)

Client for interacting with the BackgroundCheck resource.

public BackgroundCheckClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public BackgroundCheckClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

BackgroundCheckClient

The current BackgroundCheckClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public BackgroundCheckClient ClearParameters()

Returns

BackgroundCheckClient

The current BackgroundCheckClient instance.

DeleteAsync(CancellationToken)

Deletes the BackgroundCheck resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the BackgroundCheck resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckResponse>

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

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

PatchAsync(BackgroundCheck, CancellationToken)

Updates an existing BackgroundCheck resource asynchronously.

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

Parameters

resource BackgroundCheck

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<BackgroundCheckResource>, CancellationToken)

Updates an existing BackgroundCheck resource asynchronously.

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

Parameters

document JsonApiDocument<BackgroundCheckResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BackgroundCheckResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.