Class CommandDescription

java.lang.Object
com.inet.cowork.api.commands.CommandDescription
public class CommandDescription extends Object
Description of a CoWork command provided by a CoWorkCommandProvider. The provided command syntax is highlighted in the UI if parameters are provided with angle brackets or numbers after hashtags, e.g. "command <parameter> #123"
Since:
23.4

  • Constructor Details

    • CommandDescription

      public CommandDescription(String command, String helpText)
      Creates a description for a command
      Parameters:
      command - the full command syntax to be used. E.g. "command <param> #123". Note that angle brackets and hashtags with numbers are highlighted in the UI.
      helpText - help text describing what the command does.
      Since:
      23.4

  • Method Details

    • getCommand

      public String getCommand()
      Returns the command syntax to be used. E.g. "command <param> #123". Note that angle brackets and hashtags with numbers are highlighted in the UI.
      Returns:
      the command syntax to be used
      Since:
      23.4

    • getHelpText

      public String getHelpText()
      Returns the user-facing help text for this command. The text explains the purpose of the command and, where applicable, how it can be used.
      Returns:
      the user-facing explanation of what the command does and how to use it
      Since:
      23.4