Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "botbuilder.d"

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

AttachmentType

AttachmentType: IAttachment | IIsAttachment

Some methods can take either an IAttachment in JSON form or one the various card builder classes that implement IIsAttachment.

MatchType

MatchType: RegExp | string | string | RegExp

Supported rules for matching a users utterance.

  • {RegExp} - A regular expression will be used to match the users utterance.
  • {string} - A named intent returned from a recognizer will be used to match the users utterance.
  • {(RegExp|string)[]} - An array of either regular expressions or named intents can be passed to match the users utterance in a number of possible ways. The rule generating the highest score (best match) will be used for scoring purposes.

MessageType

MessageType: IMessage | IIsMessage

Message based prompts that can be sent to a user.

  • {IMessage} - Message to send the user expressed using JSON. The message can contain attachments and suggested actions. Not all channels natively support all message properties but most channels will down render unsupported fields.
  • {IIsMessage} - An instance of the Message builder class. This class helps to localize your messages and provides helpers to aid with formatting the text portions of your message.

TextOrMessageType

TextOrMessageType: string | string[] | IMessage | IIsMessage

Flexible range of possible prompts that can be sent to a user.

  • {string} - A simple message to send the user.
  • {string[]} - Array of possible messages to send the user. One will be chosen at random.
  • {IMessage} - Message to send the user expressed using JSON. The message can contain attachments and suggested actions. Not all channels natively support all message properties but most channels will down render unsupported fields.
  • {IIsMessage} - An instance of the Message builder class. This class helps to localize your messages and provides helpers to aid with formatting the text portions of your message.

TextType

TextType: string | string[]

Text based prompts that can be sent to a user.

  • {string} - A simple message to send the user.
  • {string[]} - Array of possible messages to send the user. One will be chosen at random.

ValueListType

ValueListType: string | string[]

List of text values. The values can be expressed as a pipe delimited string like "value1|value2|value3" or simple array of values.

Variables

AttachmentLayout

AttachmentLayout: object

Identities how the client should render attachments for a message.

Type declaration

  • carousel: string

    Attachments should be rendered as a carousel.

  • list: string

    Attachments should be rendred as a list.

InputHint

InputHint: object

Indicates whether the bot is accepting, expecting, or ignoring input.

Type declaration

  • acceptingInput: string

    The sender is passively ready for input but is not waiting on a response.

  • expectingInput: string

    The sender is actively expecting a response from the user.

  • ignoringInput: string

    The sender is ignoring input. Bots may send this hint if they are actively processing a request and will ignore input from users until the request is complete.

Prompts

Prompts: IPrompts

Provides global access to the SDK's built-in prompts. New prompts can be added by simply adding a new function using builder.Prompts.myPrompt = function (session, prompt, options) { }. If you are using TypeScript you will first want to add the signature for your prompt to the IPrompts interface using interface decleration merging.

example

declare global {
     interface IPrompts {
          myPrompt(session: Session, prompt: string, options?: IPromptOptions): void;
     }


}
builder.Prompts.disambiguate(session, "What would you like to cancel?", {
     "Cancel Item": cancelItemRoute,
     "Cancel Order": cancelOrderRoute,
     "Neither": null
});

TextFormat

TextFormat: object

Identifies the type of text being sent in a message.

Type declaration

  • markdown: string

    Text fields may contain markdown formatting information.

  • plain: string

    Text fields should be treated as plain text.

  • xml: string

    Text fields may contain xml formatting information.

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