Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMessageOptions

Optional message properties that can be sent to things like prompts or session.say().

example

session.say("Please wait...", "Please wait", {
    inputHint: builder.InputHint.ignoringInput
});

Hierarchy

  • IMessageOptions

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 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 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