Class ChannelDefaultEpisodeResourceClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ChannelDefaultEpisodeResource resource.

public class ChannelDefaultEpisodeResourceClient : SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>

Inheritance

object

ResourceClient<ChannelDefaultEpisodeResource>

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>

ChannelDefaultEpisodeResourceClient

Inherited Members

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>.PatchAsync(ChannelDefaultEpisodeResource, CancellationToken)

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>.PatchAsync(JsonApiDocument<ChannelDefaultEpisodeResourceResource>, CancellationToken)

SingletonResourceClient<ChannelDefaultEpisodeResource, ChannelDefaultEpisodeResourceResource, ChannelDefaultEpisodeResourceResponse>.DeleteAsync(CancellationToken)

ResourceClient<ChannelDefaultEpisodeResource>.AddQueryParameter(string, string)

ResourceClient<ChannelDefaultEpisodeResource>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelDefaultEpisodeResource>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ChannelDefaultEpisodeResource>.Uri

ResourceClient<ChannelDefaultEpisodeResource>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ChannelDefaultEpisodeResourceClient(HttpClient, Uri)

Client for interacting with the ChannelDefaultEpisodeResource resource.

public ChannelDefaultEpisodeResourceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ChannelDefaultEpisodeResourceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ChannelDefaultEpisodeResourceClient

The current ChannelDefaultEpisodeResourceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ChannelDefaultEpisodeResourceClient ClearParameters()

Returns

ChannelDefaultEpisodeResourceClient

The current ChannelDefaultEpisodeResourceClient instance.

GetAsync(CancellationToken)

Fetches the ChannelDefaultEpisodeResource resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultEpisodeResourceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.