Class EmailTemplateRenderedResponseClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EmailTemplateRenderedResponse resource.

public class EmailTemplateRenderedResponseClient : SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>

Inheritance

object

ResourceClient<EmailTemplateRenderedResponse>

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>

EmailTemplateRenderedResponseClient

Inherited Members

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>.PatchAsync(EmailTemplateRenderedResponse, CancellationToken)

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>.PatchAsync(JsonApiDocument<EmailTemplateRenderedResponseResource>, CancellationToken)

SingletonResourceClient<EmailTemplateRenderedResponse, EmailTemplateRenderedResponseResource, EmailTemplateRenderedResponseResponse>.DeleteAsync(CancellationToken)

ResourceClient<EmailTemplateRenderedResponse>.AddQueryParameter(string, string)

ResourceClient<EmailTemplateRenderedResponse>.ReplaceQueryParameter(string, string)

ResourceClient<EmailTemplateRenderedResponse>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EmailTemplateRenderedResponse>.Uri

ResourceClient<EmailTemplateRenderedResponse>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EmailTemplateRenderedResponseClient(HttpClient, Uri)

Client for interacting with the EmailTemplateRenderedResponse resource.

public EmailTemplateRenderedResponseClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EmailTemplateRenderedResponseClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EmailTemplateRenderedResponseClient

The current EmailTemplateRenderedResponseClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EmailTemplateRenderedResponseClient ClearParameters()

Returns

EmailTemplateRenderedResponseClient

The current EmailTemplateRenderedResponseClient instance.

GetAsync(CancellationToken)

Fetches the EmailTemplateRenderedResponse resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailTemplateRenderedResponseResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.