com.thingworx.metadata.annotations

Annotation Type ThingworxExtensionApiClass

@Target(value=TYPE)
 @Retention(value=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:

ThingworxExtensionApiMethod, ThingworxExtensionApiAnnotation

Required Element Summary

Required Elements

Modifier and Type	Required Element and 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 and 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 Detail

since

public abstract 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.

deprecatedSince

public abstract 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.

Default:

-1

canExtendOrImplement

public abstract 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.

Default:

false

canInstantiate

public abstract 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.

Default:

false