Class FormFieldOptionClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormFieldOption resource.

public class FormFieldOptionClient : SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>

Inheritance

object

ResourceClient<FormFieldOption>

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>

FormFieldOptionClient

Inherited Members

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>.PatchAsync(FormFieldOption, CancellationToken)

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>.PatchAsync(JsonApiDocument<FormFieldOptionResource>, CancellationToken)

SingletonResourceClient<FormFieldOption, FormFieldOptionResource, FormFieldOptionResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormFieldOption>.AddQueryParameter(string, string)

ResourceClient<FormFieldOption>.ReplaceQueryParameter(string, string)

ResourceClient<FormFieldOption>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormFieldOption>.Uri

ResourceClient<FormFieldOption>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormFieldOptionClient(HttpClient, Uri)

Client for interacting with the FormFieldOption resource.

public FormFieldOptionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormFieldOptionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormFieldOptionClient

The current FormFieldOptionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormFieldOptionClient ClearParameters()

Returns

FormFieldOptionClient

The current FormFieldOptionClient instance.

GetAsync(CancellationToken)

Fetches the FormFieldOption resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldOptionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.