admob-cmp-core/dev.avinya.ads/BannerAdController

BannerAdController

Controls a single banner ad placement. Handles loading, refresh, and lifecycle. For Compose UI, prefer BannerAdView which manages the controller automatically.

Properties

events

abstract val events: SharedFlow<AdEvent>

Shared flow of banner lifecycle events.

loadState

abstract val loadState: StateFlow<AdLoadState>

Current load state of the banner ad.

placement

abstract val placement: AdPlacement

The placement this controller is bound to.

Functions

attachAndroidBanner

fun BannerAdController.attachAndroidBanner()

attachIosBanner

fun BannerAdController.attachIosBanner()

clear

abstract fun clear()

Clears the loaded ad and releases resources.

currentAndroidBannerAd

fun BannerAdController.currentAndroidBannerAd(): BannerAd?

currentAndroidBannerView

fun BannerAdController.currentAndroidBannerView(): AdView?

currentIosBannerView

fun BannerAdController.currentIosBannerView(): GADBannerView?

detachAndroidBanner

fun BannerAdController.detachAndroidBanner()

detachIosBanner

fun BannerAdController.detachIosBanner()

load

abstract suspend fun load(geometry: BannerGeometry? = null, sizePolicy: AdSizePolicy = placement.bannerSizePolicy, requestOptions: AdRequestOptions = placement.requestOptions): AdLoadState

Loads a banner sized for geometry using sizePolicy and requestOptions.

refresh

abstract suspend fun refresh(): AdLoadState

Reloads the banner, replaying the geometry, size policy AND request options resolved by the most recent load. Fails if nothing has been loaded yet.

registerAndroidBannerGeometry

fun BannerAdController.registerAndroidBannerGeometry(geometry: BannerGeometry, sizePolicy: AdSizePolicy, requestOptions: AdRequestOptions)

registerIosBannerGeometry

fun BannerAdController.registerIosBannerGeometry(geometry: BannerGeometry, sizePolicy: AdSizePolicy, requestOptions: AdRequestOptions)