admanagekit-compose/com.i2hammad.admanagekit.compose

Package-level declarations

Types

Link copied to clipboard
object AdManageKitCompose

Configuration object for AdManageKit Compose components.

Link copied to clipboard
data class CacheConfig(val expiryMs: Long, val maxAdsPerUnit: Int, val cleanupEnabled: Boolean)

Data class representing cache configuration for display purposes.

Link copied to clipboard
@Stable
class InterstitialAdState(adUnitId: String, context: ComponentActivity)

State holder for interstitial ad management in Compose.

Link copied to clipboard
enum InterstitialShowMode : Enum<InterstitialShowMode>

Enum defining different modes for showing interstitial ads.

Link copied to clipboard
enum NativeAdSize : Enum<NativeAdSize>

Native ad size types for Compose

Functions

Link copied to clipboard
@Composable
fun AdManageKitInitEffect(analytics: FirebaseAnalytics? = null)

A Compose effect for initializing AdManageKit with Firebase Analytics.

Link copied to clipboard
@Composable
fun BannerAdCompose(adUnitId: String, modifier: Modifier = Modifier, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A Jetpack Compose wrapper for BannerAdView from AdManageKit.

@Composable
fun BannerAdCompose(adUnitId: String, width: Dp, height: Dp, modifier: Modifier = Modifier, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A Jetpack Compose wrapper for BannerAdView with custom dimensions.

Link copied to clipboard
@Composable
fun CacheWarmingEffect(adUnits: Map<String, Int>, onComplete: (Int, Int) -> Unit? = null)

A Compose effect for managing native ad cache warming.

Link copied to clipboard
@Composable
fun ConditionalAd(showWhenPurchased: Boolean = false, content: @Composable () -> Unit)

Composable function to conditionally render ads based on purchase status.

Link copied to clipboard
fun Modifier.conditionalAd(showAd: Boolean, adModifier: Modifier = androidx.compose.ui.Modifier): Modifier

A Compose modifier extension for conditional ad display based on purchase status.

Link copied to clipboard
@Composable
fun InterstitialAdEffect(adUnitId: String, showMode: InterstitialShowMode = InterstitialShowMode.TIME, maxDisplayCount: Int = 3, onAdShown: () -> Unit? = null, onAdDismissed: () -> Unit? = null, onAdFailedToLoad: (String) -> Unit? = null)

A Compose effect for managing interstitial ads with automatic display logic.

Link copied to clipboard
@Composable
fun NativeAdCompose(adUnitId: String, size: NativeAdSize = NativeAdSize.SMALL, modifier: Modifier = Modifier, useCachedAd: Boolean = true, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A Jetpack Compose wrapper for native ads from AdManageKit.

Link copied to clipboard
@Composable
fun NativeBannerMediumCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A medium native banner ad composable. Convenience function for NativeAdCompose with MEDIUM size.

Link copied to clipboard
@Composable
fun NativeBannerSmallCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A small native banner ad composable. Convenience function for NativeAdCompose with SMALL size.

Link copied to clipboard
@Composable
fun NativeCardModernCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Card Modern template - general purpose native ad

Link copied to clipboard
@Composable
fun NativeCompactHorizontalCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Compact Horizontal template - horizontal layout for lists

Link copied to clipboard
@Composable
fun NativeFeaturedCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Featured template - large featured card for hero sections

Link copied to clipboard
@Composable
fun NativeLargeCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A large native ad composable. Convenience function for NativeAdCompose with LARGE size.

Link copied to clipboard
@Composable
fun NativeListItemCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

List Item template - ideal for RecyclerView/LazyColumn items

Link copied to clipboard
@Composable
fun NativeMagazineCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Magazine template - news/blog style native ad

Link copied to clipboard
@Composable
fun NativeMaterial3Compose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Material 3 template - Material Design 3 styled native ad

Link copied to clipboard
@Composable
fun NativeMinimalCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Minimal template - clean, minimal design

Link copied to clipboard
@Composable
fun NativeTemplateCompose(adUnitId: String, template: NativeAdTemplate = NativeAdTemplate.CARD_MODERN, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A Jetpack Compose wrapper for NativeTemplateView.

Link copied to clipboard
@Composable
fun NativeVideoLargeCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Video Large template - large video-optimized layout

Link copied to clipboard
@Composable
fun NativeVideoMediumCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Video Medium template - optimized for video ads

Link copied to clipboard
@Composable
fun NativeVideoSquareCompose(adUnitId: String, modifier: Modifier = Modifier, loadingStrategy: AdLoadingStrategy? = null, onAdLoaded: () -> Unit? = null, onAdFailedToLoad: (AdError?) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null)

Video Square template - square format for social feeds

Link copied to clipboard
@Composable
fun ProgrammaticNativeAdCompose(adUnitId: String, size: ProgrammaticNativeAdLoader.NativeAdSize = ProgrammaticNativeAdLoader.NativeAdSize.SMALL, modifier: Modifier = Modifier, useCachedAd: Boolean = true, showLoadingIndicator: Boolean = true, onAdLoaded: (NativeAdView, NativeAd) -> Unit? = null, onAdFailedToLoad: (AdError) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A Jetpack Compose component for programmatically loaded native ads.

Link copied to clipboard
@Composable
fun ProgrammaticNativeBannerMediumCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, showLoadingIndicator: Boolean = true, onAdLoaded: (NativeAdView, NativeAd) -> Unit? = null, onAdFailedToLoad: (AdError) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A medium programmatic native banner ad composable. Convenience function for ProgrammaticNativeAdCompose with MEDIUM size.

Link copied to clipboard
@Composable
fun ProgrammaticNativeBannerSmallCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, showLoadingIndicator: Boolean = true, onAdLoaded: (NativeAdView, NativeAd) -> Unit? = null, onAdFailedToLoad: (AdError) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A small programmatic native banner ad composable. Convenience function for ProgrammaticNativeAdCompose with SMALL size.

Link copied to clipboard
@Composable
fun ProgrammaticNativeLargeCompose(adUnitId: String, modifier: Modifier = Modifier, useCachedAd: Boolean = true, showLoadingIndicator: Boolean = true, onAdLoaded: (NativeAdView, NativeAd) -> Unit? = null, onAdFailedToLoad: (AdError) -> Unit? = null, onAdClicked: () -> Unit? = null, onAdImpression: () -> Unit? = null, onAdOpened: () -> Unit? = null, onAdClosed: () -> Unit? = null, onPaidEvent: (AdValue) -> Unit? = null)

A large programmatic native ad composable. Convenience function for ProgrammaticNativeAdCompose with LARGE size.

Link copied to clipboard
@Composable
fun rememberAdLoadingState(initialLoading: Boolean = false): Pair<Pair<Boolean, (Boolean) -> Unit>, Pair<Boolean, (Boolean) -> Unit>>

Composable function that provides ad loading state management.

Link copied to clipboard
@Composable
fun rememberCacheStatistics(): State<Map<String, String>>

A composable that provides cache statistics for debugging.

Link copied to clipboard
@Composable
fun rememberInterstitialAd(adUnitId: String, preloadAd: Boolean = true, onAdShown: () -> Unit? = null, onAdDismissed: () -> Unit? = null, onAdFailedToLoad: (String) -> Unit? = null): () -> Unit

A Compose effect for managing interstitial ads using AdManager.

Link copied to clipboard
@Composable
fun rememberInterstitialAdState(adUnitId: String, autoLoad: Boolean = true): InterstitialAdState

Creates and remembers an InterstitialAdState.

Link copied to clipboard
@Composable
fun rememberPerformanceStats(): State<Map<String, Any>>

A composable that provides performance statistics for debugging.

Link copied to clipboard
@Composable
fun rememberPurchaseStatus(): Boolean

A composable that provides the current purchase status.