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 withBotCommand
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 windowboolean
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.boolean
deprecated
It will deprecate the commandjava.lang.String
description
Short description of what the command does.java.lang.String
desktop_operation_name
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 commandjava.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).java.lang.String
minimum_botagent_version
The label for the minimum bot agent version for an action.java.lang.String
minimum_controlroom_version
The label for the minimum controlroom version for an action.CommandPkg.Returns[]
multiple_returns
The package multiple @return variable belongs toboolean
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
Deprecated.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.boolean
remember
java.lang.String
return_description
The description for the return input.java.lang.String
return_label
The label for the return input.java.lang.String
return_name
The default variable name for creating variable for this command.boolean
return_required
Is the return variable required.ReturnSettingsType[]
return_settings
Return settings for the commandDataType
return_sub_type
The return subtype of this command.DataType
return_type
The return type of this command.java.lang.String
submit_label
java.lang.String
text_color
Text color of the command label on bot editor windowDataType
variable_return_type
The variable type of this command.
-
-
-
-
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
-
-
-
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_settings
ReturnSettingsType[] return_settings
Return settings for the command- Default:
- {}
-
-
-
multiple_returns
CommandPkg.Returns[] multiple_returns
The package multiple @return variable belongs to- Default:
- {@com.automationanywhere.commandsdk.annotations.CommandPkg.Returns}
-
-
hidden
boolean hidden
It will hide the command- Returns:
- true if required to hide the command, false otherwise
- Default:
- false
-
-