com.pubmatic.sdk.webrendering.mraid

Class POBMraidRenderer

java.lang.Object

com.pubmatic.sdk.webrendering.mraid.POBMraidRenderer

All Implemented Interfaces:

com.pubmatic.sdk.common.ui.POBBannerRendering, com.pubmatic.sdk.common.ui.POBHtmlRendererListener

@MainThread
public class POBMraidRenderer
extends java.lang.Object
implements com.pubmatic.sdk.common.ui.POBBannerRendering, com.pubmatic.sdk.common.ui.POBHtmlRendererListener

This class is responsible for rendering and handling the events of Mraid Ads.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	POBMraidRenderer(android.content.Context context, java.lang.String placementType, POBWebView webView, int rendererId) Constructs Mraid Renderer with necessary initialization

Method Summary

Modifier and Type	Method and Description
static POBMraidRenderer	createInstance(android.content.Context context, java.lang.String placementType, int rendererId)
void	destroy() Callback method to clean up mraid renderer resources.
void	invalidateExpiration()
boolean	isUserInteracted(boolean overrideClickState) Returns true if user has recently touch/click on web view.
void	onAdInteractionStarted() Notifies Mraid ad interaction onStart or ad Open
void	onAdInteractionStopped() Notifies Mraid ad interaction onStart or ad closed
void	onAdUnload() Notifies event for Mraid Unload to the implemented class(PMBannerRenderer)
void	onAdViewChanged(android.view.View adView) Notifies updated Ad view for viewability measurement events.
void	onLeavingApplication() Notifies Mraid ad App is leaving.
void	onMRAIDAdClick() Notifies Mraid ad click event about to happen.
void	onObstructionAdded(android.view.View obstructionView) Notifies about any obstruction displayed on Ad view
void	onObstructionRemoved(android.view.View obstructionView) To remove existing obstruction on current Ad view.
void	onOpen(java.lang.String url) Gets called when MRAID open event about to happen.
void	onViewClicked(java.lang.String url)
void	onViewRendered(android.view.View view) Callback method, gets called when renderer is about to complete its loading.
void	onViewRenderingFailed(com.pubmatic.sdk.common.POBError error)
void	renderAd(com.pubmatic.sdk.common.base.POBAdDescriptor descriptor)
void	setAdRendererListener(com.pubmatic.sdk.common.base.POBAdRendererListener listener) To set renderer list to get renderer callbacks
void	setBaseURL(java.lang.String baseURL) To set base url, used to render html content on WebWiew
void	setHTMLMeasurementListener(com.pubmatic.sdk.common.viewability.POBHTMLMeasurementProvider openMeasurementListener) Setter provides measurement callback to implementation class
void	setRenderingTimeout(int renderingTimeout) To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error.
void	signalImpressionEvent() Method to signal events to measurement provider

Methods inherited from class java.lang.Object

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

Constructor Detail

POBMraidRenderer

protected POBMraidRenderer(@NonNull
                           android.content.Context context,
                           @NonNull
                           java.lang.String placementType,
                           @NonNull
                           POBWebView webView,
                           int rendererId)

Constructs Mraid Renderer with necessary initialization

Parameters:

context - android context

placementType - ad placement type

Method Detail

createInstance

@Nullable
public static POBMraidRenderer createInstance(@NonNull
                                                        android.content.Context context,
                                                        @NonNull
                                                        java.lang.String placementType,
                                                        int rendererId)

setRenderingTimeout

public void setRenderingTimeout(int renderingTimeout)

To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error. In order to execute properly set before renderAd(POBAdDescriptor) For default value see POBCommonConstants.MAX_RENDER_TIMEOUT_IN_SEC

Parameters:

renderingTimeout - the timeout in seconds.

setBaseURL

public void setBaseURL(@Nullable
                       java.lang.String baseURL)

To set base url, used to render html content on WebWiew

Parameters:

baseURL - the URL to use as the WebView's base URL

setHTMLMeasurementListener

public void setHTMLMeasurementListener(com.pubmatic.sdk.common.viewability.POBHTMLMeasurementProvider openMeasurementListener)

Setter provides measurement callback to implementation class

Parameters:

openMeasurementListener - reference of POBHTMLMeasurementProvider

onOpen

public void onOpen(java.lang.String url)

Gets called when MRAID open event about to happen. Handles Opening url and notifies it to mraidRendererListener

Parameters:

url - the url on which mraid open event happened.

isUserInteracted

public boolean isUserInteracted(boolean overrideClickState)

Returns true if user has recently touch/click on web view. It sets the internal interaction state to false until user interacted again.

Parameters:

overrideClickState - boolean value for click state

Returns:

Returns true if user has recently touch/click on web view else return false

onAdInteractionStarted

public void onAdInteractionStarted()

Notifies Mraid ad interaction onStart or ad Open

onAdInteractionStopped

public void onAdInteractionStopped()

Notifies Mraid ad interaction onStart or ad closed

onLeavingApplication

public void onLeavingApplication()

Notifies Mraid ad App is leaving.

onMRAIDAdClick

public void onMRAIDAdClick()

Notifies Mraid ad click event about to happen.

onAdUnload

public void onAdUnload()

Notifies event for Mraid Unload to the implemented class(PMBannerRenderer)

onAdViewChanged

public void onAdViewChanged(android.view.View adView)

Notifies updated Ad view for viewability measurement events.

Parameters:

adView - updated Ad view

onObstructionAdded

public void onObstructionAdded(@NonNull
                               android.view.View obstructionView)

Notifies about any obstruction displayed on Ad view

Parameters:

obstructionView - obstruction view

onObstructionRemoved

public void onObstructionRemoved(@Nullable
                                 android.view.View obstructionView)

To remove existing obstruction on current Ad view.

Parameters:

obstructionView - obstruction view

renderAd

public void renderAd(@NonNull
                     com.pubmatic.sdk.common.base.POBAdDescriptor descriptor)

Specified by:

renderAd in interface com.pubmatic.sdk.common.ui.POBBannerRendering

setAdRendererListener

public void setAdRendererListener(com.pubmatic.sdk.common.base.POBAdRendererListener listener)

To set renderer list to get renderer callbacks

Specified by:

setAdRendererListener in interface com.pubmatic.sdk.common.ui.POBBannerRendering

Parameters:

listener - ad renderer listener

destroy

public void destroy()

Callback method to clean up mraid renderer resources. Note: Should be called from UI thread.

Specified by:

destroy in interface com.pubmatic.sdk.common.ui.POBBannerRendering

invalidateExpiration

public void invalidateExpiration()

Specified by:

invalidateExpiration in interface com.pubmatic.sdk.common.ui.POBBannerRendering

onViewRendered

public void onViewRendered(@NonNull
                           android.view.View view)

Callback method, gets called when renderer is about to complete its loading.

Specified by:

onViewRendered in interface com.pubmatic.sdk.common.ui.POBHtmlRendererListener

Parameters:

view - Rendered view for which loading is completed.

signalImpressionEvent

public void signalImpressionEvent()

Method to signal events to measurement provider

onViewRenderingFailed

public void onViewRenderingFailed(@NonNull
                                  com.pubmatic.sdk.common.POBError error)

Specified by:

onViewRenderingFailed in interface com.pubmatic.sdk.common.ui.POBHtmlRendererListener

onViewClicked

public void onViewClicked(@Nullable
                          java.lang.String url)

Specified by:

onViewClicked in interface com.pubmatic.sdk.common.ui.POBHtmlRendererListener