Options
All
  • Public
  • Public/Protected
  • All
Menu

Module config

Index

Functions

getBotpressConfig

  • getBotpressConfig(): Promise<any>
  • Returns the configuration options of Botpress

    Returns Promise<any>

getModuleConfig

  • getModuleConfig(moduleId: string): Promise<any>

getModuleConfigForBot

  • getModuleConfigForBot(moduleId: string, botId: string, ignoreGlobal?: undefined | false | true): Promise<any>
  • Returns the configuration values for the specified module and bot.

    Parameters

    • moduleId: string
    • botId: string
    • Optional ignoreGlobal: undefined | false | true

      Enable this when you want only bot-specific configuration to be possible

    Returns Promise<any>

mergeBotConfig

  • mergeBotConfig(botId: string, partialConfig: _.PartialDeep<BotConfig>, ignoreLock?: undefined | false | true): Promise<any>
  • Merges and saves a bot's config

    Parameters

    • botId: string
    • partialConfig: _.PartialDeep<BotConfig>
    • Optional ignoreLock: undefined | false | true

    Returns Promise<any>

Generated using TypeDoc