public function setConfig($config)
| $config |
| wild |
public function getConfig($key, $default)
| $key | ||
| $default |
| wild |
abstract public function connect()
Performs any connection logic necessary for the protocol
| wild |
public function disconnect()
Disconnect from the service.
| wild |
abstract public function getNextMessages($poll_frequency)
This is the spout for messages coming in from the protocol. This will be called in the main event loop of the bot daemon So if if doesn't implement some sort of blocking timeout (e.g. select-based socket polling), it should at least sleep for some period of time in order to not overwhelm the processor.
| Int | $poll_frequency | The number of seconds between polls |
| wild |
abstract public function writeMessage($message)
This is the output mechanism for the protocol.
| PhabricatorBotMessage | $message | The message to write |
| wild |
abstract public function getServiceType()
String identifying the service type the adapter provides access to, like "irc", "campfire", "flowdock", "hipchat", etc.
| wild |
abstract public function getServiceName()
String identifying the service name the adapter is connecting to. This is used to distinguish between instances of a service. For example, for IRC, this should return the IRC network the client is connecting to.
| wild |