Class PaginatedTimePreferenceOptionClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with TimePreferenceOption collection resources.

public class PaginatedTimePreferenceOptionClient : PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>

Inheritance

object

ResourceClient<TimePreferenceOption>

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>

PaginatedTimePreferenceOptionClient

Inherited Members

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.PerPage(int)

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.Offset(int)

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.Filter(string)

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.PostAsync(TimePreferenceOption, CancellationToken)

PaginatedResourceClient<TimePreferenceOption, TimePreferenceOptionResource, TimePreferenceOptionCollectionResponse, TimePreferenceOptionResponse>.PostAsync(JsonApiDocument<TimePreferenceOptionResource>, CancellationToken)

ResourceClient<TimePreferenceOption>.AddQueryParameter(string, string)

ResourceClient<TimePreferenceOption>.ReplaceQueryParameter(string, string)

ResourceClient<TimePreferenceOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<TimePreferenceOption>.Uri

ResourceClient<TimePreferenceOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedTimePreferenceOptionClient(HttpClient, Uri)

Client for interacting with TimePreferenceOption collection resources.

public PaginatedTimePreferenceOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedTimePreferenceOptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedTimePreferenceOptionClient

The current PaginatedTimePreferenceOptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedTimePreferenceOptionClient ClearParameters()

Returns

PaginatedTimePreferenceOptionClient

The current PaginatedTimePreferenceOptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedTimePreferenceOptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedTimePreferenceOptionClient

The current PaginatedTimePreferenceOptionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of TimePreferenceOption resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<TimePreferenceOptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedTimePreferenceOptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedTimePreferenceOptionClient

The current PaginatedTimePreferenceOptionClient instance.

OrderByDayOfWeek()

Sort response items by the DayOfWeek attribute.

public TimePreferenceOptionClient OrderByDayOfWeek()

Returns

TimePreferenceOptionClient

OrderByDayOfWeekDescending()

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

public TimePreferenceOptionClient OrderByDayOfWeekDescending()

Returns

TimePreferenceOptionClient

OrderByHourOfDay()

Sort response items by the HourOfDay attribute.

public TimePreferenceOptionClient OrderByHourOfDay()

Returns

TimePreferenceOptionClient

OrderByHourOfDayDescending()

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

public TimePreferenceOptionClient OrderByHourOfDayDescending()

Returns

TimePreferenceOptionClient

PerPage(int)

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

public PaginatedTimePreferenceOptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedTimePreferenceOptionClient

The current PaginatedTimePreferenceOptionClient instance.

WithId(string)

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

public TimePreferenceOptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

TimePreferenceOptionClient

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