AmbientListener

AmbientListener

Class representing a bot ambient listener. Ambient listeners can be used to respond to user messages or act on certain trigger phrases being mentioned. Ambient listeners can make use of regular methods, or Responders

Constructor

new AmbientListener(options)

Create a bot ambient listener.
Source:
Parameters:
Name Type Description
options Object The ambient listener options. See Listener.
Examples

Create and register a listener using a responder

bot.use(new Bot.Listener.Ambient({
    name: 'hunger listener',
    trigger: /i'?m hungry/i,
    handler: new Bot.Responder.Message({
        message: `Hello hungry, I'm ${bot.name}`
    })
}));

Create and register a listener using a handler function

bot.use(new Bot.Listener.Ambient({
    name: 'help listener',
    trigger: 'HELP!',
    handler: async message => {
        await bot.replyTo(message).with('What do you need help with?');
    }
}));

Extends

Methods

(static) create() → {AmbientListener}

Create a bot ambient listener (see AmbientListener for parameters).
Source:
Returns:
Type:
AmbientListener
The new ambient listener.