Class PaginatedEmailClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Email collection resources.

public class PaginatedEmailClient : PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>

Inheritance

object

ResourceClient<Email>

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>

PaginatedEmailClient

Inherited Members

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PerPage(int)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.Offset(int)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.Filter(string)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PostAsync(Email, CancellationToken)

PaginatedResourceClient<Email, EmailResource, EmailCollectionResponse, EmailResponse>.PostAsync(JsonApiDocument<EmailResource>, 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

PaginatedEmailClient(HttpClient, Uri)

Client for interacting with Email collection resources.

public PaginatedEmailClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEmailClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEmailClient ClearParameters()

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEmailClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Email resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EmailCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEmailClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

PerPage(int)

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

public PaginatedEmailClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEmailClient

The current PaginatedEmailClient instance.

WithId(string)

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

public EmailClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EmailClient

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