Class PaginatedSpamEmailAddressClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SpamEmailAddress collection resources.

public class PaginatedSpamEmailAddressClient : PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>

Inheritance

object

ResourceClient<SpamEmailAddress>

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>

PaginatedSpamEmailAddressClient

Inherited Members

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.PerPage(int)

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.Offset(int)

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.Filter(string)

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.PostAsync(SpamEmailAddress, CancellationToken)

PaginatedResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressCollectionResponse, SpamEmailAddressResponse>.PostAsync(JsonApiDocument<SpamEmailAddressResource>, CancellationToken)

ResourceClient<SpamEmailAddress>.AddQueryParameter(string, string)

ResourceClient<SpamEmailAddress>.ReplaceQueryParameter(string, string)

ResourceClient<SpamEmailAddress>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SpamEmailAddress>.Uri

ResourceClient<SpamEmailAddress>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSpamEmailAddressClient(HttpClient, Uri)

Client for interacting with SpamEmailAddress collection resources.

public PaginatedSpamEmailAddressClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSpamEmailAddressClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSpamEmailAddressClient

The current PaginatedSpamEmailAddressClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSpamEmailAddressClient ClearParameters()

Returns

PaginatedSpamEmailAddressClient

The current PaginatedSpamEmailAddressClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSpamEmailAddressClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSpamEmailAddressClient

The current PaginatedSpamEmailAddressClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SpamEmailAddress resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpamEmailAddressCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSpamEmailAddressClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSpamEmailAddressClient

The current PaginatedSpamEmailAddressClient instance.

PerPage(int)

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

public PaginatedSpamEmailAddressClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSpamEmailAddressClient

The current PaginatedSpamEmailAddressClient instance.

WithId(string)

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

public SpamEmailAddressClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SpamEmailAddressClient

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