Class FormFieldClient

Namespace

Crews.PlanningCenter.Api.People.V2019_10_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormField resource.

public class FormFieldClient : SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>

Inheritance

object

ResourceClient<FormField>

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>

FormFieldClient

Inherited Members

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>.PatchAsync(FormField, CancellationToken)

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>.PatchAsync(JsonApiDocument<FormFieldResource>, CancellationToken)

SingletonResourceClient<FormField, FormFieldResource, FormFieldResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormField>.AddQueryParameter(string, string)

ResourceClient<FormField>.ReplaceQueryParameter(string, string)

ResourceClient<FormField>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormField>.Uri

ResourceClient<FormField>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormFieldClient(HttpClient, Uri)

Client for interacting with the FormField resource.

public FormFieldClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Options

Associated Options.

public PaginatedFormFieldOptionClient Options { get; }

Property Value

PaginatedFormFieldOptionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormFieldClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormFieldClient

The current FormFieldClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormFieldClient ClearParameters()

Returns

FormFieldClient

The current FormFieldClient instance.

GetAsync(CancellationToken)

Fetches the FormField resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormFieldResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOptions()

Include related Options resources in the response.

public FormFieldClient IncludeOptions()

Returns

FormFieldClient