Class PaginatedCalendarClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Calendar collection resources.

public class PaginatedCalendarClient : PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>

Inheritance

object

ResourceClient<Calendar>

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>

PaginatedCalendarClient

Inherited Members

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.PerPage(int)

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.Offset(int)

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.Filter(string)

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.PostAsync(Calendar, CancellationToken)

PaginatedResourceClient<Calendar, CalendarResource, CalendarCollectionResponse, CalendarResponse>.PostAsync(JsonApiDocument<CalendarResource>, CancellationToken)

ResourceClient<Calendar>.AddQueryParameter(string, string)

ResourceClient<Calendar>.ReplaceQueryParameter(string, string)

ResourceClient<Calendar>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Calendar>.Uri

ResourceClient<Calendar>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCalendarClient(HttpClient, Uri)

Client for interacting with Calendar collection resources.

public PaginatedCalendarClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCalendarClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCalendarClient

The current PaginatedCalendarClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCalendarClient ClearParameters()

Returns

PaginatedCalendarClient

The current PaginatedCalendarClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCalendarClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCalendarClient

The current PaginatedCalendarClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Calendar resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CalendarCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeApprovalGroups()

Include related ApprovalGroups resources in the response.

public CalendarClient IncludeApprovalGroups()

Returns

CalendarClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCalendarClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCalendarClient

The current PaginatedCalendarClient instance.

OrderByName()

Sort response items by the Name attribute.

public CalendarClient OrderByName()

Returns

CalendarClient

OrderByNameDescending()

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

public CalendarClient OrderByNameDescending()

Returns

CalendarClient

PerPage(int)

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

public PaginatedCalendarClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCalendarClient

The current PaginatedCalendarClient instance.

WithId(string)

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

public CalendarClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CalendarClient

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