Class ConnectedApplicationPersonClient

Namespace

Crews.PlanningCenter.Api.Api.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ConnectedApplicationPerson resource.

public class ConnectedApplicationPersonClient : SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>

Inheritance

object

ResourceClient<ConnectedApplicationPerson>

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>

ConnectedApplicationPersonClient

Inherited Members

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>.PatchAsync(ConnectedApplicationPerson, CancellationToken)

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>.PatchAsync(JsonApiDocument<ConnectedApplicationPersonResource>, CancellationToken)

SingletonResourceClient<ConnectedApplicationPerson, ConnectedApplicationPersonResource, ConnectedApplicationPersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<ConnectedApplicationPerson>.AddQueryParameter(string, string)

ResourceClient<ConnectedApplicationPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedApplicationPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedApplicationPerson>.Uri

ResourceClient<ConnectedApplicationPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConnectedApplicationPersonClient(HttpClient, Uri)

Client for interacting with the ConnectedApplicationPerson resource.

public ConnectedApplicationPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ConnectedApplicationPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ConnectedApplicationPersonClient

The current ConnectedApplicationPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ConnectedApplicationPersonClient ClearParameters()

Returns

ConnectedApplicationPersonClient

The current ConnectedApplicationPersonClient instance.

GetAsync(CancellationToken)

Fetches the ConnectedApplicationPerson resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedApplicationPersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.