Class SpeakershipClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Speakership resource.

public class SpeakershipClient : SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>

Inheritance

object

ResourceClient<Speakership>

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>

SpeakershipClient

Inherited Members

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>.PatchAsync(Speakership, CancellationToken)

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>.PatchAsync(JsonApiDocument<SpeakershipResource>, CancellationToken)

SingletonResourceClient<Speakership, SpeakershipResource, SpeakershipResponse>.DeleteAsync(CancellationToken)

ResourceClient<Speakership>.AddQueryParameter(string, string)

ResourceClient<Speakership>.ReplaceQueryParameter(string, string)

ResourceClient<Speakership>.AddCustomParameter(string, string)

ResourceClient<Speakership>.ClearParameters()

ResourceClient<Speakership>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Speakership>.Uri

ResourceClient<Speakership>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SpeakershipClient(HttpClient, Uri)

Client for interacting with the Speakership resource.

public SpeakershipClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Speaker

Associated Speaker.

public SpeakerClient Speaker { get; }

Property Value

SpeakerClient

Methods

DeleteAsync(CancellationToken)

Deletes the Speakership resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the Speakership resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeSpeaker()

Include related Speaker resources in the response.

public SpeakershipClient IncludeSpeaker()

Returns

SpeakershipClient

PatchAsync(Speakership, CancellationToken)

Updates an existing Speakership resource asynchronously.

public Task<SpeakershipResponse> PatchAsync(Speakership resource, CancellationToken cancellationToken = default)

Parameters

resource Speakership

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipResponse>

A task representing the asynchronous operation, containing the updated Speakership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<SpeakershipResource>, CancellationToken)

Updates an existing Speakership resource asynchronously.

public Task<SpeakershipResponse> PatchAsync(JsonApiDocument<SpeakershipResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<SpeakershipResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SpeakershipResponse>

A task representing the asynchronous operation, containing the updated Speakership resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.