Similar to sharing, the related API examples below will assume that the following code is implemented:
Endpoints
| Method | Description |
|---|---|
| relatedPlugin.open() | Opens the recommendations user interface. If the displayMode is set to overlay, this will pause content if it is currently playing. |
| relatedPlugin.close() | Closes the recommendations user interface. This will resume content. |
Events
| Method | Description |
|---|---|
| .on('relatedReady') | Indicates event that triggers when the Related plugin is ready. |
| relatedPlugin.on('open') | Triggers when the recommendations interface is opened. |
| relatedPlugin.on('close') | Triggers when the recommendations interface is closed. |
| relatedPlugin.on('play') | Triggers when a user selects an object in a related feed. |