Class CustomSenderClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public CustomSenderClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

CustomSenderClient

The current CustomSenderClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public CustomSenderClient ClearParameters()

Returns

CustomSenderClient

The current CustomSenderClient instance.

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