com.pubmatic.sdk.webrendering.mraid

Class POBMraidBridge

java.lang.Object

com.pubmatic.sdk.webrendering.mraid.POBMraidBridge

@MainThread
public class POBMraidBridge
extends java.lang.Object

Bridge class to communicate between the MRAID ad creative and

Field Summary

Fields

Modifier and Type	Field and Description
protected com.pubmatic.sdk.common.view.POBWebView	webView

Method Summary

Modifier and Type	Method and Description
protected void	addCommandHandler(com.pubmatic.sdk.webrendering.mraid.POBMRAIDCommandHandling commandHandling)
void	error(java.lang.String str) Native method to handle the error coming from MRAID ad
protected com.pubmatic.sdk.webrendering.mraid.MraidStates	getMraidState() Getter method to get mraid state
void	log(java.lang.String str) Native method to handle the logs coming from MRAID ad
void	nativeCall(java.lang.String commandScheme) Native method to handle the events/commands coming from MRAID ad
protected void	notifyError(java.lang.String errorMessage, java.lang.String action) Method is used to inform error to mraid.js
protected void	resetPropertyMap() Reset map properties
protected void	setAudioVolumePercentage(java.lang.Double volumePercentage) Method to update Device audio percentage to mraid
protected boolean	setCurrentPosition(int x, int y, int width, int height) Method to update Current position of container to mraid also check whether current position values are updated from previous or not if updated then only update to mraid js
protected void	setDefaultPosition(int x, int y, int width, int height) Method to update default position of container to mraid
protected void	setLocation(com.pubmatic.sdk.common.models.POBLocation location) Method is used to update location of device to mraid js
protected boolean	setMaxSize(int maxWidth, int maxHeight) Method to set maxWidth, maxHeight of container to mraid also check update is already happened with same values if not then updates
protected void	setMraidBridgeListener(com.pubmatic.sdk.webrendering.mraid.POBMraidBridgeListener mraidBridgeListener)
protected void	setMraidState(com.pubmatic.sdk.webrendering.mraid.MraidStates mraidState) Setter method to set mraid state
protected void	setPlacementType(java.lang.String placementType) Method to update placement type of creative to mraid
protected void	setScreenSize(int screenWidth, int screenHeight) Method to update screenWidth and screenHeight of device to mraid
protected void	setSizeChange(int width, int height) Method is used to update sizechange event with height, width to mraid.js
protected void	setSupportedFeatures(boolean sms, boolean tel, boolean calendar, boolean storePicture, boolean inlineVideo, boolean location, boolean vpaid) Method to update supported properties to mraid js
protected void	updateEvent(com.pubmatic.sdk.webrendering.mraid.MraidEvents event) Method is used to inform event to mraid.js
protected void	updateExposureChangeData(java.lang.Float visiblePercentage, org.json.JSONObject visibleRectangle) Update exposure change data of creative to mraid.js
protected void	updateMraidState(com.pubmatic.sdk.webrendering.mraid.MraidStates mraidState) Method to used state of mraid.js
protected void	updateViewable(boolean viewabilityState) Method to update POBOpenMeasurement status of ad container to mraid.js

Methods inherited from class java.lang.Object

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

Field Detail

webView

@NonNull
protected final com.pubmatic.sdk.common.view.POBWebView webView

Method Detail

nativeCall

@AnyThread
public void nativeCall(@Nullable
                                  java.lang.String commandScheme)

Native method to handle the events/commands coming from MRAID ad

Parameters:

commandScheme - command name

error

public void error(java.lang.String str)

Native method to handle the error coming from MRAID ad

Parameters:

str - error description

log

public void log(java.lang.String str)

Native method to handle the logs coming from MRAID ad

Parameters:

str - log message from JS

setMraidBridgeListener

protected void setMraidBridgeListener(@Nullable
                                      com.pubmatic.sdk.webrendering.mraid.POBMraidBridgeListener mraidBridgeListener)

addCommandHandler

protected void addCommandHandler(@NonNull
                                 com.pubmatic.sdk.webrendering.mraid.POBMRAIDCommandHandling commandHandling)

notifyError

protected void notifyError(@Nullable
                           java.lang.String errorMessage,
                           @Nullable
                           java.lang.String action)

Method is used to inform error to mraid.js

Parameters:

errorMessage - content of error

action - for which the error occured

updateEvent

protected void updateEvent(@NonNull
                           com.pubmatic.sdk.webrendering.mraid.MraidEvents event)

Method is used to inform event to mraid.js

Parameters:

event - tell the mraid.js about the current event

setSizeChange

protected void setSizeChange(int width,
                             int height)

Method is used to update sizechange event with height, width to mraid.js

Parameters:

width - of container

height - of container

updateMraidState

protected void updateMraidState(@NonNull
                                com.pubmatic.sdk.webrendering.mraid.MraidStates mraidState)

Method to used state of mraid.js

Parameters:

mraidState - state of mraid

updateViewable

protected void updateViewable(boolean viewabilityState)

Method to update POBOpenMeasurement status of ad container to mraid.js

Parameters:

viewabilityState - flag

updateExposureChangeData

protected void updateExposureChangeData(java.lang.Float visiblePercentage,
                                        org.json.JSONObject visibleRectangle)

Update exposure change data of creative to mraid.js

Parameters:

visiblePercentage - visibility of add in percentage

visibleRectangle - visibility of ad rectangle

getMraidState

@NonNull
protected com.pubmatic.sdk.webrendering.mraid.MraidStates getMraidState()

Getter method to get mraid state

Returns:

mraidState

setMraidState

protected void setMraidState(@NonNull
                             com.pubmatic.sdk.webrendering.mraid.MraidStates mraidState)

Setter method to set mraid state

Parameters:

mraidState - state of mraid

setSupportedFeatures

protected void setSupportedFeatures(boolean sms,
                                    boolean tel,
                                    boolean calendar,
                                    boolean storePicture,
                                    boolean inlineVideo,
                                    boolean location,
                                    boolean vpaid)

Method to update supported properties to mraid js

Parameters:

sms - boolean flag

tel - boolean flag

calendar - boolean flag

storePicture - boolean flag

inlineVideo - boolean flag

location - boolean flag

setPlacementType

protected void setPlacementType(@NonNull
                                java.lang.String placementType)

Method to update placement type of creative to mraid

Parameters:

placementType - value of type string

setCurrentPosition

protected boolean setCurrentPosition(int x,
                                     int y,
                                     int width,
                                     int height)

Method to update Current position of container to mraid also check whether current position values are updated from previous or not if updated then only update to mraid js

Parameters:

x - position of container

y - position of container

width - of container

height - of container

Returns:

if update happens then returns true else returns false

setDefaultPosition

protected void setDefaultPosition(int x,
                                  int y,
                                  int width,
                                  int height)

Method to update default position of container to mraid

Parameters:

x - position of container

y - position of container

width - container

height - container

setScreenSize

protected void setScreenSize(int screenWidth,
                             int screenHeight)

Method to update screenWidth and screenHeight of device to mraid

Parameters:

screenWidth - of device

screenHeight - of device

setLocation

protected void setLocation(com.pubmatic.sdk.common.models.POBLocation location)

Method is used to update location of device to mraid js

Parameters:

location - of type POBLocation

setMaxSize

protected boolean setMaxSize(int maxWidth,
                             int maxHeight)

Method to set maxWidth, maxHeight of container to mraid also check update is already happened with same values if not then updates

Parameters:

maxWidth - of container

maxHeight - of container

Returns:

if update happens returns true else returns false

setAudioVolumePercentage

protected void setAudioVolumePercentage(@Nullable
                                        java.lang.Double volumePercentage)

Method to update Device audio percentage to mraid

Parameters:

volumePercentage - of device

resetPropertyMap

protected void resetPropertyMap()

Reset map properties