mPulse Boomerang

BOOMR.plugins. CrossDomain

This plugin enables cross-domain session tracking.

For information on how to include this plugin, see the Building tutorial.

Setup

The primary domain needs to host a known HTML file that will load Boomerang and can communicate via postMessage() to other domains so session information such as ID and length can be coordinated between all of the domains.

Beacon Parameters

This plugin adds the following parameters to the beacon:

  • rt.sstr_dur: Session transfer duration (ms)
  • rt.sstr_to: The session transfer timed out (1 or missing)

Methods

init(config)

Initializes the plugin.

Parameters:

Name Type Description
config object

Configuration

Properties
Name Type Argument Default Description
CrossDomain.cross_domain_url string <optional>
 ""

Cross domain IFRAME URL
CrossDomain.sending boolean <optional>
 false

Whether or not this is the parent domain
CrossDomain.session_transfer_timeout number <optional>
 5000

Session transfer timeout (ms)
CrossDomain.debug boolean <optional>
 false

Enable debugging

Returns:

BOOMR.plugins.CrossDomain The CrossDomain plugin for chaining

is_complete()

Whether or not this plugin is complete

Returns:

Type: boolean

true if the plugin is complete