Class FieldDefinitionClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FieldDefinition resource.

public class FieldDefinitionClient : SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>

Inheritance

object

ResourceClient<FieldDefinition>

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>

FieldDefinitionClient

Inherited Members

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>.PatchAsync(FieldDefinition, CancellationToken)

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>.PatchAsync(JsonApiDocument<FieldDefinitionResource>, CancellationToken)

SingletonResourceClient<FieldDefinition, FieldDefinitionResource, FieldDefinitionResponse>.DeleteAsync(CancellationToken)

ResourceClient<FieldDefinition>.AddQueryParameter(string, string)

ResourceClient<FieldDefinition>.ReplaceQueryParameter(string, string)

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

FieldDefinitionClient(HttpClient, Uri)

Client for interacting with the FieldDefinition resource.

public FieldDefinitionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

FieldOptions

Associated FieldOptions.

public PaginatedFieldOptionClient FieldOptions { get; }

Property Value

PaginatedFieldOptionClient

Tab

Associated Tab.

public TabClient Tab { get; }

Property Value

TabClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FieldDefinitionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FieldDefinitionClient

The current FieldDefinitionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FieldDefinitionClient ClearParameters()

Returns

FieldDefinitionClient

The current FieldDefinitionClient instance.

DeleteAsync(CancellationToken)

Deletes the FieldDefinition 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 FieldDefinition resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionResponse>

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

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

PatchAsync(FieldDefinition, CancellationToken)

Updates an existing FieldDefinition resource asynchronously.

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

Parameters

resource FieldDefinition

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FieldDefinitionResource>, CancellationToken)

Updates an existing FieldDefinition resource asynchronously.

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

Parameters

document JsonApiDocument<FieldDefinitionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FieldDefinitionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.