com.pubmatic.sdk.rewardedad

Class POBDefaultRewardedAdEventHandler

java.lang.Object

com.pubmatic.sdk.rewardedad.POBDefaultRewardedAdEventHandler

All Implemented Interfaces:

com.pubmatic.sdk.openwrap.core.POBBaseEvent, POBRewardedAdEvent

public class POBDefaultRewardedAdEventHandler
extends java.lang.Object
implements POBRewardedAdEvent

Field Summary

Fields inherited from interface com.pubmatic.sdk.rewardedad.POBRewardedAdEvent

KEY_ALLOW_MULTIPLE_INSTANCES_FOR_ADUNIT_ID, KEY_IDENTIFER

Constructor Summary

Constructors

Constructor and Description
POBDefaultRewardedAdEventHandler()

Method Summary

Modifier and Type	Method and Description
void	destroy()
com.pubmatic.sdk.openwrap.core.POBRewardedAdInteractionListener	getAdInteractionListener() Returns the instance of the Fullscreen Ad interaction listener.
java.util.Map<java.lang.String,java.lang.String>	getAdServerConfig() This method will be called by POBRewardedAd, to retrieve ad server specific config from respective handlers.
java.util.List<com.pubmatic.sdk.openwrap.core.POBReward>	getAdServerRewards() This method will be called by POBRewardedAd, once the Rewarded Ad is successfully loaded.
POBRewardedAdRendering	getRenderer(java.lang.String partnerName) Optional method to provide implementation of POBRewardedAdRendering interface to render ad in custom rendering component.
com.pubmatic.sdk.openwrap.core.POBReward	getSelectedReward() To get selected rewards for current instance of Ad Server.
void	requestAd(com.pubmatic.sdk.openwrap.core.POBBid bid) Provide onOpenWrapPartnerWin() callback since this is 'No Ad Server Configuration feature'
void	setCustomData(java.util.Map<java.lang.String,java.lang.Object> customData) Sets custom data that may be required by the ad server sdk
void	setEventListener(POBRewardedAdEventListener eventListener) OpenWrap SDK calls this method to pass the EventListener to publisher.
void	show() OpenWrap SDK will call this method when publisher app calls show on POBRewardedAd.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBDefaultRewardedAdEventHandler

public POBDefaultRewardedAdEventHandler()

Method Detail

requestAd

public void requestAd(@Nullable
                      com.pubmatic.sdk.openwrap.core.POBBid bid)

Provide onOpenWrapPartnerWin() callback since this is 'No Ad Server Configuration feature'

Specified by:

requestAd in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent

Parameters:

bid - winning bid for the requested impression

destroy

public void destroy()

Specified by:

destroy in interface com.pubmatic.sdk.openwrap.core.POBBaseEvent

getAdServerConfig

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getAdServerConfig()

Description copied from interface: POBRewardedAdEvent

This method will be called by POBRewardedAd, to retrieve ad server specific config from respective handlers. These configuration will used by OpenWrapSDK to handle ad server specific workflow.

Specified by:

getAdServerConfig in interface POBRewardedAdEvent

Returns:

map with config data to be used internally by SDK

getSelectedReward

@Nullable
public com.pubmatic.sdk.openwrap.core.POBReward getSelectedReward()

Description copied from interface: POBRewardedAdEvent

To get selected rewards for current instance of Ad Server. Note: This method should be used only after setting custom data on show API. Calling this method before setting custom data on show, may return invalid reward.

Specified by:

getSelectedReward in interface POBRewardedAdEvent

Returns:

Selected Reward if present, else returns null

setEventListener

public void setEventListener(@NonNull
                             POBRewardedAdEventListener eventListener)

Description copied from interface: POBRewardedAdEvent

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

Specified by:

setEventListener in interface POBRewardedAdEvent

Parameters:

eventListener - Listener to POBRewardedAdEventListener

getRenderer

@Nullable
public POBRewardedAdRendering getRenderer(@NonNull
                                                    java.lang.String partnerName)

Description copied from interface: POBRewardedAdEvent

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

Specified by:

getRenderer in interface POBRewardedAdEvent

Parameters:

partnerName - Winning partner name

Returns:

Renderer instance to render creative

show

public void show()

Description copied from interface: POBRewardedAdEvent

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

Note: This method must be invoked from Main thread.

Specified by:

show in interface POBRewardedAdEvent

getAdInteractionListener

@Nullable
public com.pubmatic.sdk.openwrap.core.POBRewardedAdInteractionListener getAdInteractionListener()

Description copied from interface: POBRewardedAdEvent

Returns the instance of the Fullscreen Ad interaction listener. Implementation of this method is required for the Handler class integrated using mediation waterfall like MoPub event handlers for RewardedAd.

Specified by:

getAdInteractionListener in interface POBRewardedAdEvent

Returns:

instance of the POBRewardedAdInteractionListener

getAdServerRewards

@Nullable
public java.util.List<com.pubmatic.sdk.openwrap.core.POBReward> getAdServerRewards()

Description copied from interface: POBRewardedAdEvent

This method will be called by POBRewardedAd, once the Rewarded Ad is successfully loaded. Event handler should implement it and return the list of reward returned from primary ad server SDK.

Specified by:

getAdServerRewards in interface POBRewardedAdEvent

Returns:

Returns the list of available Rewards returned from the server whose bid won. It maybe OW server or the primary Ad server.

setCustomData

public void setCustomData(@Nullable
                          java.util.Map<java.lang.String,java.lang.Object> customData)

Description copied from interface: POBRewardedAdEvent

Sets custom data that may be required by the ad server sdk

Specified by:

setCustomData in interface POBRewardedAdEvent

Parameters:

customData - additional data to be passed on to the ad server sdk