Class PaginatedChannelDefaultTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ChannelDefaultTime collection resources.

public class PaginatedChannelDefaultTimeClient : PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>

Inheritance

object

ResourceClient<ChannelDefaultTime>

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>

PaginatedChannelDefaultTimeClient

Inherited Members

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.PerPage(int)

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.Offset(int)

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.Filter(string)

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.PostAsync(ChannelDefaultTime, CancellationToken)

PaginatedResourceClient<ChannelDefaultTime, ChannelDefaultTimeResource, ChannelDefaultTimeCollectionResponse, ChannelDefaultTimeResponse>.PostAsync(JsonApiDocument<ChannelDefaultTimeResource>, CancellationToken)

ResourceClient<ChannelDefaultTime>.AddQueryParameter(string, string)

ResourceClient<ChannelDefaultTime>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelDefaultTime>.AddCustomParameter(string, string)

ResourceClient<ChannelDefaultTime>.ClearParameters()

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

PaginatedChannelDefaultTimeClient(HttpClient, Uri)

Client for interacting with ChannelDefaultTime collection resources.

public PaginatedChannelDefaultTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ChannelDefaultTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of ChannelDefaultTime resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByPosition()

Sort response items by the Position attribute.

public ChannelDefaultTimeClient OrderByPosition()

Returns

ChannelDefaultTimeClient

OrderByPositionDescending()

Sort response items by the Position attribute. Use reverse order.

public ChannelDefaultTimeClient OrderByPositionDescending()

Returns

ChannelDefaultTimeClient

PostAsync(ChannelDefaultTime, CancellationToken)

Creates a new ChannelDefaultTime resource asynchronously.

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

Parameters

resource ChannelDefaultTime

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<ChannelDefaultTimeResource>, CancellationToken)

Creates a new ChannelDefaultTime resource asynchronously.

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

Parameters

document JsonApiDocument<ChannelDefaultTimeResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelDefaultTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a ChannelDefaultTime client for a specific resource ID.

public ChannelDefaultTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ChannelDefaultTimeClient

A new instance of the resource client for the specified resource ID.