Class PaginatedFieldDefinitionClient

Namespace

Crews.PlanningCenter.Api.People.V2025_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FieldDefinition collection resources.

public class PaginatedFieldDefinitionClient : PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>

Inheritance

object

ResourceClient<FieldDefinition>

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>

PaginatedFieldDefinitionClient

Inherited Members

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.PerPage(int)

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.Offset(int)

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.Filter(string)

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.PostAsync(FieldDefinition, CancellationToken)

PaginatedResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionCollectionResponse, FieldDefinitionResponse>.PostAsync(JsonApiDocument<FieldDefinitionResource>, CancellationToken)

ResourceClient<FieldDefinition>.AddQueryParameter(string, string)

ResourceClient<FieldDefinition>.ReplaceQueryParameter(string, string)

ResourceClient<FieldDefinition>.AddCustomParameter(string, string)

ResourceClient<FieldDefinition>.ClearParameters()

ResourceClient<FieldDefinition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FieldDefinition>.Uri

ResourceClient<FieldDefinition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFieldDefinitionClient(HttpClient, Uri)

Client for interacting with FieldDefinition collection resources.

public PaginatedFieldDefinitionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of FieldDefinition resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFieldOptions()

Include related FieldOptions resources in the response.

public FieldDefinitionClient IncludeFieldOptions()

Returns

FieldDefinitionClient

IncludeTab()

Include related Tab resources in the response.

public FieldDefinitionClient IncludeTab()

Returns

FieldDefinitionClient

OrderByConfig()

Sort response items by the Config attribute.

public FieldDefinitionClient OrderByConfig()

Returns

FieldDefinitionClient

OrderByConfigDescending()

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

public FieldDefinitionClient OrderByConfigDescending()

Returns

FieldDefinitionClient

OrderByDataType()

Sort response items by the DataType attribute.

public FieldDefinitionClient OrderByDataType()

Returns

FieldDefinitionClient

OrderByDataTypeDescending()

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

public FieldDefinitionClient OrderByDataTypeDescending()

Returns

FieldDefinitionClient

OrderByDeletedAt()

Sort response items by the DeletedAt attribute.

public FieldDefinitionClient OrderByDeletedAt()

Returns

FieldDefinitionClient

OrderByDeletedAtDescending()

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

public FieldDefinitionClient OrderByDeletedAtDescending()

Returns

FieldDefinitionClient

OrderByName()

Sort response items by the Name attribute.

public FieldDefinitionClient OrderByName()

Returns

FieldDefinitionClient

OrderByNameDescending()

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

public FieldDefinitionClient OrderByNameDescending()

Returns

FieldDefinitionClient

OrderBySequence()

Sort response items by the Sequence attribute.

public FieldDefinitionClient OrderBySequence()

Returns

FieldDefinitionClient

OrderBySequenceDescending()

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

public FieldDefinitionClient OrderBySequenceDescending()

Returns

FieldDefinitionClient

OrderBySlug()

Sort response items by the Slug attribute.

public FieldDefinitionClient OrderBySlug()

Returns

FieldDefinitionClient

OrderBySlugDescending()

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

public FieldDefinitionClient OrderBySlugDescending()

Returns

FieldDefinitionClient

OrderByTabId()

Sort response items by the TabId attribute.

public FieldDefinitionClient OrderByTabId()

Returns

FieldDefinitionClient

OrderByTabIdDescending()

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

public FieldDefinitionClient OrderByTabIdDescending()

Returns

FieldDefinitionClient

PostAsync(FieldDefinition, CancellationToken)

Creates a new FieldDefinition resource asynchronously.

public Task<FieldDefinitionResponse> PostAsync(FieldDefinition resource, CancellationToken cancellationToken = default)

Parameters

resource FieldDefinition

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FieldDefinitionResource>, CancellationToken)

Creates a new FieldDefinition resource asynchronously.

public Task<FieldDefinitionResponse> PostAsync(JsonApiDocument<FieldDefinitionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FieldDefinitionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereConfig(string)

Query response items by the Config attribute.

public FieldDefinitionClient WhereConfig(string value)

Parameters

value string

Returns

FieldDefinitionClient

WhereDataType(string)

Query response items by the DataType attribute.

public FieldDefinitionClient WhereDataType(string value)

Parameters

value string

Returns

FieldDefinitionClient

WhereDeletedAt(DateTime)

Query response items by the DeletedAt attribute.

public FieldDefinitionClient WhereDeletedAt(DateTime value)

Parameters

value DateTime

Returns

FieldDefinitionClient

WhereName(string)

Query response items by the Name attribute.

public FieldDefinitionClient WhereName(string value)

Parameters

value string

Returns

FieldDefinitionClient

WhereSequence(int)

Query response items by the Sequence attribute.

public FieldDefinitionClient WhereSequence(int value)

Parameters

value int

Returns

FieldDefinitionClient

WhereSlug(string)

Query response items by the Slug attribute.

public FieldDefinitionClient WhereSlug(string value)

Parameters

value string

Returns

FieldDefinitionClient

WhereTabId(string)

Query response items by the TabId attribute.

public FieldDefinitionClient WhereTabId(string value)

Parameters

value string

Returns

FieldDefinitionClient

WithId(string)

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

public FieldDefinitionClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FieldDefinitionClient

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