Class SpeakerClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Speaker resource.

public class SpeakerClient : SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>

Inheritance

object

ResourceClient<Speaker>

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>

SpeakerClient

Inherited Members

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>.PatchAsync(Speaker, CancellationToken)

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>.PatchAsync(JsonApiDocument<SpeakerResource>, CancellationToken)

SingletonResourceClient<Speaker, SpeakerResource, SpeakerResponse>.DeleteAsync(CancellationToken)

ResourceClient<Speaker>.AddQueryParameter(string, string)

ResourceClient<Speaker>.ReplaceQueryParameter(string, string)

ResourceClient<Speaker>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Speaker>.Uri

ResourceClient<Speaker>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SpeakerClient(HttpClient, Uri)

Client for interacting with the Speaker resource.

public SpeakerClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public SpeakerClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

SpeakerClient

The current SpeakerClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public SpeakerClient ClearParameters()

Returns

SpeakerClient

The current SpeakerClient instance.

GetAsync(CancellationToken)

Fetches the Speaker resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakerResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.