Class PaginatedFieldOptionClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FieldOption collection resources.

public class PaginatedFieldOptionClient : PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>

Inheritance

object

ResourceClient<FieldOption>

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>

PaginatedFieldOptionClient

Inherited Members

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.PerPage(int)

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.Offset(int)

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.Filter(string)

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.PostAsync(FieldOption, CancellationToken)

PaginatedResourceClient<FieldOption, FieldOptionResource, FieldOptionCollectionResponse, FieldOptionResponse>.PostAsync(JsonApiDocument<FieldOptionResource>, CancellationToken)

ResourceClient<FieldOption>.AddQueryParameter(string, string)

ResourceClient<FieldOption>.ReplaceQueryParameter(string, string)

ResourceClient<FieldOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FieldOption>.Uri

ResourceClient<FieldOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFieldOptionClient(HttpClient, Uri)

Client for interacting with FieldOption collection resources.

public PaginatedFieldOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFieldOptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFieldOptionClient

The current PaginatedFieldOptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFieldOptionClient ClearParameters()

Returns

PaginatedFieldOptionClient

The current PaginatedFieldOptionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFieldOptionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFieldOptionClient

The current PaginatedFieldOptionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FieldOption resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldOptionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFieldOptionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFieldOptionClient

The current PaginatedFieldOptionClient instance.

OrderBySequence()

Sort response items by the Sequence attribute.

public FieldOptionClient OrderBySequence()

Returns

FieldOptionClient

OrderBySequenceDescending()

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

public FieldOptionClient OrderBySequenceDescending()

Returns

FieldOptionClient

OrderByValue()

Sort response items by the Value attribute.

public FieldOptionClient OrderByValue()

Returns

FieldOptionClient

OrderByValueDescending()

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

public FieldOptionClient OrderByValueDescending()

Returns

FieldOptionClient

PerPage(int)

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

public PaginatedFieldOptionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFieldOptionClient

The current PaginatedFieldOptionClient instance.

PostAsync(FieldOption, CancellationToken)

Creates a new FieldOption resource asynchronously.

public Task<FieldOptionResponse> PostAsync(FieldOption resource, CancellationToken cancellationToken = default)

Parameters

resource FieldOption

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldOptionResponse>

A task representing the asynchronous operation, containing the created FieldOption resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FieldOptionResource>, CancellationToken)

Creates a new FieldOption resource asynchronously.

public Task<FieldOptionResponse> PostAsync(JsonApiDocument<FieldOptionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FieldOptionResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldOptionResponse>

A task representing the asynchronous operation, containing the created FieldOption resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereSequence(int)

Query response items by the Sequence attribute.

public FieldOptionClient WhereSequence(int value)

Parameters

value int

Returns

FieldOptionClient

WhereValue(string)

Query response items by the Value attribute.

public FieldOptionClient WhereValue(string value)

Parameters

value string

Returns

FieldOptionClient

WithId(string)

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

public FieldOptionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FieldOptionClient

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