Class SpamEmailAddressClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the SpamEmailAddress resource.

public class SpamEmailAddressClient : SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>

Inheritance

object

ResourceClient<SpamEmailAddress>

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>

SpamEmailAddressClient

Inherited Members

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>.GetAsync(CancellationToken)

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>.PatchAsync(SpamEmailAddress, CancellationToken)

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>.PatchAsync(JsonApiDocument<SpamEmailAddressResource>, CancellationToken)

SingletonResourceClient<SpamEmailAddress, SpamEmailAddressResource, SpamEmailAddressResponse>.DeleteAsync(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

SpamEmailAddressClient(HttpClient, Uri)

Client for interacting with the SpamEmailAddress resource.

public SpamEmailAddressClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SpamEmailAddressClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SpamEmailAddressClient

The current SpamEmailAddressClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SpamEmailAddressClient ClearParameters()

Returns

SpamEmailAddressClient

The current SpamEmailAddressClient instance.

GetAsync(CancellationToken)

Fetches the SpamEmailAddress resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpamEmailAddressResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.