Constructor Detail

• POBIcon

  POBIcon()

Method Detail

• getProgram

  @Nullable() String getProgram()

• build

   void build(@NonNull() POBNodeBuilder builder)

  POBXMLParser calls this method to build model class object with node builder

  Parameters:

  builder - Instance of POBNodeBuilder, to be used for building the model class object

• getXPosition

  @Nullable() String getXPosition()

  Returns the x-coordinate of the top, left corner of the icon asset relative to the ad display area. Values of "left" or "right" also accepted and indicate the leftmost or rightmost available position for the icon asset.

  Returns:

  x-coordinate of the icon

• getYPosition

  @Nullable() String getYPosition()

  Returns the y-coordinate of the top left corner of the icon asset relative to the ad display area; values of "top" or "bottom" also accepted and indicate the topmost or bottommost available position for the icon asset.

  Returns:

  y-coordinate of the icon

• getApiFramework

  @Nullable() String getApiFramework()

  The API necessary to communicate with the creative if available

  Returns:

  api framework

• getResource

  @Nullable() POBResource getResource()

  Resources to be displayed

  Returns:

  POBResource object

• getClickThroughURL

  @Nullable() String getClickThroughURL()

  A URI to open when companion ad is clicked.

  Returns:

  click through URL

• getClickTrackers

  @Nullable() List<String> getClickTrackers()

  A URI to notify the player that icon view is clicked.

  Returns:

  click tracking URL

• getViewTrackers

  @Nullable() List<String> getViewTrackers()

  A URI to notify the player that icon is loaded.

  Returns:

  view tracking URL

• getRenderableContent

  @Nullable() String getRenderableContent()

  Returns the content to be render as an Icon.

  Returns:

  Renderable content

• isVideo

   boolean isVideo()

• isCompanion

   boolean isCompanion()

• getContentWidth

   int getContentWidth()

  Returns the width of the icon.

  Returns:

  width of icon

• getContentHeight

   int getContentHeight()

  Returns the height of the icon.

  Returns:

  height of icon

• getRawBid

  @Nullable() JSONObject getRawBid()

  Not supported for Icon

  Returns:

  Returns null for the icon

• getRefreshInterval

   int getRefreshInterval()

  Not supported for Icon

  Returns:

  Returns 0 for the icon

• getId

  @Nullable() String getId()

  Returns null as default implementation

  Returns:

  null as default implementation

• getCreativeType

  @Nullable() String getCreativeType()

• getStatus

   int getStatus()

• getTargetingInfo

  @Nullable() Map<String, String> getTargetingInfo()

• buildWithRefreshAndExpiryTimeout

  @Nullable() POBAdDescriptor buildWithRefreshAndExpiryTimeout(int refreshInterval, int expiryTimeout)

• getBundle

  @Nullable() String getBundle()

• getPaidBy

  @Nullable() String getPaidBy()

• enableDsaInfoIcon

   boolean enableDsaInfoIcon()

• getDisplayedOnBehalfOf

  @Nullable() String getDisplayedOnBehalfOf()

• getTransparencyData

  @Nullable() List<POBDSATransparencyInfo> getTransparencyData()

• getImpressionCountingMethod

  @NonNull() POBImpressionCountingMethod getImpressionCountingMethod()

• getOffset

   int getOffset()

  Returns the time of delay in seconds from when the associated linear creative begins playing to when the icon should be displayed; In VAST, it is provided in the format of HH:MM:SS.mmm or HH:MM:SS

  Returns:

  Icon offset

• getDuration

   int getDuration()

  Returns the duration the icon (in seconds) that should be displayed unless clicked or ad is finished playing; In VAST, it is provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm is milliseconds and optional.

  Returns:

  Icon duration