Class FormFieldConditionClient

Namespace

Crews.PlanningCenter.Api.People.V2022_07_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormFieldCondition resource.

public class FormFieldConditionClient : SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>

Inheritance

object

ResourceClient<FormFieldCondition>

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>

FormFieldConditionClient

Inherited Members

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>.PatchAsync(FormFieldCondition, CancellationToken)

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>.PatchAsync(JsonApiDocument<FormFieldConditionResource>, CancellationToken)

SingletonResourceClient<FormFieldCondition, FormFieldConditionResource, FormFieldConditionResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormFieldCondition>.AddQueryParameter(string, string)

ResourceClient<FormFieldCondition>.ReplaceQueryParameter(string, string)

ResourceClient<FormFieldCondition>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormFieldCondition>.Uri

ResourceClient<FormFieldCondition>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormFieldConditionClient(HttpClient, Uri)

Client for interacting with the FormFieldCondition resource.

public FormFieldConditionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormFieldConditionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormFieldConditionClient

The current FormFieldConditionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormFieldConditionClient ClearParameters()

Returns

FormFieldConditionClient

The current FormFieldConditionClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(FormFieldCondition, CancellationToken)

Updates an existing FormFieldCondition resource asynchronously.

public Task<FormFieldConditionResponse> PatchAsync(FormFieldCondition resource, CancellationToken cancellationToken = default)

Parameters

resource FormFieldCondition

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FormFieldConditionResource>, CancellationToken)

Updates an existing FormFieldCondition resource asynchronously.

public Task<FormFieldConditionResponse> PatchAsync(JsonApiDocument<FormFieldConditionResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FormFieldConditionResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldConditionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.