Class PaginatedFieldDatumClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with FieldDatum collection resources.

public class PaginatedFieldDatumClient : PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>

Inheritance

object

ResourceClient<FieldDatum>

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>

PaginatedFieldDatumClient

Inherited Members

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.PerPage(int)

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.Offset(int)

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.Filter(string)

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.PostAsync(FieldDatum, CancellationToken)

PaginatedResourceClient<FieldDatum, FieldDatumResource, FieldDatumCollectionResponse, FieldDatumResponse>.PostAsync(JsonApiDocument<FieldDatumResource>, CancellationToken)

ResourceClient<FieldDatum>.AddQueryParameter(string, string)

ResourceClient<FieldDatum>.ReplaceQueryParameter(string, string)

ResourceClient<FieldDatum>.AddCustomParameter(string, string)

ResourceClient<FieldDatum>.ClearParameters()

ResourceClient<FieldDatum>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FieldDatum>.Uri

ResourceClient<FieldDatum>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedFieldDatumClient(HttpClient, Uri)

Client for interacting with FieldDatum collection resources.

public PaginatedFieldDatumClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of FieldDatum resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeFieldDefinition()

Include related FieldDefinition resources in the response.

public FieldDatumClient IncludeFieldDefinition()

Returns

FieldDatumClient

IncludeFieldOption()

Include related FieldOption resources in the response.

public FieldDatumClient IncludeFieldOption()

Returns

FieldDatumClient

IncludeTab()

Include related Tab resources in the response.

public FieldDatumClient IncludeTab()

Returns

FieldDatumClient

OrderByFile()

Sort response items by the File attribute.

public FieldDatumClient OrderByFile()

Returns

FieldDatumClient

OrderByFileContentType()

Sort response items by the FileContentType attribute.

public FieldDatumClient OrderByFileContentType()

Returns

FieldDatumClient

OrderByFileContentTypeDescending()

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

public FieldDatumClient OrderByFileContentTypeDescending()

Returns

FieldDatumClient

OrderByFileDescending()

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

public FieldDatumClient OrderByFileDescending()

Returns

FieldDatumClient

OrderByFileName()

Sort response items by the FileName attribute.

public FieldDatumClient OrderByFileName()

Returns

FieldDatumClient

OrderByFileNameDescending()

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

public FieldDatumClient OrderByFileNameDescending()

Returns

FieldDatumClient

OrderByFileSize()

Sort response items by the FileSize attribute.

public FieldDatumClient OrderByFileSize()

Returns

FieldDatumClient

OrderByFileSizeDescending()

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

public FieldDatumClient OrderByFileSizeDescending()

Returns

FieldDatumClient

OrderByValue()

Sort response items by the Value attribute.

public FieldDatumClient OrderByValue()

Returns

FieldDatumClient

OrderByValueDescending()

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

public FieldDatumClient OrderByValueDescending()

Returns

FieldDatumClient

PostAsync(FieldDatum, CancellationToken)

Creates a new FieldDatum resource asynchronously.

public Task<FieldDatumResponse> PostAsync(FieldDatum resource, CancellationToken cancellationToken = default)

Parameters

resource FieldDatum

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<FieldDatumResource>, CancellationToken)

Creates a new FieldDatum resource asynchronously.

public Task<FieldDatumResponse> PostAsync(JsonApiDocument<FieldDatumResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FieldDatumResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WhereFieldDefinitionId(int)

Query response items by the FieldDefinitionId attribute.

public FieldDatumClient WhereFieldDefinitionId(int value)

Parameters

value int

Returns

FieldDatumClient

WhereFile(string)

Query response items by the File attribute.

public FieldDatumClient WhereFile(string value)

Parameters

value string

Returns

FieldDatumClient

WhereFileContentType(string)

Query response items by the FileContentType attribute.

public FieldDatumClient WhereFileContentType(string value)

Parameters

value string

Returns

FieldDatumClient

WhereFileName(string)

Query response items by the FileName attribute.

public FieldDatumClient WhereFileName(string value)

Parameters

value string

Returns

FieldDatumClient

WhereFileSize(int)

Query response items by the FileSize attribute.

public FieldDatumClient WhereFileSize(int value)

Parameters

value int

Returns

FieldDatumClient

WhereValue(string)

Query response items by the Value attribute.

public FieldDatumClient WhereValue(string value)

Parameters

value string

Returns

FieldDatumClient

WithId(string)

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

public FieldDatumClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

FieldDatumClient

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