Package com.thingworx.subscriptions

Class BaseSubscription

java.lang.Object

com.thingworx.types.events.EventDescriptor

com.thingworx.subscriptions.BaseSubscription

All Implemented Interfaces:

IDiffableObject, IAspectContainer, INamedObject, Cloneable

Direct Known Subclasses:

Subscription

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class BaseSubscription
extends EventDescriptor
implements IAspectContainer, INamedObject, Cloneable

Constructor Summary

Constructors

Constructor	Description
BaseSubscription()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()	Gets the name of the subscription.
boolean	isAsync()
boolean	isEnabled()

Methods inherited from class com.thingworx.types.events.EventDescriptor

getAlertName, getEventDescriptor, getEventName, getSource, getSourceProperty, isAlertEvent, isAnyEvent, isPostCommitEvent, isPropertyEvent, setAlertName, setEventName, setSource, setSourceProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseSubscription

public BaseSubscription()

Initializes this instace with default values.

Method Details

getName

@ThingworxExtensionApiMethod(since={8,4})
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

getDescription

@ThingworxExtensionApiMethod(since={8,4})
public String getDescription()

Specified by:

getDescription in interface INamedObject

isEnabled

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

isAsync

@ThingworxExtensionApiMethod(since={6,6})
public boolean isAsync()