co.aurasphere.botmill.fb.support

Interface FbBotMillMonitor

public interface FbBotMillMonitor

Base interface for monitoring raw data from BotMill framework and Facebook Messenger Platform. These interface methods will be called as a callback each time the FbBotMill receives data from the network or other similar events occurs. In order to use these callbacks, you will need to implement this interface and register it to the FbBotMillContext using the method FbBotMillContext.registerMonitor(FbBotMillMonitor).

Since:

1.1.0

Author:

Donato Rimenti

Method Summary

Methods

Modifier and Type	Method and Description
void	onConfirmation(FacebookConfirmationMessage data) Callback processed each time the bot sends data and gets a reply back from the Facebook's server.
void	onError(FacebookErrorMessage error) Callback processed each time the bot sends data and gets an error back from the Facebook's server.
void	onGetReceived(javax.servlet.http.HttpServletRequest request) Callback processed each time the FbBotMillServlet receives an HTTP GET request.
void	onPostReceived(javax.servlet.http.HttpServletRequest request, MessengerCallback data) Callback processed each time the FbBotMillServlet receives an HTTP POST request.
void	onValidationError(FbBotMillResponse response, Set<javax.validation.ConstraintViolation<FbBotMillResponse>> constraintViolations) Callback processed each time there is a validation error on the response produced by the bots.

Method Detail

onConfirmation

void onConfirmation(FacebookConfirmationMessage data)

Callback processed each time the bot sends data and gets a reply back from the Facebook's server.

Parameters:

data - the Facebook response to the last AutoReply the bot sent.

onError

void onError(FacebookErrorMessage error)

Callback processed each time the bot sends data and gets an error back from the Facebook's server.

Parameters:

error - the Facebook error.

onPostReceived

void onPostReceived(javax.servlet.http.HttpServletRequest request,
                  MessengerCallback data)

Callback processed each time the FbBotMillServlet receives an HTTP POST request. Please, notice that this method will be called after the bots have processed it. This is because the method's purpose is data monitoring, analysis and statistics. Since the operations involved in this process may be heavy, in order to let the bots return a response to the user quickly, this callback is postponed.

Parameters:

request - the incoming raw servlet request.

data - the Facebook incoming data.

onGetReceived

void onGetReceived(javax.servlet.http.HttpServletRequest request)

Callback processed each time the FbBotMillServlet receives an HTTP GET request. Please, notice that this method will be called after the bots have processed it. This is because the method's purpose is data monitoring, analysis and statistics. Since the operations involved in this process may be heavy, in order to let the bots return a response to the user quickly, this callback is postponed.

Parameters:

request - the incoming raw servlet request.

onValidationError

void onValidationError(FbBotMillResponse response,
                     Set<javax.validation.ConstraintViolation<FbBotMillResponse>> constraintViolations)

Callback processed each time there is a validation error on the response produced by the bots.

Parameters:

response - the invalid response produced by the bot.

constraintViolations - the constraint violations for the current response.