co.aurasphere.botmill.fb

Class FbBot

java.lang.Object

co.aurasphere.botmill.fb.FbBot

public class FbBot
extends Object

Class that represents a FbBotMill bot. Each bot has a list of FbBotMillEvent. An event is a callback from Facebook Messenger Platform. There may be different events, according to what your app has registered for (for more info check the link below). At each callback received from Facebook, all registered bots callbacks handler are checked. If any callback condition is verified, then the handleCallback method is called.

Author:

Donato Rimenti

See Also:

Facebook Messenger Platform callbacks

Constructor Summary

Constructors

Constructor and Description
FbBot() Instantiates a new FbBot with a default policy of FbBotMillPolicy.FIRST_ONLY.
FbBot(FbBotMillPolicy fbBotMillPolicy) Instantiates a new FbBot.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionFrame(ActionFrame actionFrame) Adds an ActionFrame to this bot.
void	addActionFrame(FbBotMillEvent event, AutoReply... replies) Adds an ActionFrame to this bot with multiple reply.
void	addActionFrame(FbBotMillEvent event, AutoReply reply) Adds an ActionFrame to this bot.
boolean	equals(Object obj)
int	hashCode()
void	processMessage(MessageEnvelope envelope) Checks if there's any registered FbBotMillEvent for the incoming callback.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FbBot

public FbBot()

Instantiates a new FbBot with a default policy of FbBotMillPolicy.FIRST_ONLY.

FbBot

public FbBot(FbBotMillPolicy fbBotMillPolicy)

Instantiates a new FbBot.

Parameters:

fbBotMillPolicy - the fbBotMillPolicy.

Method Detail

addActionFrame

public void addActionFrame(ActionFrame actionFrame)

Adds an ActionFrame to this bot.

Parameters:

actionFrame - the actionFrame to add.

addActionFrame

public void addActionFrame(FbBotMillEvent event,
                  AutoReply reply)

Adds an ActionFrame to this bot.

Parameters:

event - the FbBotMillEvent to handle.

reply - the AutoReply which should handle the event.

addActionFrame

public void addActionFrame(FbBotMillEvent event,
                  AutoReply... replies)

Adds an ActionFrame to this bot with multiple reply.

Parameters:

event - the FbBotMillEvent to handle.

replies - the collection of AutoReply which should handle the event.

processMessage

public void processMessage(MessageEnvelope envelope)

Checks if there's any registered FbBotMillEvent for the incoming callback. If there's any, then the callback is handled. The chain will be processed according to the FbBotMillPolicy followed by this bot. If the policy is FbBotMillPolicy.FIRST_ONLY, the chain will be processed until the first callback matches. Otherwise, if the policy is FbBotMillPolicy.PROCESS_ALL, all the chain will always be processed.

Parameters:

envelope - the incoming message.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object