Class PaginatedEmailClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_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>.AddCustomParameter(string, string)

ResourceClient<Email>.ClearParameters()

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

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.

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.