Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventState

This object is used to store data which will be persisted on different timeframes. It allows you to easily store and retrieve data for different kind of situations.

Hierarchy

  • EventState

Index

Properties

__stacktrace

__stacktrace: JumpPoint[]

EXPERIMENTAL This includes all the flow/nodes which were traversed for the current event

bot

bot: any

Variables in the bot object are shared to all users for a specific bot. It is read only, meaning that changes are not automatically persisted. You need to use the setVariable option to change it. There is a possible race condition since it is loaded each time a messages comes in. Update it wisely

context

context: DialogContext

Used internally by Botpress to keep the user's current location and upcoming instructions

session

Data is kept for the active session. Timeout configurable in the global config file

temp

temp: any

Data saved to this variable will be remembered until the end of the flow

user

user: object

Data saved as user attributes; retention policies in Botpress global config applies

Generated using TypeDoc