Class PaginatedSchedulingPreferenceClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_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>.AddCustomParameter(string, string)

ResourceClient<SchedulingPreference>.ClearParameters()

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

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.

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.