Class PaginatedFormFieldConditionClient

Namespace

Crews.PlanningCenter.Api.People.V2022_07_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormFieldCondition collection resources.

public class PaginatedFormFieldConditionClient : PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>

Inheritance

object

ResourceClient<FormFieldCondition>

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>

PaginatedFormFieldConditionClient

Inherited Members

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.PerPage(int)

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.Offset(int)

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.Filter(string)

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.PostAsync(FormFieldCondition, CancellationToken)

PaginatedResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionCollectionResponse, FormFieldConditionResponse>.PostAsync(JsonApiDocument<FormFieldConditionResource>, CancellationToken)

ResourceClient<FormFieldCondition>.AddQueryParameter(string, string)

ResourceClient<FormFieldCondition>.ReplaceQueryParameter(string, string)

ResourceClient<FormFieldCondition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormFieldCondition>.Uri

ResourceClient<FormFieldCondition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormFieldConditionClient(HttpClient, Uri)

Client for interacting with FormFieldCondition collection resources.

public PaginatedFormFieldConditionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormFieldConditionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormFieldConditionClient

The current PaginatedFormFieldConditionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormFieldConditionClient ClearParameters()

Returns

PaginatedFormFieldConditionClient

The current PaginatedFormFieldConditionClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormFieldConditionClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormFieldConditionClient

The current PaginatedFormFieldConditionClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FormFieldCondition resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormFieldConditionClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormFieldConditionClient

The current PaginatedFormFieldConditionClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormFieldConditionClient OrderByCreatedAt()

Returns

FormFieldConditionClient

OrderByCreatedAtDescending()

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

public FormFieldConditionClient OrderByCreatedAtDescending()

Returns

FormFieldConditionClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormFieldConditionClient OrderByUpdatedAt()

Returns

FormFieldConditionClient

OrderByUpdatedAtDescending()

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

public FormFieldConditionClient OrderByUpdatedAtDescending()

Returns

FormFieldConditionClient

PerPage(int)

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

public PaginatedFormFieldConditionClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormFieldConditionClient

The current PaginatedFormFieldConditionClient instance.

PostAsync(FormFieldCondition, CancellationToken)

Creates a new FormFieldCondition resource asynchronously.

public Task<FormFieldConditionResponse> PostAsync(FormFieldCondition resource, CancellationToken cancellationToken = default)

Parameters

resource FormFieldCondition

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FormFieldConditionResource>, CancellationToken)

Creates a new FormFieldCondition resource asynchronously.

public Task<FormFieldConditionResponse> PostAsync(JsonApiDocument<FormFieldConditionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FormFieldConditionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public FormFieldConditionClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

FormFieldConditionClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public FormFieldConditionClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

FormFieldConditionClient

WithId(string)

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

public FormFieldConditionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormFieldConditionClient

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