Package io.micronaut.chatbots.core
Class ChatbotsConfigurationProperties
- java.lang.Object
-
- io.micronaut.chatbots.core.ChatbotsConfigurationProperties
-
- All Implemented Interfaces:
ChatbotsConfiguration
,io.micronaut.core.util.Toggleable
@ConfigurationProperties("micronaut.chatbots") public class ChatbotsConfigurationProperties extends java.lang.Object implements ChatbotsConfiguration
ConfigurationProperties
implementation ofChatbotsConfiguration
.- Since:
- 1.0.0
- Author:
- Sergio del Amo
-
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_ENABLED
The default enable value.static java.lang.String
DEFAULT_FOLDER
The default BOT commands folder.-
Fields inherited from interface io.micronaut.chatbots.core.ChatbotsConfiguration
PREFIX
-
-
Constructor Summary
Constructors Constructor Description ChatbotsConfigurationProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getFolder()
java.util.List<FileExtension>
getPossibleStaticCommandExtensions()
boolean
isEnabled()
enabled getter.void
setEnabled(boolean enabled)
Whether chatbots is enabled.void
setFolder(java.lang.String folder)
The folder to look for bot commands.void
setPossibleStaticCommandExtensions(java.util.List<FileExtension> possibleStaticCommandExtensions)
Possible static command file extensions.
-
-
-
Field Detail
-
DEFAULT_FOLDER
public static final java.lang.String DEFAULT_FOLDER
The default BOT commands folder.- See Also:
- Constant Field Values
-
DEFAULT_ENABLED
public static final boolean DEFAULT_ENABLED
The default enable value.- See Also:
- Constant Field Values
-
-
Method Detail
-
isEnabled
public boolean isEnabled()
enabled getter.- Specified by:
isEnabled
in interfaceio.micronaut.core.util.Toggleable
- Returns:
- boolean flag indicating whether the chatbots features are enabled.
-
getFolder
@NonNull public java.lang.String getFolder()
- Specified by:
getFolder
in interfaceChatbotsConfiguration
- Returns:
- The Bot Commands' folder where views should be searched for. By default "botcommands"
-
setEnabled
public void setEnabled(boolean enabled)
Whether chatbots is enabled. Default value (true).- Parameters:
enabled
- True if view rendering is enabled
-
setFolder
public void setFolder(java.lang.String folder)
The folder to look for bot commands.- Parameters:
folder
- The folder
-
getPossibleStaticCommandExtensions
@Nullable public java.util.List<FileExtension> getPossibleStaticCommandExtensions()
- Specified by:
getPossibleStaticCommandExtensions
in interfaceChatbotsConfiguration
- Returns:
- the command file extensions candidates for static resource. For a command such as
/help
and extensions HTML and MARKDOWN, possible files arehelp.md
,help.markdown
, andhelp.html
-
setPossibleStaticCommandExtensions
public void setPossibleStaticCommandExtensions(@Nullable java.util.List<FileExtension> possibleStaticCommandExtensions)
Possible static command file extensions. Default values MARKDOWN HTML TXT- Parameters:
possibleStaticCommandExtensions
- Possible static command file extensions.
-
-