Class PaginatedEmailTemplateClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EmailTemplate collection resources.

public class PaginatedEmailTemplateClient : PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>

Inheritance

object

ResourceClient<EmailTemplate>

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>

PaginatedEmailTemplateClient

Inherited Members

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.PerPage(int)

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.Offset(int)

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.Filter(string)

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.PostAsync(EmailTemplate, CancellationToken)

PaginatedResourceClient<EmailTemplate, EmailTemplateResource, EmailTemplateCollectionResponse, EmailTemplateResponse>.PostAsync(JsonApiDocument<EmailTemplateResource>, CancellationToken)

ResourceClient<EmailTemplate>.AddQueryParameter(string, string)

ResourceClient<EmailTemplate>.ReplaceQueryParameter(string, string)

ResourceClient<EmailTemplate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EmailTemplate>.Uri

ResourceClient<EmailTemplate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEmailTemplateClient(HttpClient, Uri)

Client for interacting with EmailTemplate collection resources.

public PaginatedEmailTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEmailTemplateClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEmailTemplateClient

The current PaginatedEmailTemplateClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEmailTemplateClient ClearParameters()

Returns

PaginatedEmailTemplateClient

The current PaginatedEmailTemplateClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEmailTemplateClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEmailTemplateClient

The current PaginatedEmailTemplateClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

GetAsync(CancellationToken)

Fetches a paginated list of EmailTemplate resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailTemplateCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of EmailTemplate resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEmailTemplateClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEmailTemplateClient

The current PaginatedEmailTemplateClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedEmailTemplateClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEmailTemplateClient

The current PaginatedEmailTemplateClient instance.

PostAsync(EmailTemplate, CancellationToken)

Creates a new EmailTemplate resource asynchronously.

public Task<EmailTemplateResponse> PostAsync(EmailTemplate resource, CancellationToken cancellationToken = default)

Parameters

resource EmailTemplate

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailTemplateResponse>

A task representing the asynchronous operation, containing the created EmailTemplate resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<EmailTemplateResource>, CancellationToken)

Creates a new EmailTemplate resource asynchronously.

public Task<EmailTemplateResponse> PostAsync(JsonApiDocument<EmailTemplateResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EmailTemplateResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailTemplateResponse>

A task representing the asynchronous operation, containing the created EmailTemplate resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a EmailTemplate client for a specific resource ID.

public EmailTemplateClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EmailTemplateClient

A new instance of the resource client for the specified resource ID.