Class EmailClient

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

Client for interacting with the Email resource.

public EmailClient(HttpClient httpClient, Uri uri)

Adds a custom query parameter to the request URI.

public EmailClient AddCustomParameter(string parameter, string value)

Removes the entire query string from the request URI.

public EmailClient ClearParameters()

Fetches the Email resource asynchronously.

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

cancellationToken CancellationToken: A token to monitor for cancellation requests.

Task<EmailResponse>: A task representing the asynchronous operation, containing the Email resource.

JsonApiException: Thrown when the HTTP response indicates a failure status code.