Interface POBBidEvent
-
- All Implemented Interfaces:
@MainThread() public interface POBBidEvent
Interface definition to handle bidding events
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumPOBBidEvent.BidEventErrorEnum to maintain BidEvent error
-
Method Summary
Modifier and Type Method Description abstract voidsetBidEventListener(@Nullable() POBBidEventListener bidEventListener)Sets Bid event listener to notify bid events abstract booleanproceedToLoadAd()Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread. abstract voidproceedOnError(@NonNull() POBBidEvent.BidEventError error, @NonNull() String errorMessage)Introduced in OpenWrapSDK v3.6. abstract POBBidgetBid()Used to get bid instance -
-
Method Detail
-
setBidEventListener
abstract void setBidEventListener(@Nullable() POBBidEventListener bidEventListener)
Sets Bid event listener to notify bid events
- Parameters:
bidEventListener- reference of POBBidEventListener
-
proceedToLoadAd
abstract boolean proceedToLoadAd()
Proceeds with bid flow, This method should be called only when POBBidEventListener is set Note: Should be called from Main/UI thread. Also, unnecessary duplicate call will fail and appropriate errors will be logged with return value `false`
- Returns:
Returns the boolean value indicating success or failure.
-
proceedOnError
abstract void proceedOnError(@NonNull() POBBidEvent.BidEventError error, @NonNull() String errorMessage)
Introduced in OpenWrapSDK v3.6.0
Proceeds with error, If integration type is of primary ad server case like DFP and MoPub, the execution is continued by invoking ad server call ignoring OpenWrap's bid. In case of No ad server integration, flow is completed by setting its state to default considering error at client side. Note: Should be called from Main/UI thread
- Parameters:
error- the error of type BidEventError Example: Scenario 1 : When bid is failed in client-side in-app auction loss proceedOnError(BidEventError#CLIENT_SIDE_AUCTION_LOSS); Scenario 2 : When bid is expired proceedOnError(BidEventError#BID_EXPIRED);errorMessage- custom description for the error Example: When the bid is failed in client-side application the publisher can pass on custom message to identify the issue in logs
-
-
-
-