Packagecom.distriqt.extension.adverts
Interfacepublic interface InterstitialAd extends flash.events.IEventDispatcher



Public Methods
 MethodDefined By
  
destroy():void
Destroy the ad view.
InterstitialAd
  
getAdUnitId():String
Returns the ad unit ID.
InterstitialAd
  
hide():Boolean
Hides a previously shown interstitial advert.
InterstitialAd
  
isLoaded():Boolean
Indicates the interstitial has been loaded and is ready to be displayed.
InterstitialAd
  
isLoading():Boolean
Returns true if the ad is loading.
InterstitialAd
  
load(request:AdRequest):void
Starts loading the ad on a background thread.
InterstitialAd
  
setAdUnitId(adUnitId:String):void
Sets the ad unit ID.
InterstitialAd
  
show():Boolean
Displays the loaded interstitial.
InterstitialAd
Events
 Event Summary Defined By
   Dispatched when the full screen content ad was dismissed (closed) InterstitialAd
   Dispatched when there was an error attempting to show the full screen content ad InterstitialAd
   Dispatched when a full screen content ad is shown InterstitialAd
   Dispatched if the ad failed to load.InterstitialAd
   This event is dispatched when an ad has finished loading.InterstitialAd
   Dispatched when an impression occurs that results in revenue data.InterstitialAd
Method Detail
destroy()method
public function destroy():void

Destroy the ad view. No other methods should be called on the ad view after destroy() is called.

getAdUnitId()method 
public function getAdUnitId():String

Returns the ad unit ID.

Returns
String
hide()method 
public function hide():Boolean

Hides a previously shown interstitial advert.

This may return false if the interstitial is not displayed or if it cannot be dismissed programatically.

Returns
Boolean
isLoaded()method 
public function isLoaded():Boolean

Indicates the interstitial has been loaded and is ready to be displayed. You can check this flag before calling show

Returns
Booleantrue if the interstitial is ready to be displayed
isLoading()method 
public function isLoading():Boolean

Returns true if the ad is loading.

Returns
Booleantrue if the ad is loading
load()method 
public function load(request:AdRequest):void

Starts loading the ad on a background thread.

Parameters

request:AdRequest

setAdUnitId()method 
public function setAdUnitId(adUnitId:String):void

Sets the ad unit ID.

Parameters

adUnitId:String

show()method 
public function show():Boolean

Displays the loaded interstitial. You should check if the interstitial is ready before attempting to display the advert.

Returns
Booleantrue if the interstitial was displayed and false if it wasn't loaded or ready to be displayed
Event Detail
fullscreencontent_dismissed Event
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.DISMISSED

Dispatched when the full screen content ad was dismissed (closed)
fullscreencontent_failedtoshow Event  
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.FAILED_TO_SHOW

Dispatched when there was an error attempting to show the full screen content ad
fullscreencontent_show Event  
Event Object Type: com.distriqt.extension.adverts.events.FullScreenContentEvent
FullScreenContentEvent.type property = com.distriqt.extension.adverts.events.FullScreenContentEvent.SHOW

Dispatched when a full screen content ad is shown
interstitial:error Event  
Event Object Type: com.distriqt.extension.adverts.events.InterstitialAdEvent
InterstitialAdEvent.type property = com.distriqt.extension.adverts.events.InterstitialAdEvent.ERROR

Dispatched if the ad failed to load.

interstitial:loaded Event  
Event Object Type: com.distriqt.extension.adverts.events.InterstitialAdEvent
InterstitialAdEvent.type property = com.distriqt.extension.adverts.events.InterstitialAdEvent.LOADED

This event is dispatched when an ad has finished loading.

If you want to delay displaying an ad until you're sure an ad will be loaded you should wait for this event before adding the view.

paidevent_paid Event  
Event Object Type: com.distriqt.extension.adverts.events.PaidEvent
PaidEvent.type property = com.distriqt.extension.adverts.events.PaidEvent.PAID

Dispatched when an impression occurs that results in revenue data. By implementing this handler, you can use the data to calculate a user's life time value, or forward the data downstream to other relevant systems.