co.aurasphere.botmill.fb.actionframe

Class ActionFrame

java.lang.Object

co.aurasphere.botmill.fb.actionframe.ActionFrame

public class ActionFrame
extends Object

Class that represents a FbBotMillEvent and the AutoReply to it.

Author:

Donato Rimenti

Constructor Summary

Constructors

Constructor and Description
ActionFrame(FbBotMillEvent event, AutoReply... replies) Instantiates a new action frame with multiple / collection replies.
ActionFrame(FbBotMillEvent event, AutoReply reply) Instantiates a new action frame.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterReply(MessageEnvelope envelope) Convenience method executed after the reply is sent to the user.
void	beforeReply(MessageEnvelope envelope) Convenience method executed before the reply is sent to the user.
boolean	equals(Object obj)
AutoReply[]	getReplies() Gets the replies.
AutoReply	getReply() Gets the reply.
int	hashCode()
boolean	process(MessageEnvelope envelope) Executes the reply if the event is triggered.
boolean	processMultipleReply(MessageEnvelope envelope) Executes multiple replies when multiple autoreply is set.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionFrame

public ActionFrame(FbBotMillEvent event,
           AutoReply reply)

Instantiates a new action frame.

Parameters:

event - the event.

reply - the reply.

ActionFrame

public ActionFrame(FbBotMillEvent event,
           AutoReply... replies)

Instantiates a new action frame with multiple / collection replies.

Parameters:

event - the event.

replies - the replies.

Method Detail

getReply

public AutoReply getReply()

Gets the reply.

Returns:

the reply

getReplies

public AutoReply[] getReplies()

Gets the replies.

Returns:

the replies

process

public boolean process(MessageEnvelope envelope)

Executes the reply if the event is triggered.

Parameters:

envelope - the incoming message.

Returns:

true, if the event has been triggered.

processMultipleReply

public boolean processMultipleReply(MessageEnvelope envelope)

Executes multiple replies when multiple autoreply is set.

Parameters:

envelope - the incoming message.

Returns:

true, if the event has been triggered.

beforeReply

public void beforeReply(MessageEnvelope envelope)

Convenience method executed before the reply is sent to the user. Default implementation does nothing, but you can override it with your desired behavior.

Parameters:

envelope - the incoming message.

afterReply

public void afterReply(MessageEnvelope envelope)

Convenience method executed after the reply is sent to the user. Default implementation does nothing, but you can override it with your desired behavior.

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