Class AddressClient

Namespace

Crews.PlanningCenter.Api.People.V2020_07_22

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Address resource.

public class AddressClient : SingletonResourceClient<Address, AddressResource, AddressResponse>

Inheritance

object

ResourceClient<Address>

SingletonResourceClient<Address, AddressResource, AddressResponse>

AddressClient

Inherited Members

SingletonResourceClient<Address, AddressResource, AddressResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Address, AddressResource, AddressResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Address, AddressResource, AddressResponse>.PatchAsync(Address, CancellationToken)

SingletonResourceClient<Address, AddressResource, AddressResponse>.PatchAsync(JsonApiDocument<AddressResource>, CancellationToken)

SingletonResourceClient<Address, AddressResource, AddressResponse>.DeleteAsync(CancellationToken)

ResourceClient<Address>.AddQueryParameter(string, string)

ResourceClient<Address>.ReplaceQueryParameter(string, string)

ResourceClient<Address>.AddCustomParameter(string, string)

ResourceClient<Address>.ClearParameters()

ResourceClient<Address>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Address>.Uri

ResourceClient<Address>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AddressClient(HttpClient, Uri)

Client for interacting with the Address resource.

public AddressClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

DeleteAsync(CancellationToken)

Deletes the Address resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Address resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(Address, CancellationToken)

Updates an existing Address resource asynchronously.

public Task<AddressResponse> PatchAsync(Address resource, CancellationToken cancellationToken = default)

Parameters

resource Address

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressResponse>

A task representing the asynchronous operation, containing the updated Address resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<AddressResource>, CancellationToken)

Updates an existing Address resource asynchronously.

public Task<AddressResponse> PatchAsync(JsonApiDocument<AddressResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<AddressResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AddressResponse>

A task representing the asynchronous operation, containing the updated Address resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.