Class PassClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Pass resource.

public class PassClient : SingletonResourceClient<Pass, PassResource, PassResponse>

Inheritance

object

ResourceClient<Pass>

SingletonResourceClient<Pass, PassResource, PassResponse>

PassClient

Inherited Members

SingletonResourceClient<Pass, PassResource, PassResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Pass, PassResource, PassResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Pass, PassResource, PassResponse>.PatchAsync(Pass, CancellationToken)

SingletonResourceClient<Pass, PassResource, PassResponse>.PatchAsync(JsonApiDocument<PassResource>, CancellationToken)

SingletonResourceClient<Pass, PassResource, PassResponse>.DeleteAsync(CancellationToken)

ResourceClient<Pass>.AddQueryParameter(string, string)

ResourceClient<Pass>.ReplaceQueryParameter(string, string)

ResourceClient<Pass>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Pass>.Uri

ResourceClient<Pass>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PassClient(HttpClient, Uri)

Client for interacting with the Pass resource.

public PassClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PassClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PassClient

The current PassClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PassClient ClearParameters()

Returns

PassClient

The current PassClient instance.

GetAsync(CancellationToken)

Fetches the Pass resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PassResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public PassClient IncludePerson()

Returns

PassClient