Class ChannelDefaultTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ChannelDefaultTime resource.

public class ChannelDefaultTimeClient : SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>

Inheritance

object

ResourceClient<ChannelDefaultTime>

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>

ChannelDefaultTimeClient

Inherited Members

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>.PatchAsync(ChannelDefaultTime, CancellationToken)

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>.PatchAsync(JsonApiDocument<ChannelDefaultTimeResource>, CancellationToken)

SingletonResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<ChannelDefaultTime>.AddQueryParameter(string, string)

ResourceClient<ChannelDefaultTime>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelDefaultTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ChannelDefaultTime>.Uri

ResourceClient<ChannelDefaultTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ChannelDefaultTimeClient(HttpClient, Uri)

Client for interacting with the ChannelDefaultTime resource.

public ChannelDefaultTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ChannelDefaultTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ChannelDefaultTimeClient

The current ChannelDefaultTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ChannelDefaultTimeClient ClearParameters()

Returns

ChannelDefaultTimeClient

The current ChannelDefaultTimeClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(ChannelDefaultTime, CancellationToken)

Updates an existing ChannelDefaultTime resource asynchronously.

public Task<ChannelDefaultTimeResponse> PatchAsync(ChannelDefaultTime resource, CancellationToken cancellationToken = default)

Parameters

resource ChannelDefaultTime

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ChannelDefaultTimeResource>, CancellationToken)

Updates an existing ChannelDefaultTime resource asynchronously.

public Task<ChannelDefaultTimeResponse> PatchAsync(JsonApiDocument<ChannelDefaultTimeResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ChannelDefaultTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.