Rate this page:

AvatarFormStateParameter

Parameters of the addFormState method that registers a new dialogue form state for an avatar.

Props

append

Copy URL
append: 

false

|

undefined

|

true

Optional. Whether to append the value to the list. The default value is false.

attempts

Copy URL
attempts: 

number

|

undefined

Optional. Number of attempts to fill the form. The default value is 3.

channelParameters

Copy URL
channelParameters: 

ChannelParameters

Optional. Avatar text and voice channel parameters.

entity

Copy URL
entity: 

string

Parameter's entity.

list

Copy URL
list: 

false

|

undefined

|

true

Optional. Whether the form can have a list of values. The default value is false.

name

Copy URL
name: 

string

Parameter's name.

prompts

Copy URL
prompts: 

string[]

Optional. List of utterances to ask the customer in order to fill the form.

required

Copy URL
required: 

false

|

undefined

|

true

Optional. Whether the parameter is required. The default value is false.

value

Copy URL
value: 

any

Parameter's value.