@Documented
@Retention(value=SOURCE)
@Target(value=TYPE)
public @interface CommandPkg
BotCommand
to take effect. Pkg
would participate in the activity only when this annotation is present.Modifier and Type | Required Element and Description |
---|---|
java.lang.String |
label
The display label for the command (in command palate and as an invalid
command).
|
java.lang.String |
name
The name of the command.
|
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
ancestor_of
The indirect parent's command name that this command must have to be valid.
|
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").
|
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).
|
java.lang.String |
icon
Icon for this command.
|
long |
id
Currently unused.
|
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_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.
|
public abstract java.lang.String label
public abstract java.lang.String description
public abstract java.lang.String node_label
public abstract java.lang.String group_label
public abstract boolean nestable
public abstract boolean branchable
public abstract java.lang.String branch_of
Can only reference a command by name from the same package/version.
public abstract boolean branch_end
public abstract java.lang.String ancestor_of
Can only reference a command by name from the same package/version.
public abstract java.lang.String property_name
public abstract java.lang.String property_description
public abstract DataType property_type
public abstract DataType property_return_type
public abstract DataType property_return_sub_type
public abstract boolean recordable
public abstract DataType return_type
public abstract DataType return_sub_type
public abstract java.lang.String return_label
public abstract java.lang.String return_description
public abstract boolean return_required