Class CustomSenderClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the CustomSender resource.

public class CustomSenderClient : SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>

Inheritance

object

ResourceClient<CustomSender>

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>

CustomSenderClient

Inherited Members

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>.GetAsync(CancellationToken)

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>.PatchAsync(CustomSender, CancellationToken)

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>.PatchAsync(JsonApiDocument<CustomSenderResource>, CancellationToken)

SingletonResourceClient<CustomSender, CustomSenderResource, CustomSenderResponse>.DeleteAsync(CancellationToken)

ResourceClient<CustomSender>.AddQueryParameter(string, string)

ResourceClient<CustomSender>.ReplaceQueryParameter(string, string)

ResourceClient<CustomSender>.AddCustomParameter(string, string)

ResourceClient<CustomSender>.ClearParameters()

ResourceClient<CustomSender>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CustomSender>.Uri

ResourceClient<CustomSender>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CustomSenderClient(HttpClient, Uri)

Client for interacting with the CustomSender resource.

public CustomSenderClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the CustomSender resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CustomSenderResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

SendVerificationAsync(CancellationToken)

Begins the verification process when a custom sender's email address is created or updated.

public Task SendVerificationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task