Class ConnectedPersonClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ConnectedPerson resource.

public class ConnectedPersonClient : SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>

Inheritance

object

ResourceClient<ConnectedPerson>

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>

ConnectedPersonClient

Inherited Members

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>.PatchAsync(ConnectedPerson, CancellationToken)

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>.PatchAsync(JsonApiDocument<ConnectedPersonResource>, CancellationToken)

SingletonResourceClient<ConnectedPerson, ConnectedPersonResource, ConnectedPersonResponse>.DeleteAsync(CancellationToken)

ResourceClient<ConnectedPerson>.AddQueryParameter(string, string)

ResourceClient<ConnectedPerson>.ReplaceQueryParameter(string, string)

ResourceClient<ConnectedPerson>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ConnectedPerson>.Uri

ResourceClient<ConnectedPerson>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConnectedPersonClient(HttpClient, Uri)

Client for interacting with the ConnectedPerson resource.

public ConnectedPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ConnectedPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ConnectedPersonClient

The current ConnectedPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ConnectedPersonClient ClearParameters()

Returns

ConnectedPersonClient

The current ConnectedPersonClient instance.

GetAsync(CancellationToken)

Fetches the ConnectedPerson resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ConnectedPersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.