Interface ISubscriptionInfo

All Known Subinterfaces:
ISubscription

public interface ISubscriptionInfo
This represents the relationship between a Thing interested in events (usually a Principal) and Thing that generates events (usually an information resource). It has a 'from' and a 'to'.
  • The 'from' identifies the resource that will generate events.
    • from.id - Thing ID. A ThingID that specifies ThingType but leave the instance ID as 0 will subscribe to all Things of the specified type.
    • from.criteria[] - list of criterion specifying property and operation. Optional.
      • from.criteria[].property - ThingID of Relation that defines this property
      • from.criteria[].from - boolean defining whether the Relation is from or to the specified Thing. A value of true means 'from'.
      • from.criteria[].operation - operations to listen for as bitfield (see IEventOperation)

  • The 'to' represents where notifications will be delivered.
    • to.thing - Thing ID of user or group interested in events
    • to.deliveryMode[] - Delivery mechanisms. Multiple values are separated by a comma.
        Valid values are:
      • "email" If the target is an IUser, an e-mail will be sent
      • "portal" If the target is an IUser, a notification will be placed in their Inbox
      • "thing" The target Thing will be instantiated and its onMessage method will be called
      • "queue" The message will be forwarded to the target ID via a JMS Queue
      • "topic" The message will be forwarded to the target ID via a JMS Topic
See Also: