Package com.thingworx.metadata.annotations

Annotation Interface ThingworxExtensionApiClass

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface ThingworxExtensionApiClass
The ThingworxExtensionApiClass annotation is used to indicate that the current class or interface is part of the Thingworx Extension Development API. The attributes indicate whether the type may safely be extended, implemented, or instantiated.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int[]
    since
    Required parameter: Indicates which version of the Thingworx Platform began supporting the API.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    canExtendOrImplement
    Optional parameter: Indicates whether or not extension developers are permitted to extend or implement the annotated type.
    boolean
    canInstantiate
    Optional parameter: When true, an extension developer is permitted to instantiate new instances of this type.
    int[]
    deprecatedSince
    Optional parameter: When specified, indicates that the class has been deprecated for extension developers and should no longer be used for new extension development.

  • Element Details

    • since

      int[] since
      Required parameter: Indicates which version of the Thingworx Platform began supporting the API. The extension should set its platform version requirement to match the highest version number in the API methods it calls. The version number is specified using an array of integers, for example { 7, 0, 2 } would correspond to Thingworx 7.0.2.
      Returns:
      the Thingworx Platform version, where each version component is stored at its own index

    • deprecatedSince

      int[] deprecatedSince
      Optional parameter: When specified, indicates that the class has been deprecated for extension developers and should no longer be used for new extension development. Existing extensions should phase out the use of the deprecated API. The version number is specified using an array of integers, for example { 7, 0, 2 } would correspond to Thingworx 7.0.2.
      Returns:
      the Thingworx Platform version, where each version component is stored at its own index
      Default:
      {-1}

    • canExtendOrImplement

      boolean canExtendOrImplement
      Optional parameter: Indicates whether or not extension developers are permitted to extend or implement the annotated type. By default, this attribute is set to false.
      Returns:
      true or false
      Default:
      false

    • canInstantiate

      boolean canInstantiate
      Optional parameter: When true, an extension developer is permitted to instantiate new instances of this type. By default, this attribute is set to false.
      Returns:
      true or false
      Default:
      false