Class PaginatedChannelNextTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2024_03_25

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with ChannelNextTime collection resources.

public class PaginatedChannelNextTimeClient : PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>

Inheritance

object

ResourceClient<ChannelNextTime>

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>

PaginatedChannelNextTimeClient

Inherited Members

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.PerPage(int)

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.Offset(int)

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.Filter(string)

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.PostAsync(ChannelNextTime, CancellationToken)

PaginatedResourceClient<ChannelNextTime, ChannelNextTimeResource, ChannelNextTimeCollectionResponse, ChannelNextTimeResponse>.PostAsync(JsonApiDocument<ChannelNextTimeResource>, CancellationToken)

ResourceClient<ChannelNextTime>.AddQueryParameter(string, string)

ResourceClient<ChannelNextTime>.ReplaceQueryParameter(string, string)

ResourceClient<ChannelNextTime>.AddCustomParameter(string, string)

ResourceClient<ChannelNextTime>.ClearParameters()

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

PaginatedChannelNextTimeClient(HttpClient, Uri)

Client for interacting with ChannelNextTime collection resources.

public PaginatedChannelNextTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of ChannelNextTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ChannelNextTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public ChannelNextTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ChannelNextTimeClient

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