Class PaginatedChannelNextTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedChannelNextTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedChannelNextTimeClient

The current PaginatedChannelNextTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedChannelNextTimeClient ClearParameters()

Returns

PaginatedChannelNextTimeClient

The current PaginatedChannelNextTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedChannelNextTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedChannelNextTimeClient

The current PaginatedChannelNextTimeClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedChannelNextTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedChannelNextTimeClient

The current PaginatedChannelNextTimeClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedChannelNextTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedChannelNextTimeClient

The current PaginatedChannelNextTimeClient instance.

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.