co.aurasphere.botmill.fb

Class FbBot

java.lang.Object

co.aurasphere.botmill.fb.FbBot

All Implemented Interfaces:

co.aurasphere.botmill.core.BotDefinition

public abstract class FbBot
extends Object
implements co.aurasphere.botmill.core.BotDefinition

Base BotDefinition implementation.

Author:

Donato Rimenti, Alvin Reyes

Constructor Summary

Constructors

Constructor and Description
FbBot() Base constructor.
FbBot(co.aurasphere.botmill.core.BotMillPolicy botmillPolicy) Base constructor.

Method Summary

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.
protected void	addReply(AutoReply reply) Adds the reply.
protected co.aurasphere.botmill.core.BotMillSession	botMillSession() Bot mill session.
void	defineBehaviour() This is the method to define the behaviour of the bot.
boolean	equals(Object obj)
protected void	executeReplies() Execute replies.
MessageEnvelope	getEnvelope()
FbBotMillEvent	getEvent()
int	hashCode()
void	processMessage(MessageEnvelope envelope) Checks if there's any registered FbBotMillEvent for the incoming callback.
protected void	reply(AutoReply... replies) This method is used to create multiple replies.
protected void	reply(AutoReply reply) This method is used to create a reply.
void	setEnvelope(MessageEnvelope envelope) Sets the envelope.
void	setEvent(FbBotMillEvent event) Sets the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

FbBot

public FbBot(co.aurasphere.botmill.core.BotMillPolicy botmillPolicy)

Base constructor. Instantiates a bot and registers it to the context.

Parameters:

botmillPolicy - the policy this bot should follow.

FbBot

public FbBot()

Base constructor. Instantiates a bot and registers it to the context.

Method Detail

setEvent

public void setEvent(FbBotMillEvent event)

Sets the event.

Parameters:

event - the new event

getEvent

public FbBotMillEvent getEvent()

setEnvelope

public void setEnvelope(MessageEnvelope envelope)

Sets the envelope.

Parameters:

envelope - the new envelope

getEnvelope

public MessageEnvelope getEnvelope()

defineBehaviour

public void defineBehaviour()

This is the method to define the behaviour of the bot. As of the introduction of the Annotation based configuration, this is overriden on the supertype level. The method can still be overriden by a concrete Bot class and use to define behaviour.

Specified by:

defineBehaviour in interface co.aurasphere.botmill.core.BotDefinition

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.

reply

protected void reply(AutoReply... replies)

This method is used to create multiple replies.

Parameters:

replies - the set of replies in a form of a var-args

botMillSession

protected final co.aurasphere.botmill.core.BotMillSession botMillSession()

Bot mill session.

Returns:

the bot mill session

reply

protected void reply(AutoReply reply)

This method is used to create a reply.

Parameters:

reply - the reply

addReply

protected void addReply(AutoReply reply)

Adds the reply.

Parameters:

reply - the reply

executeReplies

protected void executeReplies()

Execute replies.

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 BotMillPolicy followed by this bot. If the policy is BotMillPolicy.FIRST_ONLY, the chain will be processed until the first callback matches. Otherwise, if the policy is BotMillPolicy.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