Package com.thingworx.subscriptions

Class MultiEventSubscription

java.lang.Object
com.thingworx.subscriptions.MultiEventSubscription
All Implemented Interfaces:
ICharacteristic, IDiffableObject, IAspectContainer, INamedObject, Cloneable
@ThingworxExtensionApiClass(since={9,5}, canInstantiate=true) public class MultiEventSubscription extends Object implements ICharacteristic, Cloneable, IAspectContainer, INamedObject, IDiffableObject

  • Field Details

    • VERSION_LEGACY

      public static final Integer VERSION_LEGACY

    • VERSION_MULTI

      public static final Integer VERSION_MULTI

  • Constructor Details

    • MultiEventSubscription

      public MultiEventSubscription()

  • Method Details

    • getOwner

      @ThingworxExtensionApiMethod(since={8,0}) public EntityReference getOwner()


      Returns a reference to the entity that owns the subscription.

      This entity may not necessarily be the subscriber; for example, a thing template or thing shape may define a subscription and thus be the "owner", but the thing that implements the template or shape would be the "subscriber".

      The owner is referred to as the "source" in other classes, but this collides with the concept of a "source" on EventDescriptor and can be confusing to developers, so it is explicitly called out as the "owning entity" here.

      Returns:
      a reference to the entity that owns the subscription

    • getEvents

      @ThingworxExtensionApiMethod(since={9,5}) public List<EventDescriptor> getEvents()

    • getDescription

      @ThingworxExtensionApiMethod(since={9,5}) public String getDescription()
      Specified by:
      getDescription in interface INamedObject

    • getName

      @ThingworxExtensionApiMethod(since={9,5}) public String getName()


      Gets the name of the subscription. Before 8.4.0, Subscriptions did not have names, so this method maintains backwards compatibility by setting the name from the event descriptor if no name is provided before this method is called.
      Specified by:
      getName in interface INamedObject

    • isEnabled

      @ThingworxExtensionApiMethod(since={9,5}) public boolean isEnabled()