co.aurasphere.botmill.fb.support

Class FbBotMillMockMediator

java.lang.Object

co.aurasphere.botmill.fb.support.FbBotMillMockMediator

public class FbBotMillMockMediator
extends Object

Testing facility for FbBotMill framework. Since this object is intended only for testing, it is NOT Thread safe.

Author:

Donato Rimenti

Method Summary

Methods

Modifier and Type	Method and Description
void	forward(MessageEnvelope envelope) Forwards an envelope to the registered bots.
static String	getFacebookMockId() Gets the facebookMockId.
static FbBotMillMockMediator	getInstance(String facebookMockId, Class<? extends FbBotDefinition>... fbBotDefinitions) Constructor that registers a mocked page-scoped user ID as a recipient and instantiates and registers a list of FbBotDefinition classes.
static FbBotMillMockMediator	getInstance(String facebookMockId, FbBotDefinition... fbBotDefinitions) Constructor that registers a mocked page-scoped user ID as a recipient and a list of FbBotDefinition.
void	interactiveTest() Starts an interactive test that simulates the behavior of the bot according to the chat inputs.
static boolean	isMockEnabled() Checks if is mock enabled.
void	sendPayload(String payload) Sends a payload to all the registered bots.
void	sendQuickReplyPayload(String payload) Sends a quickreply to all the registered bots.
void	sendTextMessage(String message) Sends a text message to all the registered bots.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static FbBotMillMockMediator getInstance(String facebookMockId,
                                FbBotDefinition... fbBotDefinitions)

Constructor that registers a mocked page-scoped user ID as a recipient and a list of FbBotDefinition.

Parameters:

facebookMockId - the facebookMockId.

fbBotDefinitions - a list of FbBotDefinition to register.

Returns:

single instance of FbBotMillMockMediator

getInstance

@SafeVarargs
public static FbBotMillMockMediator getInstance(String facebookMockId,
                                            Class<? extends FbBotDefinition>... fbBotDefinitions)

Constructor that registers a mocked page-scoped user ID as a recipient and instantiates and registers a list of FbBotDefinition classes.

Parameters:

facebookMockId - the facebookMockId.

fbBotDefinitions - a list of classes implementing FbBotDefinition.

Returns:

single instance of FbBotMillMockMediator

sendTextMessage

public void sendTextMessage(String message)

Sends a text message to all the registered bots. Used to simulate a user typing in chat with your bot.

Parameters:

message - the message to send.

sendPayload

public void sendPayload(String payload)

Sends a payload to all the registered bots. Used to simulate a user interacting with buttons.

Parameters:

payload - the payload to send.

sendQuickReplyPayload

public void sendQuickReplyPayload(String payload)

Sends a quickreply to all the registered bots. Used to simulate a user interacting with buttons.

Parameters:

payload - the payload to send.

forward

public void forward(MessageEnvelope envelope)

Forwards an envelope to the registered bots.

Parameters:

envelope - the envelope to forward.

interactiveTest

public void interactiveTest()

Starts an interactive test that simulates the behavior of the bot according to the chat inputs. You can send messages to the registered bots typing in your IDE console. To send a message, just type it. To send a payload, type followed by your payload. To end the test, type .

isMockEnabled

public static boolean isMockEnabled()

Checks if is mock enabled.

Returns:

the mockEnabled.

getFacebookMockId

public static String getFacebookMockId()

Gets the facebookMockId.

Returns:

the facebookMockId.

toString

public String toString()

Overrides:

toString in class Object