Class FieldDatumClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FieldDatum resource.

public class FieldDatumClient : SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>

Inheritance

object

ResourceClient<FieldDatum>

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>

FieldDatumClient

Inherited Members

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>.PatchAsync(FieldDatum, CancellationToken)

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>.PatchAsync(JsonApiDocument<FieldDatumResource>, CancellationToken)

SingletonResourceClient<FieldDatum, FieldDatumResource, FieldDatumResponse>.DeleteAsync(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

FieldDatumClient(HttpClient, Uri)

Client for interacting with the FieldDatum resource.

public FieldDatumClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

FieldDefinition

Associated FieldDefinition.

public FieldDefinitionClient FieldDefinition { get; }

Property Value

FieldDefinitionClient

FieldOption

Associated FieldOption.

public FieldOptionClient FieldOption { get; }

Property Value

FieldOptionClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Tab

Associated Tab.

public TabClient Tab { get; }

Property Value

TabClient

Methods

DeleteAsync(CancellationToken)

Deletes the FieldDatum resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the FieldDatum resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumResponse>

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

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

PatchAsync(FieldDatum, CancellationToken)

Updates an existing FieldDatum resource asynchronously.

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

Parameters

resource FieldDatum

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FieldDatumResource>, CancellationToken)

Updates an existing FieldDatum resource asynchronously.

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

Parameters

document JsonApiDocument<FieldDatumResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDatumResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.