InlineAdView Class Reference

InlineAdView is a placement used for rectangular ads that are displayed within the screen layout, such as banners. More...

Classes
interface	InlineAdListener
	Interface for receiving notifications from the InlineAdView. More...

Public Member Functions
void	destroy ()
	Destroys the InlineAdView and frees all associated resources. More...
AdSize	getAdSize ()
	Get the supported ad size for the InlineAdView. More...
CreativeInfo	getCreativeInfo ()
	Gets a CreativeInfo object containing identifiers for the InlineAdView’s creative and its demand source, if available. More...
String	getPlacementId ()
	Get the placementId for the InlineAdView. More...
Integer	getRefreshInterval ()
	Get the refreshInterval for the InlineAdView. More...
boolean	isImmersiveEnabled ()
	Gets the value of the immersive setting. More...
boolean	isRefreshEnabled ()
	Returns true if the ad has not been destroyed and the refresh interval is greater than 0. More...
void	setImmersiveEnabled (final boolean immersive)
	Sets the behavior for immersive mode if the device OS is KitKat (4.4) or greater. More...
void	setRefreshInterval (final int refreshInterval)
	Sets the refresh interval in milliseconds. More...

Detailed Description

InlineAdView is a placement used for rectangular ads that are displayed within the screen layout, such as banners.

Member Function Documentation

destroy()

void destroy

(

)

Destroys the InlineAdView and frees all associated resources.

After the ad has been destroyed, the InlineAdView instance is no longer usable. This method must be called on the UI thread.

getAdSize()

AdSize getAdSize

(

)

Get the supported ad size for the InlineAdView.

Returns

ad size for the InlineAdView, or null if the ad has been destroyed

getCreativeInfo()

CreativeInfo getCreativeInfo

(

)

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

This method must be called on the UI thread.

Returns

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

getPlacementId()

String getPlacementId

(

)

Get the placementId for the InlineAdView.

Returns

the placementId for the InlineAdView, or null if the ad has been destroyed. This method must be called on the UI thread.

getRefreshInterval()

Integer getRefreshInterval

(

)

Get the refreshInterval for the InlineAdView.

This method must be called on the UI thread.

Returns

the refreshInterval for the InlineAdView, or null if the ad has been destroyed

isImmersiveEnabled()

boolean isImmersiveEnabled

(

)

Gets the value of the immersive setting.

This method must be called on the UI thread.

Returns

the immersive setting value

isRefreshEnabled()

boolean isRefreshEnabled

(

)

Returns true if the ad has not been destroyed and the refresh interval is greater than 0.

This method must be called on the UI thread.

Returns

true if the ad has not been destroyed and the refresh interval is greater than 0.

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. This method must be called on the UI thread.

Parameters

immersive

true for immersive, false for full screen.

setRefreshInterval()

void setRefreshInterval

(

final int

refreshInterval

)

Sets the refresh interval in milliseconds.

This method must be called on the UI thread. If the value is less than the allowed minimum and greater than 0 then the minimum value will be used.

Set to 0 to disable refreshing.

Parameters

refreshInterval

the refresh interval (in milliseconds) to set