Package com.inet.cowork.api.commands
Class CommandDescription
- java.lang.Object
-
- com.inet.cowork.api.commands.CommandDescription
-
public class CommandDescription extends java.lang.Object
Description of a CoWork command provided by a CoWorkCommandProvider. The provided command syntax is highlighted in the UI if parameters are provided with angled brackets or numbers after hashtags, e.g. "command <parameter> #123"- Since:
- 23.4
-
-
Constructor Summary
Constructors Constructor Description CommandDescription(java.lang.String command, java.lang.String helpText)
Creates a description for a command
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCommand()
Returns the command syntax to be used.java.lang.String
getHelpText()
Returns a help text to describe the command
-
-
-
Constructor Detail
-
CommandDescription
public CommandDescription(java.lang.String command, java.lang.String helpText)
Creates a description for a command- Parameters:
command
- the full command syntax to be used. E.g. "command <param> #123". Note that angled brackets and hashtags with numbers are highlighted in the UI.helpText
- a help text describing what the command does.- Since:
- 23.4
-
-
Method Detail
-
getCommand
public java.lang.String getCommand()
Returns the command syntax to be used. E.g. "command <param> #123". Note that angled brackets and hashtags with numbers are highlighted in the UI.- Returns:
- the command syntax to be used
- Since:
- 23.4
-
getHelpText
public java.lang.String getHelpText()
Returns a help text to describe the command- Returns:
- a help text to describe the command
- Since:
- 23.4
-
-