Class FormSubmissionClient

Namespace

Crews.PlanningCenter.Api.People.V2021_08_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormSubmission resource.

public class FormSubmissionClient : SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>

Inheritance

object

ResourceClient<FormSubmission>

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>

FormSubmissionClient

Inherited Members

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>.PatchAsync(FormSubmission, CancellationToken)

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>.PatchAsync(JsonApiDocument<FormSubmissionResource>, CancellationToken)

SingletonResourceClient<FormSubmission, FormSubmissionResource, FormSubmissionResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormSubmission>.AddQueryParameter(string, string)

ResourceClient<FormSubmission>.ReplaceQueryParameter(string, string)

ResourceClient<FormSubmission>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormSubmission>.Uri

ResourceClient<FormSubmission>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormSubmissionClient(HttpClient, Uri)

Client for interacting with the FormSubmission resource.

public FormSubmissionClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Form

Associated Form.

public FormClient Form { get; }

Property Value

FormClient

FormFields

Associated FormFields.

public PaginatedFormFieldClient FormFields { get; }

Property Value

PaginatedFormFieldClient

FormSubmissionValues

Associated FormSubmissionValues.

public PaginatedFormSubmissionValueClient FormSubmissionValues { get; }

Property Value

PaginatedFormSubmissionValueClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormSubmissionClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormSubmissionClient

The current FormSubmissionClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormSubmissionClient ClearParameters()

Returns

FormSubmissionClient

The current FormSubmissionClient instance.

GetAsync(CancellationToken)

Fetches the FormSubmission resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormSubmissionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeForm()

Include related Form resources in the response.

public FormSubmissionClient IncludeForm()

Returns

FormSubmissionClient

IncludeFormFields()

Include related FormFields resources in the response.

public FormSubmissionClient IncludeFormFields()

Returns

FormSubmissionClient

IncludeFormSubmissionValues()

Include related FormSubmissionValues resources in the response.

public FormSubmissionClient IncludeFormSubmissionValues()

Returns

FormSubmissionClient

IncludePerson()

Include related Person resources in the response.

public FormSubmissionClient IncludePerson()

Returns

FormSubmissionClient