Search
Preparing search index...
The search index is not available
ask-form-sdk
Options
All
Public
Public/Protected
All
Inherited
Menu
ask-form-sdk
form-intent-handler
FormIntentHandler
Class FormIntentHandler
Hierarchy
FormIntentHandler
Implements
FormRequestHandler
Index
Constructors
constructor
Properties
form
user
Handler
Methods
can
Handle
clear
Matches
clear
Slot
Name
create
Final
Form
Page
Render
Directive
create
Render
Directive
elicit
Slot
Confirmation
elicit
Slot
Response
get
Confirmation
Prompt
get
Elicit
Slots
get
Empty
Decimal
Slots
get
Next
Slot
Number
get
Previous
Slot
Number
With
Value
get
Prompt
Prefix
get
Slot
Validation
handle
handle
Form
Review
handle
Next
handle
Previous
handle
User
Event
handle
With
Slots
is
Current
supportsAPL
Constructors
constructor
new
Form
Intent
Handler
(
form
:
FormProps
, userHandler
:
UserHandler
)
:
FormIntentHandler
Parameters
form:
FormProps
userHandler:
UserHandler
Returns
FormIntentHandler
Properties
Private
form
form
:
FormProps
Private
user
Handler
user
Handler
:
UserHandler
Methods
can
Handle
can
Handle
(
handlerInput
:
HandlerInput
)
:
boolean
|
Promise
<
boolean
>
Parameters
handlerInput:
HandlerInput
Returns
boolean
|
Promise
<
boolean
>
Private
clear
Matches
clear
Matches
(
sessionAttributes
:
SessionProps
)
:
void
Private methods
Parameters
sessionAttributes:
SessionProps
Returns
void
Private
clear
Slot
Name
clear
Slot
Name
(
sessionAttributes
:
SessionProps
)
:
void
Parameters
sessionAttributes:
SessionProps
Returns
void
Private
create
Final
Form
Page
Render
Directive
create
Final
Form
Page
Render
Directive
(
slotValues
:
SlotValues
, aplTemplateName
:
string
)
:
Directive
Parameters
slotValues:
SlotValues
aplTemplateName:
string
Returns
Directive
Private
create
Render
Directive
create
Render
Directive
(
aplTemplateName
:
string
, slotValues
:
SlotValues
, slotNumber
:
number
, targetSlot
?:
FormSlotProps
, prompt
?:
string
)
:
Directive
Parameters
aplTemplateName:
string
slotValues:
SlotValues
slotNumber:
number
Optional
targetSlot:
FormSlotProps
Optional
prompt:
string
Returns
Directive
Private
elicit
Slot
Confirmation
elicit
Slot
Confirmation
(
handlerInput
:
HandlerInput
, targetIntent
:
string
, targetSlot
:
FormSlotProps
, slots
:
IntentSlots
, prompt
:
string
)
:
Response
Parameters
handlerInput:
HandlerInput
targetIntent:
string
targetSlot:
FormSlotProps
slots:
IntentSlots
prompt:
string
Returns
Response
Private
elicit
Slot
Response
elicit
Slot
Response
(
handlerInput
:
HandlerInput
, targetIntent
:
string
, targetSlot
:
FormSlotProps
, slots
:
IntentSlots
, prompt
:
string
, slotNumber
:
number
, slotValues
:
SlotValues
, aplTemplate
?:
string
)
:
Response
Parameters
handlerInput:
HandlerInput
targetIntent:
string
targetSlot:
FormSlotProps
slots:
IntentSlots
prompt:
string
slotNumber:
number
slotValues:
SlotValues
Optional
aplTemplate:
string
Returns
Response
Private
get
Confirmation
Prompt
get
Confirmation
Prompt
(
slot
:
FormSlotProps
, value
:
string
, index
?:
number
, count
?:
number
)
:
string
Parameters
slot:
FormSlotProps
value:
string
Optional
index:
number
Optional
count:
number
Returns
string
Private
get
Elicit
Slots
get
Elicit
Slots
(
slotValues
:
SlotValues
)
:
IntentSlots
Parameters
slotValues:
SlotValues
Returns
IntentSlots
Private
get
Empty
Decimal
Slots
get
Empty
Decimal
Slots
(
)
:
IntentSlots
Returns
IntentSlots
Private
get
Next
Slot
Number
get
Next
Slot
Number
(
slotNumber
:
number
, slotValues
:
SlotValues
)
:
number
Parameters
slotNumber:
number
slotValues:
SlotValues
Returns
number
Private
get
Previous
Slot
Number
With
Value
get
Previous
Slot
Number
With
Value
(
slotNumber
:
number
, slotValues
:
SlotValues
)
:
number
Parameters
slotNumber:
number
slotValues:
SlotValues
Returns
number
Private
get
Prompt
Prefix
get
Prompt
Prefix
(
slotNumber
:
number
)
:
string
Parameters
slotNumber:
number
Returns
string
Private
get
Slot
Validation
get
Slot
Validation
(
__namedParameters
:
{
slot
:
FormSlotProps
;
user
:
UserProps
;
value
:
string
}
)
:
string
Parameters
__namedParameters:
{
slot
:
FormSlotProps
;
user
:
UserProps
;
value
:
string
}
slot
:
FormSlotProps
user
:
UserProps
value
:
string
Returns
string
handle
handle
(
handlerInput
:
HandlerInput
)
:
Promise
<
Response
>
Parameters
handlerInput:
HandlerInput
Returns
Promise
<
Response
>
handle
Form
Review
handle
Form
Review
(
handlerInput
:
HandlerInput
)
:
Response
Parameters
handlerInput:
HandlerInput
Returns
Response
handle
Next
handle
Next
(
handlerInput
:
HandlerInput
)
:
Promise
<
Response
>
Parameters
handlerInput:
HandlerInput
Returns
Promise
<
Response
>
handle
Previous
handle
Previous
(
handlerInput
:
HandlerInput
)
:
Promise
<
Response
>
Parameters
handlerInput:
HandlerInput
Returns
Promise
<
Response
>
handle
User
Event
handle
User
Event
(
handlerInput
:
HandlerInput
)
:
Promise
<
Response
>
Parameters
handlerInput:
HandlerInput
Returns
Promise
<
Response
>
handle
With
Slots
handle
With
Slots
(
handlerInput
:
HandlerInput
, slots
:
Slot
[]
)
:
Promise
<
Response
>
Parameters
handlerInput:
HandlerInput
slots:
Slot
[]
Returns
Promise
<
Response
>
is
Current
is
Current
(
handlerInput
:
HandlerInput
)
:
boolean
Parameters
handlerInput:
HandlerInput
Returns
boolean
Private
supportsAPL
supportsAPL
(
handlerInput
:
HandlerInput
)
:
AlexaPresentationAplInterface
Parameters
handlerInput:
HandlerInput
Returns
AlexaPresentationAplInterface
Exports
apl-
templates
apl-
templates/apl-
template-
type
apl-
templates/text-
list-
with-
touch
codegen
codegen/base-
model
codegen/model-
codegen
codegen/model-
types
decimal-
intent-
handler
form-
handler-
types
form-
intent-
handler
form-
list-
handler
form-
types
form-
validation
index
Form
Intent
Handler
constructor
form
user
Handler
can
Handle
clear
Matches
clear
Slot
Name
create
Final
Form
Page
Render
Directive
create
Render
Directive
elicit
Slot
Confirmation
elicit
Slot
Response
get
Confirmation
Prompt
get
Elicit
Slots
get
Empty
Decimal
Slots
get
Next
Slot
Number
get
Previous
Slot
Number
With
Value
get
Prompt
Prefix
get
Slot
Validation
handle
handle
Form
Review
handle
Next
handle
Previous
handle
User
Event
handle
With
Slots
is
Current
supportsAPL
Generated using
TypeDoc
Private methods