Annotation Type CommandPkg


  • @Documented
    @Retention(SOURCE)
    @Target(TYPE)
    public @interface CommandPkg
    Makes the type eligible for creation of command in package.json. This annotation must be used with BotCommand to take effect. Pkg would participate in the activity only when this annotation is present.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The name of the command.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String ancestor_of
      The indirect parent's command name that this command must have to be valid.
      java.lang.String background_color
      Background color of the command label/icon on bot editor window
      boolean branch_end
      Is this command always the last item in a series of branches? ("Else").
      java.lang.String branch_of
      The branch parent command name that this command must have.
      boolean branchable
      Does this command accept branches ("If" has "Else if" and "Else").
      boolean comment
      Is comment command?
      java.lang.String default_return_package
      The package the default return variable belongs to.
      java.lang.String default_return_variable_name
      The name of the default variable to assign the return value to.
      java.lang.String description
      Short description of what the command does.
      java.lang.String group_label
      The display label for the containing group (multiple commands with the same groupLabel will be grouped together).
      boolean hidden
      It will hide the command
      java.lang.String icon
      Icon for this command.
      long id
      Currently unused.
      java.lang.String label
      The display label for the command (in command palate and as an invalid command).
      boolean nestable
      Does this command allow nested child commands.
      java.lang.String node_label
      The label for the command instance inside of a taskbot node.
      java.lang.String property_description
      The help text to accompany the property.
      java.lang.String property_input_attribute
      The property input attribute name used by the compiler to assign value
      java.lang.String property_name
      The name of the property to be used in an expression.
      DataType property_return_sub_type
      The return subtype of this property (for lists, dictionaries, etc).
      DataType property_return_type
      The return type of this property.
      DataType property_type
      The type of object we are extending.
      boolean recordable
      Can this command be used to populate a recording.
      java.lang.String return_description
      The description for the return input.
      java.lang.String return_label
      The label for the return input.
      boolean return_required
      Is the return variable required.
      DataType return_sub_type
      The return subtype of this command.
      DataType return_type
      The return type of this command.
      java.lang.String text_color
      Text color of the command label on bot editor window
      DataType variable_return_type
      The variable type of this command.
    • Element Detail

      • name

        java.lang.String name
        The name of the command.
      • label

        java.lang.String label
        The display label for the command (in command palate and as an invalid command).
        Default:
        ""
      • description

        java.lang.String description
        Short description of what the command does.
        Default:
        ""
      • node_label

        java.lang.String node_label
        The label for the command instance inside of a taskbot node.
        Default:
        ""
      • id

        long id
        Currently unused.
        Default:
        0L
      • group_label

        java.lang.String group_label
        The display label for the containing group (multiple commands with the same groupLabel will be grouped together).
        Default:
        ""
      • nestable

        boolean nestable
        Does this command allow nested child commands. ("Loop", "Block" or "If").
        Default:
        false
      • branchable

        boolean branchable
        Does this command accept branches ("If" has "Else if" and "Else").
        Default:
        false
      • branch_of

        java.lang.String branch_of
        The branch parent command name that this command must have. ("If" for "Else if").

        Can only reference a command by name from the same package/version.

        Default:
        ""
      • branch_end

        boolean branch_end
        Is this command always the last item in a series of branches? ("Else").
        Default:
        false
      • ancestor_of

        java.lang.String ancestor_of
        The indirect parent's command name that this command must have to be valid. ("Loop" for "Break" or "Continue").

        Can only reference a command by name from the same package/version.

        Default:
        ""
      • property_name

        java.lang.String property_name
        The name of the property to be used in an expression.
        Default:
        ""
      • property_description

        java.lang.String property_description
        The help text to accompany the property.
        Default:
        ""
      • property_type

        DataType property_type
        The type of object we are extending.
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • property_return_type

        DataType property_return_type
        The return type of this property.
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • property_return_sub_type

        DataType property_return_sub_type
        The return subtype of this property (for lists, dictionaries, etc).
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • property_input_attribute

        java.lang.String property_input_attribute
        The property input attribute name used by the compiler to assign value
        Default:
        ""
      • recordable

        boolean recordable
        Can this command be used to populate a recording.
        Default:
        false
      • icon

        java.lang.String icon
        Icon for this command.
        Default:
        ""
      • return_type

        DataType return_type
        The return type of this command.
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • return_sub_type

        DataType return_sub_type
        The return subtype of this command.
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • variable_return_type

        DataType variable_return_type
        The variable type of this command.
        Default:
        com.automationanywhere.commandsdk.model.DataType.UNDEFINED
      • return_label

        java.lang.String return_label
        The label for the return input.
        Default:
        ""
      • return_description

        java.lang.String return_description
        The description for the return input.
        Default:
        ""
      • return_required

        boolean return_required
        Is the return variable required.
        Default:
        false
      • default_return_variable_name

        java.lang.String default_return_variable_name
        The name of the default variable to assign the return value to.
        Default:
        ""
      • default_return_package

        java.lang.String default_return_package
        The package the default return variable belongs to.
        Default:
        ""
      • text_color

        java.lang.String text_color
        Text color of the command label on bot editor window
        Returns:
        Default:
        ""
      • background_color

        java.lang.String background_color
        Background color of the command label/icon on bot editor window
        Returns:
        Default:
        ""
      • comment

        boolean comment
        Is comment command?
        Returns:
        Default:
        false
      • hidden

        boolean hidden
        It will hide the command
        Returns:
        true if required to hide the command, false otherwise
        Default:
        false