Class ChannelNextTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ChannelNextTime resource.

public class ChannelNextTimeClient : SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>

Inheritance

object

ResourceClient<ChannelNextTime>

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>

ChannelNextTimeClient

Inherited Members

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>.PatchAsync(ChannelNextTime, CancellationToken)

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>.PatchAsync(JsonApiDocument<ChannelNextTimeResource>, CancellationToken)

SingletonResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<ChannelNextTime>.AddQueryParameter(string, string)

ResourceClient<ChannelNextTime>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelNextTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ChannelNextTime>.Uri

ResourceClient<ChannelNextTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ChannelNextTimeClient(HttpClient, Uri)

Client for interacting with the ChannelNextTime resource.

public ChannelNextTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ChannelNextTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ChannelNextTimeClient

The current ChannelNextTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ChannelNextTimeClient ClearParameters()

Returns

ChannelNextTimeClient

The current ChannelNextTimeClient instance.

GetAsync(CancellationToken)

Fetches the ChannelNextTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelNextTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.