Package com.thingworx.metadata.annotations

Annotation Interface ThingworxSubscriptionEvent

@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@ThingworxExtensionApiAnnotation(since={9,5,1})
public @interface ThingworxSubscriptionEvent

Defines events subscriptions that the entity wishes to handle. Events can either target standard events or property events, and may also specify a source entity. The source entity should be another entity that is part of the platform, the extension, or an entity in a dependent extension.

See Also:

• MultiEventSubscription

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	alias	Required parameter: Alias for the event.
String	eventName	Required parameter: the name of the event to subscribe to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	source	Optional parameter: the name of the entity to subscribe to for events.
String	sourceProperty	Optional parameter: the name of the property that this subscription should monitor.

Element Details

alias

String alias

Required parameter: Alias for the event. Aliases must be unique in a certain subscription

source

String source

Optional parameter: the name of the entity to subscribe to for events. If blank or omitted, then the current entity is assumed.

Default:

""

eventName

String eventName

Required parameter: the name of the event to subscribe to. Event names are case sensitive.

sourceProperty

String sourceProperty

Optional parameter: the name of the property that this subscription should monitor. This parameter is required when subscribing to property events. Property names are case sensitive.

Default:

""