Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFindActionRouteContext

Context passed to ActionSet.findActionRoutes().

Hierarchy

Index

Properties

conversationData

conversationData: any

Shared conversation data that's visible to all members of the conversation.

dialogData

dialogData: any

Data for the active dialog.

Optional intent

(Optional) The top intent identified for the message.

Optional libraryName

libraryName: string

(Optional) The name of the library passing the context is from.

locale

locale: string

DEPRECATED use preferredLocale() instead.

localizer

localizer: ILocalizer

The localizer for the session.

logger

The current session logger.

message

message: IMessage

The message received from the user. For bot originated messages this may only contain the "to" & "from" fields.

privateConversationData

privateConversationData: any

Private conversation data that's only visible to the user.

routeType

routeType: string

The type of route being searched for.

userData

userData: any

Data for the user that's persisted across all conversations with the bot.

Methods

dialogStack

gettext

  • gettext(msgid: string, ...args: any[]): string
  • Loads a localized string for the messages language. If arguments are passed the localized string will be treated as a template and formatted using sprintf-js (see their docs for details.)

    Parameters

    • msgid: string

      String to use as a key in the localized string table. Typically this will just be the english version of the string.

    • Rest ...args: any[]

      (Optional) arguments used to format the final output string.

    Returns string

ngettext

  • ngettext(msgid: string, msgid_plural: string, count: number): string
  • Loads the plural form of a localized string for the messages language. The output string will be formatted to include the count by replacing %d in the string with the count.

    Parameters

    • msgid: string

      Singular form of the string to use as a key in the localized string table. Use %d to specify where the count should go.

    • msgid_plural: string

      Plural form of the string to use as a key in the localized string table. Use %d to specify where the count should go.

    • count: number

      Count to use when determining whether the singular or plural form of the string should be used.

    Returns string

preferredLocale

  • preferredLocale(): string

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