com.pubmatic.sdk.openbid.interstitial

Interface POBInterstitialEvent

All Known Implementing Classes:

POBDefaultInterstitialEventHandler

public interface POBInterstitialEvent

The OpenBid interstitial custom event interface. Your interstitial custom event handler must implement this interface to communicate with ad server SDK.

Method Summary

Modifier and Type	Method and Description
void	destroy() OpenBid SDK calls this method to perform any final cleanup.
com.pubmatic.sdk.webrendering.ui.POBInterstitialRendering	getRenderer(java.lang.String partnerName) Optional method to provide implementation of POBInterstitialRendering interface to render ad in custom rendering component.
void	requestAd(POBBid bid) OpenBid SDK calls this method to make a request to primary SDK.
void	setEventListener(POBInterstitialEventListener listener) OpenBid SDK calls this method to pass the EventListener to publisher.
void	show() OpenBid SDK will call this method when publisher app calls show on POBInterstitial.

Method Detail

requestAd

void requestAd(POBBid bid)

OpenBid SDK calls this method to make a request to primary SDK. OpenBid SDK passes the winning bid for the requested impression. Publisher needs to pass the details as a targeting parameter to primary SDK

Parameters:

bid - winning bid for the requested impression

setEventListener

void setEventListener(POBInterstitialEventListener listener)

OpenBid SDK calls this method to pass the EventListener to publisher. Publisher can refer the listener for passing the primary SDK's event to OpenBid SDK.

Parameters:

listener - event listener

getRenderer

com.pubmatic.sdk.webrendering.ui.POBInterstitialRendering getRenderer(java.lang.String partnerName)

Optional method to provide implementation of POBInterstitialRendering interface to render ad in custom rendering component. If not implemented i.e. returning null, the OpenBid SDK internally creates its own renderer capable of handling simple HTML and MRAID creative

Parameters:

partnerName - Winning partner name

Returns:

Renderer instance to render creative

show

void show()

OpenBid SDK will call this method when publisher app calls show on POBInterstitial. Consumer of this method should call show() of primary ad server SDK.

destroy

void destroy()

OpenBid SDK calls this method to perform any final cleanup.