Class PaginatedFormFieldClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FormField collection resources.

public class PaginatedFormFieldClient : PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>

Inheritance

object

ResourceClient<FormField>

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>

PaginatedFormFieldClient

Inherited Members

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.PerPage(int)

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.Offset(int)

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.Filter(string)

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.PostAsync(FormField, CancellationToken)

PaginatedResourceClient<FormField, FormFieldResource, FormFieldCollectionResponse, FormFieldResponse>.PostAsync(JsonApiDocument<FormFieldResource>, CancellationToken)

ResourceClient<FormField>.AddQueryParameter(string, string)

ResourceClient<FormField>.ReplaceQueryParameter(string, string)

ResourceClient<FormField>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormField>.Uri

ResourceClient<FormField>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFormFieldClient(HttpClient, Uri)

Client for interacting with FormField collection resources.

public PaginatedFormFieldClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedFormFieldClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedFormFieldClient

The current PaginatedFormFieldClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedFormFieldClient ClearParameters()

Returns

PaginatedFormFieldClient

The current PaginatedFormFieldClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedFormFieldClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedFormFieldClient

The current PaginatedFormFieldClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of FormField resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOptions()

Include related Options resources in the response.

public FormFieldClient IncludeOptions()

Returns

FormFieldClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedFormFieldClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedFormFieldClient

The current PaginatedFormFieldClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public FormFieldClient OrderByCreatedAt()

Returns

FormFieldClient

OrderByCreatedAtDescending()

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

public FormFieldClient OrderByCreatedAtDescending()

Returns

FormFieldClient

OrderBySequence()

Sort response items by the Sequence attribute.

public FormFieldClient OrderBySequence()

Returns

FormFieldClient

OrderBySequenceDescending()

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

public FormFieldClient OrderBySequenceDescending()

Returns

FormFieldClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public FormFieldClient OrderByUpdatedAt()

Returns

FormFieldClient

OrderByUpdatedAtDescending()

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

public FormFieldClient OrderByUpdatedAtDescending()

Returns

FormFieldClient

PerPage(int)

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

public PaginatedFormFieldClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedFormFieldClient

The current PaginatedFormFieldClient instance.

WithId(string)

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

public FormFieldClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FormFieldClient

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