org.msbotframework4j.builder.bot

Class AbstractBot

java.lang.Object

org.msbotframework4j.builder.bot.AbstractBot

All Implemented Interfaces:

Bot

Direct Known Subclasses:

AbstractTelegramBot

public abstract class AbstractBot
extends Object
implements Bot

Base class for BotFramework compatible bots

Author:

Maksim Kanev

Constructor Summary

Constructors

Constructor and Description
AbstractBot()

Method Summary

Modifier and Type	Method and Description
protected void	beforeProcess(Message request, BotLogger logger) Method to pre-process input message
protected void	beforeSend(Message response, Message request, BotLogger logger) Method to post-process reply message
Message	getReply(Message message, BotLogger logger) Main method with logic to process messages
protected Message	onBotAddedToConversation(Message request, BotLogger logger) Method to handle MessageType.BOT_ADDED_TO_CONVERSATION event
protected Message	onBotRemovedFromConversation(Message request, BotLogger logger) Method to handle MessageType.BOT_REMOVED_FROM_CONVERSATION event
protected Message	onDeleteUserData(Message request, BotLogger logger) Method to handle MessageType.DELETE_USER_DATA event
protected Message	onEndOfConversation(Message request, BotLogger logger) Method to handle MessageType.END_OF_CONVERSATION event
protected abstract Message	onMessage(Message request, BotLogger logger) (REQUIRED) Method to execute bot logic and compose a reply message
protected Message	onPing(Message request, BotLogger logger) Method to handle 'Ping' requests from Microsoft BotConnector Emulator
protected Message	onUserAddedConversation(Message request, BotLogger logger) Method to handle MessageType.USER_ADDED_TO_CONVERSATION event
protected Message	onUserRemovedFromConversation(Message request, BotLogger logger) Method to handle MessageType.USER_REMOVED_FROM_CONVERSATION event

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBot

public AbstractBot()

Method Detail

getReply

public final Message getReply(Message message,
                              BotLogger logger)

Main method with logic to process messages

Specified by:

getReply in interface Bot

Parameters:

message - message to process

logger - BotLogger instance

Returns:

reply message

beforeProcess

protected void beforeProcess(Message request,
                             BotLogger logger)

Method to pre-process input message

Parameters:

request - input message

logger - BotLogger instance

onMessage

protected abstract Message onMessage(Message request,
                                     BotLogger logger)

(REQUIRED) Method to execute bot logic and compose a reply message

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onPing

protected Message onPing(Message request,
                         BotLogger logger)

Method to handle 'Ping' requests from Microsoft BotConnector Emulator

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onDeleteUserData

protected Message onDeleteUserData(Message request,
                                   BotLogger logger)

Method to handle MessageType.DELETE_USER_DATA event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onBotAddedToConversation

protected Message onBotAddedToConversation(Message request,
                                           BotLogger logger)

Method to handle MessageType.BOT_ADDED_TO_CONVERSATION event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onBotRemovedFromConversation

protected Message onBotRemovedFromConversation(Message request,
                                               BotLogger logger)

Method to handle MessageType.BOT_REMOVED_FROM_CONVERSATION event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onUserAddedConversation

protected Message onUserAddedConversation(Message request,
                                          BotLogger logger)

Method to handle MessageType.USER_ADDED_TO_CONVERSATION event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onUserRemovedFromConversation

protected Message onUserRemovedFromConversation(Message request,
                                                BotLogger logger)

Method to handle MessageType.USER_REMOVED_FROM_CONVERSATION event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

onEndOfConversation

protected Message onEndOfConversation(Message request,
                                      BotLogger logger)

Method to handle MessageType.END_OF_CONVERSATION event

Parameters:

request - input message

logger - BotLogger instance

Returns:

reply message

beforeSend

protected void beforeSend(Message response,
                          Message request,
                          BotLogger logger)

Method to post-process reply message

Parameters:

response - reply message

request - input message

logger - BotLogger instance