org.simonscode.telegrambots.framework

Interface Module

All Known Implementing Classes:

ModuleAdapter

public interface Module

Method Summary

Modifier and Type	Method and Description
ModuleInfo	getModuleInfo()
java.lang.Class<? extends State>	getStateType()
void	initialize(State state) This function is called when you module is first loaded by the framework
void	postLoad(Bot bot) This function will be executed just after your module was loaded by a bot.
void	postUnload(Bot bot) This function will be executed after your module was unloaded.
void	preLoad(Bot bot) This function will be executed just before your module will be loaded by a bot.
void	preUnload(Bot bot) This function will be executed just before your module will be unloaded.
void	processUpdate(Bot sender, org.telegram.telegrambots.api.objects.Update update) This function will be executed when telegram has an update.
State	saveState(Bot bot) This method is called when the bot wants you to save.

Method Detail

getModuleInfo

ModuleInfo getModuleInfo()

Returns:

initialize

void initialize(State state)

This function is called when you module is first loaded by the framework

Parameters:

state - the state last returned by the save function or null, if no previous state has been found

preLoad

void preLoad(Bot bot)

This function will be executed just before your module will be loaded by a bot.

postLoad

void postLoad(Bot bot)

This function will be executed just after your module was loaded by a bot.

processUpdate

void processUpdate(Bot sender,
                   org.telegram.telegrambots.api.objects.Update update)

This function will be executed when telegram has an update.

Parameters:

sender - is the bot that sent the update

update - is the update from telegram

preUnload

void preUnload(Bot bot)

This function will be executed just before your module will be unloaded.

postUnload

void postUnload(Bot bot)

This function will be executed after your module was unloaded.

saveState

State saveState(Bot bot)

This method is called when the bot wants you to save.

Parameters:

bot - the bot that wants you to save

Returns:

either the new state or null, if you do not wish to save at this moment

getStateType

java.lang.Class<? extends State> getStateType()

Returns:

the class of your implementation of State