Android Verizon Ads SDK Standard Edition Documentation  1.1
Classes | Public Member Functions | List of all members
InterstitialAd Class Reference

InterstitialAd is a placement used for ads that generally display in a new fullscreen window. More...

Classes

interface  InterstitialAdListener
 Interface for receiving notifications from the InterstitialAd. More...
 

Public Member Functions

void destroy ()
 Destroys the InterstitialAd and frees all associated resources. More...
 
CreativeInfo getCreativeInfo ()
 Gets a CreativeInfo object containing identifiers for the InterstitialAd’s creative and its demand source, if available. More...
 
Integer getEnterAnimationId ()
 Gets the value of the enter animation ID. More...
 
Integer getExitAnimationId ()
 Gets the value of the exit animation ID. More...
 
String getPlacementId ()
 Get the placementId for the InterstitialAd. More...
 
boolean isImmersiveEnabled ()
 Gets the value of the immersive setting. More...
 
void setEnterAnimation (final int enterAnimationId)
 Sets the behavior for entering full screen creative animation. More...
 
void setExitAnimation (final int exitAnimationId)
 Sets the behavior for exiting full screen creative animation. More...
 
void setImmersiveEnabled (final boolean immersive)
 Sets the behavior for immersive mode if the device OS is KitKat (4.4) or greater. More...
 
void show (final Context context)
 Shows the InterstitialAd. More...
 

Detailed Description

InterstitialAd is a placement used for ads that generally display in a new fullscreen window.

Member Function Documentation

◆ destroy()

void destroy ( )

Destroys the InterstitialAd and frees all associated resources.

After the ad has been destroyed, the InterstitialAd instance is no longer usable. Must be called on the main thread.

◆ getCreativeInfo()

CreativeInfo getCreativeInfo ( )

Gets a CreativeInfo object containing identifiers for the InterstitialAd’s creative and its demand source, if available.

Must be called on the main thread.

Returns
the CreativeInfo object for the ad, if available; otherwise null

◆ getEnterAnimationId()

Integer getEnterAnimationId ( )

Gets the value of the enter animation ID.

Must be called on the main thread.

Returns
the enter animation ID value

◆ getExitAnimationId()

Integer getExitAnimationId ( )

Gets the value of the exit animation ID.

Must be called on the main thread.

Returns
the exit animation ID value

◆ getPlacementId()

String getPlacementId ( )

Get the placementId for the InterstitialAd.

Must be called on the main thread.

Returns
the placementId for the InterstitialAd, or null if the ad has been destroyed or if the method is called off the main thread.

◆ isImmersiveEnabled()

boolean isImmersiveEnabled ( )

Gets the value of the immersive setting.

Must be called on the main thread.

Returns
the immersive setting value

◆ setEnterAnimation()

void setEnterAnimation ( final int  enterAnimationId)

Sets the behavior for entering full screen creative animation.

If the value is not set, no animation will be used by default. Must be called on the main thread.

Parameters
enterAnimationIdA resource ID of the animation resource to use for the incoming creative activity. Use 0 for no animation.

◆ setExitAnimation()

void setExitAnimation ( final int  exitAnimationId)

Sets the behavior for exiting full screen creative animation.

If the value is not set, no animation will be used by default. Must be called on the main thread.

Parameters
exitAnimationIdA resource ID of the animation resource to use for the outgoing creative activity. Use 0 for no animation.

◆ setImmersiveEnabled()

void setImmersiveEnabled ( final boolean  immersive)

Sets the behavior for immersive mode if the device OS is KitKat (4.4) or greater.

If immersive is not set then true will be used by default. Must be called on the main thread.

Parameters
immersivetrue for immersive, false for full screen.

◆ show()

void show ( final Context  context)

Shows the InterstitialAd.

Must be called on the main thread.

Parameters
contexta non-null context instance