Package com.thingworx.metadata.annotations

Annotation Interface ThingworxExtensionApiMethod

@Target({METHOD,CONSTRUCTOR})
@Retention(RUNTIME)
@Documented
public @interface ThingworxExtensionApiMethod

The ThingworxExtensionApiMethod annotation is used to indicate that the current method is part of the Thingworx Extension Development API.

See Also:

• ThingworxExtensionApiClass
• ThingworxExtensionApiAnnotation

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	canOverride	Optional parameter: Indicates whether or not extension developers are permitted to override the method in extended versions of the containing class.
int[]	deprecatedSince	Optional parameter: When specified, indicates that the method has been deprecated for extension developers and should no longer be used for new extension development.
boolean	requiresSuper	Optional parameter: Indicates where the overriding method is required to call the parent implementation (via super.methodName()).

Element Details

since

int[] since

Required parameter: Indicates which version of the Thingworx Platform began supporting the API. The version number is passed in using an array of ints, for example { 7, 0, 2 } would correspond to Thingworx 7.0.2.

deprecatedSince

int[] deprecatedSince

Optional parameter: When specified, indicates that the method 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}

canOverride

boolean canOverride

Optional parameter: Indicates whether or not extension developers are permitted to override the method in extended versions of the containing class. By default, this attribute is set to false.

Default:

false

requiresSuper

boolean requiresSuper

Optional parameter: Indicates where the overriding method is required to call the parent implementation (via super.methodName()). By default, this attribute is set to false.

Default:

false