This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.PubSub.Subscriber


persistent class EnsLib.PubSub.Subscriber extends EnsLib.PubSub.Target, %CSP.Util.AutoForm

SQL Table Name: EnsLib_PubSub.Subscriber

Represents a subscriber to a Publish / Subscribe list.

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Use our own domain for localization


property DomainName as DomainName (XMLNAME = "Domain", XMLPROJECTION = "ATTRIBUTE", XMLREFERENCE = "ID");
Domain value used to keep this subscriber separate from others.
Property methods: DomainNameGet(), DomainNameGetObject(), DomainNameGetObjectId(), DomainNameGetStored(), DomainNameGetSwizzled(), DomainNameIsValid(), DomainNameNewObject(), DomainNameSet(), DomainNameSetObject(), DomainNameSetObjectId(), DomainNameUnSwizzle()
relationship Subscriptions as array of Subscription (XMLPROJECTION = "NONE") [ InitialExpression = $listbuild("EnsLib.PubSub.Subscription","Subscriber",+$this,"many",1,1) , Transient , Inverse = Subscriber , Cardinality = many ];
Subscriptions for this subscriber
Property methods: SubscriptionsGet(), SubscriptionsGetObject(), SubscriptionsGetObjectId(), SubscriptionsGetSwizzled(), SubscriptionsIsEmpty(), SubscriptionsIsValid(), SubscriptionsNewObject(), SubscriptionsRClose(), SubscriptionsRExec(), SubscriptionsRFetch(), SubscriptionsRelate(), SubscriptionsSQLCompute(), SubscriptionsSet(), SubscriptionsUnRelate()


classmethod FindSubscriber(pDomain As %String = "", pName As %String) as Subscriber
Look up a subscriber object given a domain and subscriber name.
classmethod FindSubscriberId(pDomain As %String = "", pName As %String) as %String
Look up a subscriber object id given a domain and subscriber name.


query Enumerate()
SQL Query:
SELECT %ID,DomainName,Name,Target,Address FROM Subscriber ORDER BY DomainName,Name
Provide a list of subscribers.
query SubscriberList()
SQL Query:
SELECT %ID, CASE WHEN DomainName IS NULL THEN Name ELSE DomainName || '/' || Name END As Name FROM Subscriber ORDER BY (DomainName),(Name)
Provide a list of subscribers with domain names


index (NameIdx on DomainName,Name) [Unique];
Index methods: NameIdxCheck(), NameIdxCheckUnique(), NameIdxDelete(), NameIdxExists(), NameIdxOpen(), NameIdxSQLCheckUnique(), NameIdxSQLExists(), NameIdxSQLFindPKeyByConstraint(), NameIdxSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (EnsLib.PubSub.Target)


Storage Model: CacheStorage (EnsLib.PubSub.Subscriber)

FeedbackOpens in a new window