Javascript Event System - play-page-before-load-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 before the related media lists are retrieved from the server via an Ajax request.

Payload Parameters

none

Execution Interruption

If your event handler returns false, the execution will halt and the related media lists will not be loaded.

Example

function onBeforeLoadRelated() {

   // do something here

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