Class PaginatedScheduleClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Schedule collection resources.

public class PaginatedScheduleClient : PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>

Inheritance

object

ResourceClient<Schedule>

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>

PaginatedScheduleClient

Inherited Members

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.PerPage(int)

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.Offset(int)

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.Filter(string)

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.PostAsync(Schedule, CancellationToken)

PaginatedResourceClient<Schedule, ScheduleResource, ScheduleCollectionResponse, ScheduleResponse>.PostAsync(JsonApiDocument<ScheduleResource>, CancellationToken)

ResourceClient<Schedule>.AddQueryParameter(string, string)

ResourceClient<Schedule>.ReplaceQueryParameter(string, string)

ResourceClient<Schedule>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Schedule>.Uri

ResourceClient<Schedule>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedScheduleClient(HttpClient, Uri)

Client for interacting with Schedule collection resources.

public PaginatedScheduleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedScheduleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedScheduleClient

The current PaginatedScheduleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedScheduleClient ClearParameters()

Returns

PaginatedScheduleClient

The current PaginatedScheduleClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedScheduleClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedScheduleClient

The current PaginatedScheduleClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Schedule resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ScheduleCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePlanTimes()

Include related PlanTimes resources in the response.

public ScheduleClient IncludePlanTimes()

Returns

ScheduleClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedScheduleClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedScheduleClient

The current PaginatedScheduleClient instance.

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public ScheduleClient OrderByStartsAt()

Returns

ScheduleClient

OrderByStartsAtDescending()

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

public ScheduleClient OrderByStartsAtDescending()

Returns

ScheduleClient

PerPage(int)

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

public PaginatedScheduleClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedScheduleClient

The current PaginatedScheduleClient instance.

WherePlanId(int)

Query response items by the PlanId attribute.

public ScheduleClient WherePlanId(int value)

Parameters

value int

Returns

ScheduleClient

WithId(string)

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

public ScheduleClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

ScheduleClient

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