Package com.thingworx.metadata.annotations

Annotation Type 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
      java.lang.String alias


      Required parameter: Alias for the event.
      java.lang.String eventName


      Required parameter: the name of the event to subscribe to.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String source


      Optional parameter: the name of the entity to subscribe to for events.
      java.lang.String sourceProperty


      Optional parameter: the name of the property that this subscription should monitor.

    • Element Detail

      • alias

        java.lang.String alias


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

      • eventName

        java.lang.String eventName


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

      • source

        java.lang.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:
        ""

      • sourceProperty

        java.lang.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:
        ""