subscribe(eventType, subscriptionItem, subscriptionItemName, subscribeOnce, contextName)

Updated on July 20, 2021

Notifies a subscription item whenever an event occurs in a specific context.

Returns

Not applicable.

Name	Type	Description	Required
eventType	string	The type of event.	✅
subscriptionItem	function	The item that needs to be notified.	✅
subscriptionItemName	string	A unique ID or name assigned by the user to identify the subscription item.	✅
subscribeOnce	boolean	The flag that determines if the subscription item should be notified only once. Note: The default value is false. Set `subscribeOnce` to true if you want to notify the subscription item only once.	❌
contextName	string	The name of the context containing the event whose subscription item must be notified. Note: You must update to Pega 8.7.2 or later patches to be able to use this parameter. The default value of `contextName` is `app`.	❌

In this example, the API notifies the subscriptionItem item whenever an event of type eventType occurs.

PCore.getPubSubUtils().subscribe(eventType, subscriptionItem, subscriptionItemName);

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center