Class PaginatedChannelDefaultTimeClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedChannelDefaultTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedChannelDefaultTimeClient

The current PaginatedChannelDefaultTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedChannelDefaultTimeClient ClearParameters()

Returns

PaginatedChannelDefaultTimeClient

The current PaginatedChannelDefaultTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedChannelDefaultTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedChannelDefaultTimeClient

The current PaginatedChannelDefaultTimeClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedChannelDefaultTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedChannelDefaultTimeClient

The current PaginatedChannelDefaultTimeClient instance.

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

PerPage(int)

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

public PaginatedChannelDefaultTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedChannelDefaultTimeClient

The current PaginatedChannelDefaultTimeClient instance.

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.