Package com.pubmatic.sdk.openwrap.banner

Class POBBannerEvent

  • All Implemented Interfaces:
    
public abstract class POBBannerEvent
extends POBBaseEvent

    The banner custom event abstract class. Your banner custom event handler must implement this class to communicate with ad server SDK.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description
      POBBannerEvent()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract void setEventListener(@NonNull() POBBannerEventListener listener) OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.
      POBBannerRendering getRenderer(@Nullable() String partnerName) OpenWrap SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component.
      POBAdSize getAdSize() OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK
      Array<POBAdSize> requestedAdSizes() OpenWrap SDK calls this method to get the size for which ad request should be made.
      POBBaseAdInteractionListener getAdInteractionListener() Returns the instance of the Inline Ad interaction listener.
      View getAdServerView() To retrieve ad server ad view

      • Methods inherited from class com.pubmatic.sdk.openwrap.core.POBBaseEvent

        destroy, requestAd

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBBannerEvent

        POBBannerEvent()

    • Method Detail

      • setEventListener

         abstract void setEventListener(@NonNull() POBBannerEventListener listener)

        OpenWrap SDK calls this method to set POBBannerEventListener, so OpenWrap custom event handler can inform the OpenWrap SDK about the events related to the ad server communication.

        Save the `listener` to use it in later phases of ad server events execution

        Parameters:
        listener - object conforming to POBBannerEventListener

      • getRenderer

        @Nullable() POBBannerRendering getRenderer(@Nullable() String partnerName)

        OpenWrap SDK calls this method to get the implementation of POBBannerRendering interface to render ad in custom rendering component. If not implemented, the OpenWrap SDK internally creates its own renderer, capable of handling simple HTML and MRAID creative.

        Parameters:
        partnerName - name of the partner associated with the winning bid
        Returns:

        renderer object conforming to `POBBannerRendering` interface

      • getAdSize

        @Nullable() POBAdSize getAdSize()

        OpenWrap SDK calls this method to get the size of the ad rendered by the ad server SDK

        Returns:

        Ad size of the rendered creative

      • requestedAdSizes

        @Nullable() Array<POBAdSize> requestedAdSizes()

        OpenWrap SDK calls this method to get the size for which ad request should be made.

        Returns:

        Array of POBAdSize

      • getAdInteractionListener

        @Nullable() POBBaseAdInteractionListener getAdInteractionListener()

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

        Returns:

        instance of the Inline Ad interaction listener