adapters.md

Brobbot Adapters

Adapters are the interface to the service you want your brobbot to run on.

Official Adapters

• Shell, i.e. for use with development
• Slack
• XMPP

Writing Your Own adapter

The best place to start is src/adapter.js, and inheriting from Adapter. There is not as much documentation as could exist (yet!), so it is worth reviewing existing adapters as well as how brobbot internally uses an adapter.

There are a few primary methods you should implement:

run()

This is where you initialize your adapter and establish a connection to the chat service. Your adapter should emit connected when it is ready to start accepting messages.

message(msg)

This is where you receive messages from the chat service and do any transforming necessary before handing them off to brobbot. A typical message brobbot might expect looks like:

{
  text: 'some message text',
  room: '#general',
  user: {
    id: 42,
    name: 'some user'
  }
}

When you finish transforming, you should call robot.receive(msg).

send(envelope, messages...)

This is where you take messages from brobbot and send them off to the chat service.

reply(envelope, messages...)

Similar to send, but used to reply to a particular user (envelope.user).