Options
All
  • Public
  • Public/Protected
  • All
Menu

Built in built-in prompts that can be called from any dialog.

Hierarchy

Index

Methods

begin

  • Called when a new dialog session is being started.

    Type parameters

    • T

    Parameters

    • session: CallSession

      Session object for the current conversation.

    • Optional args: T

      (Optional) arguments passed to the dialog by its parent.

    Returns void

dialogResumed

replyReceived

Static action

  • Sends a wrokflow action as a prompt to the user. Lets you process the raw outcome

    Parameters

    Returns void

Static choice

  • Prompts the user to choose from a list of options.

    Parameters

    • session: CallSession

      Session object for the current conversation.

    • playPrompt: string | string[] | IAction | IIsAction
      • playPrompt: {string} - Initial message to send the user.
      • playPrompt: {string[]} - Array of possible messages to send user. One will be chosen at random.
      • playPrompt: {IAction|IIsAction} - Initial PlayPrompt action to send the user.
    • choices: IRecognitionChoice[]

      List of choices to prompt user with.

    • Optional options: IRecognizerPromptOptions

      (Optional) parameters to control the behaviour of the prompt.

    Returns void

Static configure

Static confirm

  • Prompts the user to confirm an action with a yes/no response.

    Parameters

    • session: CallSession

      Session object for the current conversation.

    • playPrompt: string | string[] | IAction | IIsAction
      • playPrompt: {string} - Initial message to send the user.
      • playPrompt: {string[]} - Array of possible messages to send user. One will be chosen at random.
      • playPrompt: {IAction|IIsAction} - Initial PlayPrompt action to send the user.
    • Optional options: IConfirmPromptOptions

      (Optional) parameters to control the behaviour of the prompt.

    Returns void

Static digits

  • Prompts the user to input a sequence of digits.

    Parameters

    • session: CallSession

      Session object for the current conversation.

    • playPrompt: string | string[] | IAction | IIsAction
      • playPrompt: {string} - Initial message to send the user.
      • playPrompt: {string[]} - Array of possible messages to send user. One will be chosen at random.
      • playPrompt: {IAction|IIsAction} - Initial PlayPrompt action to send the user.
    • maxDigits: number

      Maximum number of digits allowed.

    • Optional options: IDigitsPromptOptions

      (Optional) parameters to control the behaviour of the prompt.

    Returns void

Static record

  • Prompts the user to record a message.

    Parameters

    • session: CallSession

      Session object for the current conversation.

    • playPrompt: string | string[] | IAction | IIsAction
      • playPrompt: {string} - Initial message to send the user.
      • playPrompt: {string[]} - Array of possible messages to send user. One will be chosen at random.
      • playPrompt: {IAction|IIsAction} - Initial PlayPrompt action to send the user.
    • Optional options: IRecordPromptOptions

      (Optional) parameters to control the behaviour of the prompt.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method