Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPromptAttachmentOptions

Options passed to Prompts.attachment() or in a session.beginDialog() call to a custom prompt based on the PromptAttachment class.

Hierarchy

Index

Properties

Optional attachmentLayout

attachmentLayout: string

Hint for how clients should layout multiple attachments. The default value is 'list'.

Optional attachments

attachments: IAttachment[]

For incoming messages contains attachments like images sent from the user. For outgoing messages contains objects like cards or images to send to the user.

Optional contentTypes

contentTypes: string | string[]

(Optional) list of content types the prompt is waiting for. Types ending with '*' will be prefixed matched again the received attachment(s).

Optional entities

entities: any[]

Structured objects passed to the bot or user.

Optional inputHint

inputHint: string

Hint for clients letting them know if the bot is expecting further input or not. The built-in prompts will automatically populate this value for outgoing messages.

Optional libraryNamespace

libraryNamespace: string

(Optional) namespace to use for localization and other purposes. This defaults to the callers namespace.

Optional listStyle

listStyle: ListStyle

(Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto.

Optional localizationNamespace

localizationNamespace: string

DEPRECATED use libraryNamespace instead.

Optional maxRetries

maxRetries: number

(Optional) maximum number of times to re-prompt the user. By default the user will be re-prompted indefinitely.

Optional prompt

(Optional) Initial prompt to send the user. This is typically populated by the Prompts.xxx() function.

Optional promptAfterAction

promptAfterAction: boolean

(Optional) flag used to control the re-prompting of a user after a dialog started by an action ends. The default value is true.

Optional refDate

refDate: number

(Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime().

Optional retryPrompt

retryPrompt: TextOrMessageType

(Optional) retry prompt to send if the users response isn't understood. Default is to just re-prompt with a customizable system prompt.

Optional retrySpeak

retrySpeak: TextType

(Optional) SSML to send with the retryPrompt. If the retryPrompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.

Optional speak

speak: TextType

(Optional) SSML to send with the initial prompt. If the prompt is of type IMessage or IIsMessage, this value will be ignored. If this value is an array a response will be chosen at random.

Optional textFormat

textFormat: string

Format of text fields. The default value is 'markdown'.

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