Class ChannelClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Channel resource.

public class ChannelClient : SingletonResourceClient<Channel, ChannelResource, ChannelResponse>

Inheritance

object

ResourceClient<Channel>

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>

ChannelClient

Inherited Members

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>.PatchAsync(Channel, CancellationToken)

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>.PatchAsync(JsonApiDocument<ChannelResource>, CancellationToken)

SingletonResourceClient<Channel, ChannelResource, ChannelResponse>.DeleteAsync(CancellationToken)

ResourceClient<Channel>.AddQueryParameter(string, string)

ResourceClient<Channel>.ReplaceQueryParameter(string, string)

ResourceClient<Channel>.AddCustomParameter(string, string)

ResourceClient<Channel>.ClearParameters()

ResourceClient<Channel>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Channel>.Uri

ResourceClient<Channel>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ChannelClient(HttpClient, Uri)

Client for interacting with the Channel resource.

public ChannelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ChannelDefaultEpisodeResources

Associated ChannelDefaultEpisodeResources.

public PaginatedChannelDefaultEpisodeResourceClient ChannelDefaultEpisodeResources { get; }

Property Value

PaginatedChannelDefaultEpisodeResourceClient

ChannelDefaultTimes

Associated ChannelDefaultTimes.

public PaginatedChannelDefaultTimeClient ChannelDefaultTimes { get; }

Property Value

PaginatedChannelDefaultTimeClient

CurrentEpisode

Associated CurrentEpisode.

public EpisodeClient CurrentEpisode { get; }

Property Value

EpisodeClient

Episodes

Associated Episodes.

public PaginatedEpisodeClient Episodes { get; }

Property Value

PaginatedEpisodeClient

NextTimes

Associated NextTimes.

public PaginatedChannelNextTimeClient NextTimes { get; }

Property Value

PaginatedChannelNextTimeClient

Series

Associated Series.

public SeriesClient Series { get; }

Property Value

SeriesClient

Statistics

Associated Statistics.

public PaginatedEpisodeStatisticsClient Statistics { get; }

Property Value

PaginatedEpisodeStatisticsClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeChannelDefaultEpisodeResources()

Include related ChannelDefaultEpisodeResources resources in the response.

public ChannelClient IncludeChannelDefaultEpisodeResources()

Returns

ChannelClient

IncludeChannelDefaultTimes()

Include related ChannelDefaultTimes resources in the response.

public ChannelClient IncludeChannelDefaultTimes()

Returns

ChannelClient

IncludeCurrentEpisode()

Include related CurrentEpisode resources in the response.

public ChannelClient IncludeCurrentEpisode()

Returns

ChannelClient

PatchAsync(Channel, CancellationToken)

Updates an existing Channel resource asynchronously.

public Task<ChannelResponse> PatchAsync(Channel resource, CancellationToken cancellationToken = default)

Parameters

resource Channel

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ChannelResource>, CancellationToken)

Updates an existing Channel resource asynchronously.

public Task<ChannelResponse> PatchAsync(JsonApiDocument<ChannelResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ChannelResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.