Platform Events Developer Guide

Platform Events Developer Guide
Delivering Custom Notifications with Platform Events
Defining Your Custom Platform Event
Publishing Platform Events
Subscribing to Platform Events
Set Up Debug Logs
Processes
Flows
Apex Triggers
Lightning Components
CometD
Obtain a Platform Event’s Subscribers
Testing Your Platform Event in Apex
Considerations
Examples
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Subscribe to Platform Event Notifications in an Aura Component

Add the lightning:empApi component to your custom Aura component to receive platform event messages. The lightning:empApi component provides access to methods for subscribing to a streaming channel and listening to event messages.

The lightning:empApi component uses a shared CometD-based Streaming API connection, enabling you to run multiple streaming apps in the browser.

To call the component’s methods, add the lightning:empApi component inside your custom component and assign an aura:id attribute to it.

<lightning:empApi aura:id="empApi"/>

Then in the client-side controller, add functions to call the component methods.

For an example of how to use the lightning:empApi component and a complete reference, see the empApi documentation in the Lightning Component Library.

As of Spring ’19 (API version 45.0), you can build Lightning components using two programming models: the Lightning Web Components model, and the original Aura Components model. Lightning web components are custom HTML elements built using HTML and modern JavaScript. Lightning web components and Aura components can coexist and interoperate on a page. This developer guide covers Aura components only.

Note