Class FormClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Form resource.

public class FormClient : SingletonResourceClient<Form, FormResource, FormResponse>

Inheritance

object

ResourceClient<Form>

SingletonResourceClient<Form, FormResource, FormResponse>

FormClient

Inherited Members

SingletonResourceClient<Form, FormResource, FormResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Form, FormResource, FormResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Form, FormResource, FormResponse>.PatchAsync(Form, CancellationToken)

SingletonResourceClient<Form, FormResource, FormResponse>.PatchAsync(JsonApiDocument<FormResource>, CancellationToken)

SingletonResourceClient<Form, FormResource, FormResponse>.DeleteAsync(CancellationToken)

ResourceClient<Form>.AddQueryParameter(string, string)

ResourceClient<Form>.ReplaceQueryParameter(string, string)

ResourceClient<Form>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Form>.Uri

ResourceClient<Form>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormClient(HttpClient, Uri)

Client for interacting with the Form resource.

public FormClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Campus

Associated Campus.

public PaginatedCampusClient Campus { get; }

Property Value

PaginatedCampusClient

Category

Associated Category.

public FormCategoryClient Category { get; }

Property Value

FormCategoryClient

Fields

Associated Fields.

public PaginatedFormFieldClient Fields { get; }

Property Value

PaginatedFormFieldClient

FormSubmissions

Associated FormSubmissions.

public PaginatedFormSubmissionClient FormSubmissions { get; }

Property Value

PaginatedFormSubmissionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormClient

The current FormClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormClient ClearParameters()

Returns

FormClient

The current FormClient instance.

GetAsync(CancellationToken)

Fetches the Form resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCampus()

Include related Campus resources in the response.

public FormClient IncludeCampus()

Returns

FormClient

IncludeCategory()

Include related Category resources in the response.

public FormClient IncludeCategory()

Returns

FormClient