Package com.pubmatic.sdk.common.session

Class POBImpDepthHandler

  • All Implemented Interfaces:
    com.pubmatic.sdk.common.session.POBAppSessionHandler.POBAppSessionListener , com.pubmatic.sdk.common.session.POBImpDepthHandling 
    
public final class POBImpDepthHandler
 implements POBImpDepthHandling, POBAppSessionHandler.POBAppSessionListener

    This class handles the impression depth for the application session. It maintains the impression count for each placement type. The impression depth is reset when the session is started.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      Unit initiate() Initiates the impression depth handling.
      Unit recordImpression(POBAdFormat placementType) Updates the impression depth map with the impression count for the given placement type.
      Integer getImpressions(POBAdFormat placementType) This method returns the impression depth for the given placement type.
      Unit onAppSessionStarted() This method is triggered when the app session begins.
      Unit onAppSessionReset() This method is triggered when the app session is reset.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • POBImpDepthHandler

        POBImpDepthHandler(POBAppSessionHandling sessionHandler)
        Parameters:
        sessionHandler - The POBApplicationSessionHandler instance.

    • Method Detail

      • initiate

         Unit initiate()

        Initiates the impression depth handling.

      • recordImpression

         Unit recordImpression(POBAdFormat placementType)

        Updates the impression depth map with the impression count for the given placement type.

        Parameters:
        placementType - The placement type for which the impression count needs to be updated.

      • getImpressions

         Integer getImpressions(POBAdFormat placementType)

        This method returns the impression depth for the given placement type.

        Returns:

        The impression depth for the given placement type.