Class EpisodeResourceClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EpisodeResource resource.

public class EpisodeResourceClient : SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>

Inheritance

object

ResourceClient<EpisodeResource>

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>

EpisodeResourceClient

Inherited Members

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>.PatchAsync(EpisodeResource, CancellationToken)

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>.PatchAsync(JsonApiDocument<EpisodeResourceResource>, CancellationToken)

SingletonResourceClient<EpisodeResource, EpisodeResourceResource, EpisodeResourceResponse>.DeleteAsync(CancellationToken)

ResourceClient<EpisodeResource>.AddQueryParameter(string, string)

ResourceClient<EpisodeResource>.ReplaceQueryParameter(string, string)

ResourceClient<EpisodeResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EpisodeResource>.Uri

ResourceClient<EpisodeResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EpisodeResourceClient(HttpClient, Uri)

Client for interacting with the EpisodeResource resource.

public EpisodeResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EpisodeResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EpisodeResourceClient

The current EpisodeResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EpisodeResourceClient ClearParameters()

Returns

EpisodeResourceClient

The current EpisodeResourceClient instance.

DeleteAsync(CancellationToken)

Deletes the EpisodeResource 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 EpisodeResource resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(EpisodeResource, CancellationToken)

Updates an existing EpisodeResource resource asynchronously.

public Task<EpisodeResourceResponse> PatchAsync(EpisodeResource resource, CancellationToken cancellationToken = default)

Parameters

resource EpisodeResource

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<EpisodeResourceResource>, CancellationToken)

Updates an existing EpisodeResource resource asynchronously.

public Task<EpisodeResourceResponse> PatchAsync(JsonApiDocument<EpisodeResourceResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<EpisodeResourceResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.