Class PaginatedSchedulingPreferenceClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with SchedulingPreference collection resources.

public class PaginatedSchedulingPreferenceClient : PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>

Inheritance

object

ResourceClient<SchedulingPreference>

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>

PaginatedSchedulingPreferenceClient

Inherited Members

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.PerPage(int)

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.Offset(int)

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.Filter(string)

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.PostAsync(SchedulingPreference, CancellationToken)

PaginatedResourceClient<SchedulingPreference, SchedulingPreferenceResource, SchedulingPreferenceCollectionResponse, SchedulingPreferenceResponse>.PostAsync(JsonApiDocument<SchedulingPreferenceResource>, CancellationToken)

ResourceClient<SchedulingPreference>.AddQueryParameter(string, string)

ResourceClient<SchedulingPreference>.ReplaceQueryParameter(string, string)

ResourceClient<SchedulingPreference>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<SchedulingPreference>.Uri

ResourceClient<SchedulingPreference>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedSchedulingPreferenceClient(HttpClient, Uri)

Client for interacting with SchedulingPreference collection resources.

public PaginatedSchedulingPreferenceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedSchedulingPreferenceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedSchedulingPreferenceClient

The current PaginatedSchedulingPreferenceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedSchedulingPreferenceClient ClearParameters()

Returns

PaginatedSchedulingPreferenceClient

The current PaginatedSchedulingPreferenceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedSchedulingPreferenceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedSchedulingPreferenceClient

The current PaginatedSchedulingPreferenceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of SchedulingPreference resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<SchedulingPreferenceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedSchedulingPreferenceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedSchedulingPreferenceClient

The current PaginatedSchedulingPreferenceClient instance.

PerPage(int)

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

public PaginatedSchedulingPreferenceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedSchedulingPreferenceClient

The current PaginatedSchedulingPreferenceClient instance.

WithId(string)

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

public SchedulingPreferenceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

SchedulingPreferenceClient

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