co.aurasphere.botmill.fb

Class FbBotMillContext

java.lang.Object

co.aurasphere.botmill.fb.FbBotMillContext

public class FbBotMillContext
extends Object

Class that contains all the context information used to handle bots and communicate with Facebook. The context is a singleton.

Author:

Donato Rimenti, Alvin Reyes

Field Summary

Fields

Modifier and Type	Field and Description
MessageEnvelope	messageEnvelope The message envelope.

Method Summary

Modifier and Type	Method and Description
static FbBotMillContext	getInstance() Gets the current instance of FbBotMillContext.
String	getPageToken() Gets the pageToken.
List<FbBot>	getRegisteredBots() Gets the registeredBots.
List<FbBotMillMonitor>	getRegisteredMonitors() Gets the list of registered monitors to this context.
String	getValidationToken() Gets the validationToken.
boolean	isValidationEnabled() Checks if is validation enabled.
void	registerMonitor(FbBotMillMonitor monitor) Registers a monitor to the context.
void	setPageToken(String pageToken) Deprecated.
void	setup(String pageToken, String validationToken) Convenience method for quickly setting up the FbBotMill environment.
void	setValidationEnabled(boolean validationEnabled) Sets the validationEnabled.
void	setValidationToken(String validationToken) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

messageEnvelope

public MessageEnvelope messageEnvelope

The message envelope.

Method Detail

getInstance

public static FbBotMillContext getInstance()

Gets the current instance of FbBotMillContext.

Returns:

the current instance of FbBotMillContext.

getRegisteredBots

public List<FbBot> getRegisteredBots()

Gets the registeredBots.

Returns:

the registeredBots.

getValidationToken

public String getValidationToken()

Gets the validationToken.

Returns:

the validationToken.

setValidationToken

@Deprecated
public void setValidationToken(String validationToken)

Deprecated.

Sets the validationToken. This method is deprecated. Use setup(String, String) instead.

Parameters:

validationToken - the validationToken to set.

getPageToken

public String getPageToken()

Gets the pageToken.

Returns:

the pageToken.

setPageToken

@Deprecated
public void setPageToken(String pageToken)

Deprecated.

Sets the pageToken. This method is deprecated. Use setup(String, String) instead.

Parameters:

pageToken - the pageToken to set.

isValidationEnabled

public boolean isValidationEnabled()

Checks if is validation enabled.

Returns:

true, if is validation enabled

setValidationEnabled

public void setValidationEnabled(boolean validationEnabled)

Sets the validationEnabled.

Parameters:

validationEnabled - the validationEnabled to set.

setup

public void setup(String pageToken,
                  String validationToken)

Convenience method for quickly setting up the FbBotMill environment.

Parameters:

pageToken - the validation token for the Facebook page.

validationToken - the validation token for the Facebook webhook.

See Also:

Facebook Messenger Platform documentation

registerMonitor

public void registerMonitor(FbBotMillMonitor monitor)

Registers a monitor to the context. A monitor needs to be registered to this context in order to be used.

Parameters:

monitor - the monitor to be registered.

Since:

1.1.0

getRegisteredMonitors

public List<FbBotMillMonitor> getRegisteredMonitors()

Gets the list of registered monitors to this context.

Returns:

a list of registered monitors to this context.

Since:

1.1.0

toString

public String toString()

Overrides:

toString in class Object