Class PersonAppClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PersonApp resource.

public class PersonAppClient : SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>

Inheritance

object

ResourceClient<PersonApp>

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>

PersonAppClient

Inherited Members

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>.PatchAsync(PersonApp, CancellationToken)

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>.PatchAsync(JsonApiDocument<PersonAppResource>, CancellationToken)

SingletonResourceClient<PersonApp, PersonAppResource, PersonAppResponse>.DeleteAsync(CancellationToken)

ResourceClient<PersonApp>.AddQueryParameter(string, string)

ResourceClient<PersonApp>.ReplaceQueryParameter(string, string)

ResourceClient<PersonApp>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonApp>.Uri

ResourceClient<PersonApp>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonAppClient(HttpClient, Uri)

Client for interacting with the PersonApp resource.

public PersonAppClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

App

Associated App.

public AppClient App { get; }

Property Value

AppClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PersonAppClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PersonAppClient

The current PersonAppClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PersonAppClient ClearParameters()

Returns

PersonAppClient

The current PersonAppClient instance.

GetAsync(CancellationToken)

Fetches the PersonApp resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonAppResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeApp()

Include related App resources in the response.

public PersonAppClient IncludeApp()

Returns

PersonAppClient