Class EmailClient

Namespace

Crews.PlanningCenter.Api.People.V2023_03_21

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Email resource.

public class EmailClient : SingletonResourceClient<Email, EmailResource, EmailResponse>

Inheritance

object

ResourceClient<Email>

SingletonResourceClient<Email, EmailResource, EmailResponse>

EmailClient

Inherited Members

SingletonResourceClient<Email, EmailResource, EmailResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Email, EmailResource, EmailResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Email, EmailResource, EmailResponse>.PatchAsync(Email, CancellationToken)

SingletonResourceClient<Email, EmailResource, EmailResponse>.PatchAsync(JsonApiDocument<EmailResource>, CancellationToken)

SingletonResourceClient<Email, EmailResource, EmailResponse>.DeleteAsync(CancellationToken)

ResourceClient<Email>.AddQueryParameter(string, string)

ResourceClient<Email>.ReplaceQueryParameter(string, string)

ResourceClient<Email>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Email>.Uri

ResourceClient<Email>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EmailClient(HttpClient, Uri)

Client for interacting with the Email resource.

public EmailClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EmailClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EmailClient

The current EmailClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EmailClient ClearParameters()

Returns

EmailClient

The current EmailClient instance.

DeleteAsync(CancellationToken)

Deletes the Email 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 Email resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(Email, CancellationToken)

Updates an existing Email resource asynchronously.

public Task<EmailResponse> PatchAsync(Email resource, CancellationToken cancellationToken = default)

Parameters

resource Email

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<EmailResource>, CancellationToken)

Updates an existing Email resource asynchronously.

public Task<EmailResponse> PatchAsync(JsonApiDocument<EmailResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EmailResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.