Class FormSubmissionValueClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormSubmissionValue resource.

public class FormSubmissionValueClient : SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>

Inheritance

object

ResourceClient<FormSubmissionValue>

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>

FormSubmissionValueClient

Inherited Members

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>.PatchAsync(FormSubmissionValue, CancellationToken)

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>.PatchAsync(JsonApiDocument<FormSubmissionValueResource>, CancellationToken)

SingletonResourceClient<FormSubmissionValue, FormSubmissionValueResource, FormSubmissionValueResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormSubmissionValue>.AddQueryParameter(string, string)

ResourceClient<FormSubmissionValue>.ReplaceQueryParameter(string, string)

ResourceClient<FormSubmissionValue>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormSubmissionValue>.Uri

ResourceClient<FormSubmissionValue>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormSubmissionValueClient(HttpClient, Uri)

Client for interacting with the FormSubmissionValue resource.

public FormSubmissionValueClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormSubmissionValueClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormSubmissionValueClient

The current FormSubmissionValueClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormSubmissionValueClient ClearParameters()

Returns

FormSubmissionValueClient

The current FormSubmissionValueClient instance.

GetAsync(CancellationToken)

Fetches the FormSubmissionValue resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormSubmissionValueResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.