fr.paris.lutece.plugins.chatbot.service.bot

Class AbstractChatBot

java.lang.Object

fr.paris.lutece.plugins.chatbot.service.bot.AbstractChatBot

All Implemented Interfaces:

ChatBot, Serializable

Direct Known Subclasses:

MockChatBot

public abstract class AbstractChatBot
extends Object
implements ChatBot, Serializable

Bot

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractChatBot()

Method Summary

Modifier and Type	Method and Description
List<String>	getAvailableLanguages() Returns available languages
String	getAvatarUrl() Returns the BotAvatarUrl
String	getDescription(Locale locale) Returns the Description
String	getDescriptionI18nKey() Returns the DescriptionI18nKey
String	getKey() Returns the Key
String	getName(Locale locale) Returns the Name
String	getNameI18nKey() Returns the NameI18nKey
String	getWelcomeMessage() Returns the WelcomeMessage
boolean	isStandalone() Is standalone (mode for iframe)
void	reset(String strConversationId) Reset the conversation
void	setAvatarUrl(String strBotAvatarUrl) Sets the BotAvatarUrl
void	setDescription(String strDescription) Sets the Description
void	setDescriptionI18nKey(String strDescriptionI18nKey) Sets the DescriptionI18nKey
void	setKey(String strKey) Sets the Key
void	setListAvailableLanguages(List<String> listAvailableLanguages) Set available languages list
void	setName(String strName) Sets the Name
void	setNameI18nKey(String strNameI18nKey) Sets the NameI18nKey
void	setStandalone(boolean bStandalone) Sets the Standalone
void	setWelcomeMessage(String strWelcomeMessage) Sets the WelcomeMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.paris.lutece.plugins.chatbot.service.bot.ChatBot

processUserMessage

Constructor Detail

AbstractChatBot

public AbstractChatBot()

Method Detail

getKey

public String getKey()

Returns the Key

Specified by:

getKey in interface ChatBot

Returns:

The Key

setKey

public void setKey(String strKey)

Sets the Key

Parameters:

strKey - The Key

getName

public String getName(Locale locale)

Returns the Name

Specified by:

getName in interface ChatBot

Parameters:

locale - The locale

Returns:

The Name

setName

public void setName(String strName)

Sets the Name

Parameters:

strName - The Name

getDescription

public String getDescription(Locale locale)

Returns the Description

Specified by:

getDescription in interface ChatBot

Parameters:

locale - The locale

Returns:

The Description

setDescription

public void setDescription(String strDescription)

Sets the Description

Parameters:

strDescription - The Description

getNameI18nKey

public String getNameI18nKey()

Returns the NameI18nKey

Returns:

The NameI18nKey

setNameI18nKey

public void setNameI18nKey(String strNameI18nKey)

Sets the NameI18nKey

Parameters:

strNameI18nKey - The NameI18nKey

getDescriptionI18nKey

public String getDescriptionI18nKey()

Returns the DescriptionI18nKey

Returns:

The DescriptionI18nKey

setDescriptionI18nKey

public void setDescriptionI18nKey(String strDescriptionI18nKey)

Sets the DescriptionI18nKey

Parameters:

strDescriptionI18nKey - The DescriptionI18nKey

getAvatarUrl

public String getAvatarUrl()

Returns the BotAvatarUrl

Specified by:

getAvatarUrl in interface ChatBot

Returns:

The BotAvatarUrl

setAvatarUrl

public void setAvatarUrl(String strBotAvatarUrl)

Sets the BotAvatarUrl

Parameters:

strBotAvatarUrl - The BotAvatarUrl

setListAvailableLanguages

public void setListAvailableLanguages(List<String> listAvailableLanguages)

Set available languages list

Parameters:

listAvailableLanguages - available languages list

getAvailableLanguages

public List<String> getAvailableLanguages()

Returns available languages

Specified by:

getAvailableLanguages in interface ChatBot

Returns:

available languages

isStandalone

public boolean isStandalone()

Is standalone (mode for iframe)

Specified by:

isStandalone in interface ChatBot

Returns:

true if standalone

setStandalone

public void setStandalone(boolean bStandalone)

Sets the Standalone

Parameters:

bStandalone - The Standalone

getWelcomeMessage

public String getWelcomeMessage()

Returns the WelcomeMessage

Specified by:

getWelcomeMessage in interface ChatBot

Returns:

The WelcomeMessage

setWelcomeMessage

public void setWelcomeMessage(String strWelcomeMessage)

Sets the WelcomeMessage

Parameters:

strWelcomeMessage - The WelcomeMessage

reset

public void reset(String strConversationId)

Reset the conversation

Specified by:

reset in interface ChatBot

Parameters:

strConversationId - The conversation ID