Pulse SDK API Documentation

Interface: PauseAd

OO.Pulse. PauseAd

This interface is used to interact with pause ads received from a OO.Pulse.Session.

Pause ads are displayed when the user pauses the content and are automatically hidden when the content is resumed. They can also be closed while content is paused.

Methods

adClickThroughTriggered()

Notify the SDK that the pause ad was clicked.

adClosed()

Notify the SDK that the pause ad was closed via a close button.

adDisplayed()

Call this method when the ad is displayed.

adFailedWithError(error)

Notify the SDK that there was an error displaying the pause ad.

Parameters:
Name Type Description
error OO.PulseAdError

The OO.PulseAdError that best describes the problem.

getClickthroughURL()

Get the ad's clickthrough URL.

Returns:

the URL to open when the ad is clicked.

Type
string

getCoreAd()

Returns the underlying low-level core Ad object. Advanced use only! In most cases, you do not need this.

Returns:

The underlying core Ad object.

Type
videoplaza.adresponse.Ad

getResourceMimeType()

Get the ad resource mime type. Images or swf files can be used as pause ads.

Returns:

The resource's mime type.

Type
string

getResourceURL()

Get the pause ad's resource URL.

Returns:

The URL of the resource to display.

Type
string

getType()

Get the pause ad type.

Returns:

the pause ad type.

Type
string