Class Form

Description

Represents a form.

Hierarchy

  • Form

Properties

answers? fields formKey key messageId

Accessors

isSubmittable isSubmitted

Methods

getFieldAnswer

Properties

Optional answers

answers?: FormAnswers

The submitted answer to this form field. null if it is not submitted yet.

fields

fields: FormField[]

A set of fields representing a single question and its corresponding response.

formKey

formKey: string

Deprecated

The key of the form. Use key instead.

Readonly key

key: string

The key of the form.

Readonly messageId

messageId: number

The ID of the message to which the corresponding form belongs.

Accessors

isSubmittable

  • get isSubmittable(): boolean

  • Whether this form is submittable or not.

    Returns boolean

isSubmitted

  • get isSubmitted(): boolean

  • Whether this form is submitted or not.

    Returns boolean

Methods

getFieldAnswer

  • Parameters

    • key: string

    Returns undefined | string

    Description

    Gets a field answer for the key.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc