Javascript Event System - play-page-before-display-related-media

From KickApps Documentation

Jump to: navigation, search

This article pertains to the Javascript Event System. You can refer to our list of Javascript Event System Supported Events to learn what else you can do with our event system.

Contents

Summary

This event is fired after a user clicks on a related media list and before the list is displayed.

Payload Parameters

listElement
(jQuery) The list to be displayed.

Execution Interruption

If your event handler returns false, the execution will halt and the list will not be displayed.

Example

function onBeforeDisplayRelated(data) {

   // do something here
   console.log(data.listElement)

} var newEventId = Ka.events.listen('play-page-before-display-related-media', onBeforeDisplayRelated);