com.pubmatic.sdk.webrendering.mraid

Class POBMraidController

java.lang.Object

com.pubmatic.sdk.webrendering.mraid.POBMraidController

All Implemented Interfaces:

POBAdVisibilityListener

@MainThread
public class POBMraidController
extends java.lang.Object
implements POBAdVisibilityListener

Controller class to implement the MRAID core features like expand, resize etc.

Method Summary

Modifier and Type	Method and Description
void	close() Close the expanded / resized ad.
void	createCalendarEvent(org.json.JSONObject calendarEvent, boolean userInteracted) Creates the calendar event using default calendar app.
void	destroy() Performs the resource cleanup
void	expand(java.lang.String uri, boolean userInteracted) Expands the MRAID ad as a full screen
boolean	isUserInteracted(boolean overrideClickState) Returns true if user has recently touch/click on MRAID web view.
void	listenerChanged(java.lang.String key, boolean hasListener) Handles the state of the listener based on provide key and state
void	onVisibilityChange(boolean visibility) Notifies about the ad visibility state
void	open(java.lang.String url, boolean userInteracted) Opens the url as a landing page in internal/external browser.
void	playVideo(java.lang.String url, boolean userInteracted) Play video inside native player using given media url
void	resize(int width, int height, int offsetX, int offsetY, boolean allowOffscreen, boolean userInteracted) Resize the creative view as per provided size
void	setOrientation(boolean allowOrientationChange, java.lang.String forceOrientation, boolean userInteracted) Set the orientation of the current activity
void	storePicture(java.lang.String url, boolean userInteracted) Download and store the image with given URL
void	unload() Unloads the current MRAID creative and notify banner to make a call to new ad request

Methods inherited from class java.lang.Object

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

Method Detail

destroy

public void destroy()

Performs the resource cleanup

open

public void open(java.lang.String url,
                 boolean userInteracted)

Opens the url as a landing page in internal/external browser.

Parameters:

url - Landing page url.

expand

public void expand(@Nullable
                   java.lang.String uri,
                   boolean userInteracted)

Expands the MRAID ad as a full screen

Parameters:

uri - If url is passed then expand as a two-part else consider single part expand.

close

public void close()

Close the expanded / resized ad.

setOrientation

public void setOrientation(boolean allowOrientationChange,
                           java.lang.String forceOrientation,
                           boolean userInteracted)

Set the orientation of the current activity

Parameters:

allowOrientationChange - Check if orientation change is allowed or not

forceOrientation - set the provided orientation to activity

storePicture

public void storePicture(java.lang.String url,
                         boolean userInteracted)

Download and store the image with given URL

Parameters:

url - image url.

createCalendarEvent

public void createCalendarEvent(org.json.JSONObject calendarEvent,
                                boolean userInteracted)

Creates the calendar event using default calendar app.

Parameters:

calendarEvent - Calendar event

resize

public void resize(int width,
                   int height,
                   int offsetX,
                   int offsetY,
                   boolean allowOffscreen,
                   boolean userInteracted)

Resize the creative view as per provided size

Parameters:

width - New resized width of an ad

height - New resized height of an ad

offsetX - New x-offset of an ad

offsetY - New y-offset of an ad

allowOffscreen - state to allow screen off

playVideo

public void playVideo(java.lang.String url,
                      boolean userInteracted)

Play video inside native player using given media url

Parameters:

url - media url to play video

isUserInteracted

public boolean isUserInteracted(boolean overrideClickState)

Returns true if user has recently touch/click on MRAID web view.

Returns:

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

unload

public void unload()

Unloads the current MRAID creative and notify banner to make a call to new ad request

listenerChanged

public void listenerChanged(java.lang.String key,
                            boolean hasListener)

Handles the state of the listener based on provide key and state

Parameters:

key - Name of the listener

hasListener - true if listener needs to be attached and false if needs to be detach/remove

onVisibilityChange

public void onVisibilityChange(boolean visibility)

Notifies about the ad visibility state

Specified by:

onVisibilityChange in interface POBAdVisibilityListener

Parameters:

visibility - true if visibility is Gained and false if visibility looses.