Class PaginatedFormFieldOptionClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormFieldOption collection resources.

public class PaginatedFormFieldOptionClient : PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>

Inheritance

object

ResourceClient<FormFieldOption>

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>

PaginatedFormFieldOptionClient

Inherited Members

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.PerPage(int)

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.Offset(int)

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.Filter(string)

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.PostAsync(FormFieldOption, CancellationToken)

PaginatedResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionCollectionResponse, FormFieldOptionResponse>.PostAsync(JsonApiDocument<FormFieldOptionResource>, CancellationToken)

ResourceClient<FormFieldOption>.AddQueryParameter(string, string)

ResourceClient<FormFieldOption>.ReplaceQueryParameter(string, string)

ResourceClient<FormFieldOption>.AddCustomParameter(string, string)

ResourceClient<FormFieldOption>.ClearParameters()

ResourceClient<FormFieldOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormFieldOption>.Uri

ResourceClient<FormFieldOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormFieldOptionClient(HttpClient, Uri)

Client for interacting with FormFieldOption collection resources.

public PaginatedFormFieldOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of FormFieldOption resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldOptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormFieldOptionClient OrderByCreatedAt()

Returns

FormFieldOptionClient

OrderByCreatedAtDescending()

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

public FormFieldOptionClient OrderByCreatedAtDescending()

Returns

FormFieldOptionClient

OrderBySequence()

Sort response items by the Sequence attribute.

public FormFieldOptionClient OrderBySequence()

Returns

FormFieldOptionClient

OrderBySequenceDescending()

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

public FormFieldOptionClient OrderBySequenceDescending()

Returns

FormFieldOptionClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormFieldOptionClient OrderByUpdatedAt()

Returns

FormFieldOptionClient

OrderByUpdatedAtDescending()

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

public FormFieldOptionClient OrderByUpdatedAtDescending()

Returns

FormFieldOptionClient

WithId(string)

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

public FormFieldOptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormFieldOptionClient

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