Class PersonMergerClient

Namespace

Crews.PlanningCenter.Api.People.V2023_03_21

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PersonMerger resource.

public class PersonMergerClient : SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>

Inheritance

object

ResourceClient<PersonMerger>

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>

PersonMergerClient

Inherited Members

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>.PatchAsync(PersonMerger, CancellationToken)

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>.PatchAsync(JsonApiDocument<PersonMergerResource>, CancellationToken)

SingletonResourceClient<PersonMerger, PersonMergerResource, PersonMergerResponse>.DeleteAsync(CancellationToken)

ResourceClient<PersonMerger>.AddQueryParameter(string, string)

ResourceClient<PersonMerger>.ReplaceQueryParameter(string, string)

ResourceClient<PersonMerger>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonMerger>.Uri

ResourceClient<PersonMerger>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonMergerClient(HttpClient, Uri)

Client for interacting with the PersonMerger resource.

public PersonMergerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PersonMergerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PersonMergerClient

The current PersonMergerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PersonMergerClient ClearParameters()

Returns

PersonMergerClient

The current PersonMergerClient instance.

GetAsync(CancellationToken)

Fetches the PersonMerger resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonMergerResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.