Package com.adcolony.sdk

Class AdColonyInterstitial

java.lang.Object

com.adcolony.sdk.AdColonyInterstitial

public class AdColonyInterstitial
extends java.lang.Object

Represents an interstitial advertisement. Instances of this class are returned in response to a successful ad request via AdColony.requestInterstitial(String, AdColonyInterstitialListener, AdColonyAdOptions).

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADCOLONY_IAP_ENGAGEMENT_END_CARD
static int	ADCOLONY_IAP_ENGAGEMENT_OVERLAY

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels the fullscreen interstitial and returns control to your app.
boolean	destroy()	Removes internal reference of this ad object to allow for collection.
AdColonyInterstitialListener	getListener()
java.lang.String	getViewNetworkPassFilter()
java.lang.String	getZoneID()	Used to retrieve the zone identifier tied to this ad object.
boolean	isExpired()	AdColony interstitials become expired as soon as the ad launches or just before they have met their expiration time.
void	setListener(AdColonyInterstitialListener listener)
void	setViewNetworkPassFilter(java.lang.String viewNetworkPassFilter)
boolean	show()	Called to display a fullscreen interstitial advertisement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADCOLONY_IAP_ENGAGEMENT_END_CARD

public static final int ADCOLONY_IAP_ENGAGEMENT_END_CARD

See Also:

Constant Field Values

ADCOLONY_IAP_ENGAGEMENT_OVERLAY

public static final int ADCOLONY_IAP_ENGAGEMENT_OVERLAY

See Also:

Constant Field Values

Method Detail

show

public boolean show()

Called to display a fullscreen interstitial advertisement. The ad will not be shown if it has expired or if it has already been shown.

Returns:

whether or not the command was successful. Will return false if the ad has been shown, if the ad has expired, or if an interstitial is already being displayed.

cancel

public boolean cancel()

Cancels the fullscreen interstitial and returns control to your app.

Returns:

whether or not the command was successful. Will return false if the interstitial is not currently being displayed.

getListener

public AdColonyInterstitialListener getListener()

Returns:

the AdColonyInterstitialListener currently tied to this ad object.

See Also:

AdColonyInterstitialListener

setListener

public void setListener(AdColonyInterstitialListener listener)

Parameters:

listener - the AdColonyInterstitialListener that you wish to tie to this ad object to be alerted of ad level events.

See Also:

AdColonyInterstitialListener

getZoneID

public java.lang.String getZoneID()

Used to retrieve the zone identifier tied to this ad object. Will always match the zone id that was passed via AdColony.requestInterstitial(String, AdColonyInterstitialListener, AdColonyAdOptions)

Returns:

the zone identifier tied to this ad object.

isExpired

public boolean isExpired()

AdColony interstitials become expired as soon as the ad launches or just before they have met their expiration time.

Returns:

boolean describing whether or not the interstitial has been played or if it has met its expiration time.

destroy

public boolean destroy()

Removes internal reference of this ad object to allow for collection. No methods should be called on this ad object after destroy.

getViewNetworkPassFilter

public java.lang.String getViewNetworkPassFilter()

setViewNetworkPassFilter

public void setViewNetworkPassFilter(java.lang.String viewNetworkPassFilter)