Interface BannerCache
-
- All Implemented Interfaces:
public interface BannerCache
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceBannerCache.CacheDelegateOptional delegate informing about events in BannerCache.
public interfaceBannerCache.CacheStatusDelegateOptional delegate representing the cache status.
-
Method Summary
Modifier and Type Method Description abstract UnitupdateRequestConfiguration(BannerRequest requestConfiguration, Boolean shouldRefresh)Updates the configuration that will be used when requesting new banners. abstract BannerPlacementLayoutconsume()Returns an instance of BannerPlacementLayout to be used within the app. abstract BannerPlacementLayoutconsume(Boolean force)Returns an instance of BannerPlacementLayout to be used within the app. abstract UnitenableCreativeHistory(Integer size)Enables the banner creative history. abstract Array<PlacementHistoryInfo>getCreativeHistory()Retrieves the banner creative history (if it was enabled). abstract Unitdestroy()Destroys the BannerCache, clearing all preloaded banner ads and canceling pending reload requests. abstract ImpressionListenergetImpressionListener()Sets the impression listener for banner cache. abstract UnitsetImpressionListener(ImpressionListener impressionListener)Sets the impression listener for banner cache. abstract AATKit.StatisticsListenergetStatisticsListener()Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc. abstract UnitsetStatisticsListener(AATKit.StatisticsListener statisticsListener)Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc. abstract CollapsibleBannerOptionsgetCollapsibleBannerOptions()Setting for Google collapsible banners. abstract UnitsetCollapsibleBannerOptions(CollapsibleBannerOptions collapsibleBannerOptions)Setting for Google collapsible banners. abstract BannerCache.CacheStatusDelegategetCacheStatusDelegate()Delegate representing the cache status. abstract UnitsetCacheStatusDelegate(BannerCache.CacheStatusDelegate cacheStatusDelegate)Delegate representing the cache status. -
-
Method Detail
-
updateRequestConfiguration
abstract Unit updateRequestConfiguration(BannerRequest requestConfiguration, Boolean shouldRefresh)
Updates the configuration that will be used when requesting new banners.
- Parameters:
requestConfiguration- BannerRequest instance.shouldRefresh- True if the whole cache should be re-loaded with new banner request configuration, false if new configuration should only be used for new requests.
-
consume
abstract BannerPlacementLayout consume()
Returns an instance of BannerPlacementLayout to be used within the app. Also automatically counts an ad space.
BannerCache will no longer hold any references to returned banners, and they need to be destroyed manually by the app.
This method respects the frequency capping, set by BannerCacheConfiguration.setMinimumDelay
- Returns:
BannerPlacementLayout instance.
-
consume
abstract BannerPlacementLayout consume(Boolean force)
Returns an instance of BannerPlacementLayout to be used within the app. Also automatically counts an ad space. BannerCache will no longer hold any references to returned banners, and they need to be destroyed manually by the app.
- Parameters:
force- true if cache should try to return banner ignoring the frequency capping set by BannerCacheConfiguration.setMinimumDelay- Returns:
BannerPlacementLayout instance.
-
enableCreativeHistory
abstract Unit enableCreativeHistory(Integer size)
Enables the banner creative history.
-
getCreativeHistory
abstract Array<PlacementHistoryInfo> getCreativeHistory()
Retrieves the banner creative history (if it was enabled).
-
destroy
abstract Unit destroy()
Destroys the BannerCache, clearing all preloaded banner ads and canceling pending reload requests. For proper memory management, it needs to be called when the BannerCache is no longer needed. Destroyed BannerCache can no longer be used.
-
getImpressionListener
abstract ImpressionListener getImpressionListener()
Sets the impression listener for banner cache.
-
setImpressionListener
abstract Unit setImpressionListener(ImpressionListener impressionListener)
Sets the impression listener for banner cache.
-
getStatisticsListener
abstract AATKit.StatisticsListener getStatisticsListener()
Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc.
-
setStatisticsListener
abstract Unit setStatisticsListener(AATKit.StatisticsListener statisticsListener)
Sets the statistics listener that will be notified about placement reporting events, like counted adspace, request etc.
-
getCollapsibleBannerOptions
abstract CollapsibleBannerOptions getCollapsibleBannerOptions()
Setting for Google collapsible banners. Default is null, meaning disabled support for collapsible banners.
-
setCollapsibleBannerOptions
abstract Unit setCollapsibleBannerOptions(CollapsibleBannerOptions collapsibleBannerOptions)
Setting for Google collapsible banners. Default is null, meaning disabled support for collapsible banners.
-
getCacheStatusDelegate
abstract BannerCache.CacheStatusDelegate getCacheStatusDelegate()
Delegate representing the cache status.
-
setCacheStatusDelegate
abstract Unit setCacheStatusDelegate(BannerCache.CacheStatusDelegate cacheStatusDelegate)
Delegate representing the cache status.
-
-
-
-