Class PaginatedOptionClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Option collection resources.

public class PaginatedOptionClient : PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>

Inheritance

object

ResourceClient<Option>

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>

PaginatedOptionClient

Inherited Members

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.PerPage(int)

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.Offset(int)

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.Filter(string)

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.PostAsync(Option, CancellationToken)

PaginatedResourceClient<Option, OptionResource, OptionCollectionResponse, OptionResponse>.PostAsync(JsonApiDocument<OptionResource>, CancellationToken)

ResourceClient<Option>.AddQueryParameter(string, string)

ResourceClient<Option>.ReplaceQueryParameter(string, string)

ResourceClient<Option>.AddCustomParameter(string, string)

ResourceClient<Option>.ClearParameters()

ResourceClient<Option>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Option>.Uri

ResourceClient<Option>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedOptionClient(HttpClient, Uri)

Client for interacting with Option collection resources.

public PaginatedOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Option resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<OptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLabel()

Include related Label resources in the response.

public OptionClient IncludeLabel()

Returns

OptionClient

WithId(string)

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

public OptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

OptionClient

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