Annotation Type Idx


  • @Documented
    @Retention(SOURCE)
    @Target({FIELD,PARAMETER})
    public @interface Idx
    Makes the annotated element part of hierarchy utilized for code and resource generation. In other words without this annotation no BotCommand related element annotations would be processed.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String index
      Unique index of element in TOC format, i.e.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String name
      Represents the name of the element in the BotCommand parameters.
      Idx.Option[] options
      Children of the annotated element which would only be present in the package.json.
      AttributeType type
      BotCommand Type of the element.
    • Element Detail

      • index

        java.lang.String index
        Unique index of element in TOC format, i.e. N[.N]* format, where "." acts as separator between parent and child and "N" is any number representing the position of the child under the parent.

        for example 4, 4.2, 4.3.4

      • name

        java.lang.String name
        Represents the name of the element in the BotCommand parameters. Typically this name would be unique but it is not mandated to be so.

        It would be used to provide name in the attributes of package.json.

        The name of the element would be used if blank (null, "", whitespace) is provided.

        Default:
        ""
      • type

        AttributeType type
        BotCommand Type of the element.

        It would be used to provide type in the attributes of package.json.

        Default:
        com.automationanywhere.commandsdk.model.AttributeType.UNKNOWN
      • options

        Idx.Option[] options
        Children of the annotated element which would only be present in the package.json.
        Returns:
        Default:
        {}