Android API Reference

fun initialize(
    initParams: CloudXInitializationParams,
    listener: CloudXInitializationListener?
)

fun createBanner(placementName: String): CloudXAdView
fun createMREC(placementName: String): CloudXAdView
fun createInterstitial(placementName: String): CloudXInterstitialAd
fun createRewardedInterstitial(placementName: String): CloudXRewardedInterstitialAd
fun createNativeAdSmall(placementName: String): CloudXAdView
fun createNativeAdMedium(placementName: String): CloudXAdView

fun setPrivacy(privacy: CloudXPrivacy)
fun setHashedUserId(hashedUserId: String)
fun setUserKeyValue(key: String, value: String)
fun setAppKeyValue(key: String, value: String)
fun clearAllKeyValues()

fun setLoggingEnabled(isEnabled: Boolean)
fun setMinLogLevel(minLogLevel: CloudXLogLevel)

data class CloudXInitializationParams(
    val appKey: String,
    val testMode: Boolean = false
)

data class CloudXPrivacy(
    val isUserConsent: Boolean? = null,
    val isAgeRestrictedUser: Boolean? = null
)

fun load()
fun startAutoRefresh()
fun stopAutoRefresh()
fun destroy()
var listener: CloudXAdViewListener?

fun load()
fun show()
fun destroy()
val isAdReady: Boolean
var listener: CloudXInterstitialListener?

fun load()
fun show()
fun destroy()
val isAdReady: Boolean
var listener: CloudXRewardedInterstitialListener?

interface CloudXAdListener {
    fun onAdLoaded(cloudXAd: CloudXAd)
    fun onAdDisplayed(cloudXAd: CloudXAd)
    fun onAdHidden(cloudXAd: CloudXAd)
    fun onAdClicked(cloudXAd: CloudXAd)
    fun onAdLoadFailed(cloudXError: CloudXError)
    fun onAdDisplayFailed(cloudXError: CloudXError)
}

interface CloudXAdViewListener : CloudXAdListener {
    fun onAdExpanded(cloudXAd: CloudXAd)
    fun onAdCollapsed(cloudXAd: CloudXAd)
}

interface CloudXInterstitialListener : CloudXAdListener

interface CloudXRewardedInterstitialListener : CloudXAdListener {
    fun onUserRewarded(cloudXAd: CloudXAd)
}

interface CloudXInitializationListener {
    fun onInitialized()
    fun onInitializationFailed(cloudXError: CloudXError)
}

interface CloudXAd {
    val placementName: String
    val placementId: String
    val bidderName: String
    val externalPlacementId: String?
    val revenue: Double
}

data class CloudXError(
    val code: CloudXErrorCode,
    val message: String?,
    val cause: Throwable?
) {
    val effectiveMessage: String
}

enum class CloudXErrorCode(val value: Int) {
    // Initialization (100-199)
    NOT_INITIALIZED(100),
    INITIALIZATION_IN_PROGRESS(101),
    NO_ADAPTERS_FOUND(102),
    INITIALIZATION_TIMEOUT(103),
    INVALID_APP_KEY(104),

    // Network (200-299)
    NETWORK_ERROR(200),
    NETWORK_TIMEOUT(201),
    INVALID_RESPONSE(202),

    // Ad Loading (300-399)
    NO_FILL(300),
    INVALID_REQUEST(301),
    INVALID_PLACEMENT(302),
    LOAD_TIMEOUT(303),
    LOAD_FAILED(304),

    // Ad Display (400-499)
    AD_NOT_READY(400),
    AD_ALREADY_SHOWN(401),
    AD_EXPIRED(402),
    SHOW_FAILED(404),

    // Configuration (500-599)
    INVALID_AD_UNIT(500),
    PERMISSION_DENIED(501),
    UNSUPPORTED_AD_FORMAT(502),

    // General (700-799)
    UNEXPECTED_ERROR(700)
}

enum class CloudXLogLevel {
    VERBOSE,
    DEBUG,
    INFO,
    WARN,
    ERROR
}

fun enableMetaAudienceNetworkTestMode(enabled: Boolean)

dependencies {
    implementation("io.cloudx:sdk:0.6.1")
    implementation("io.cloudx:adapter-cloudx:0.6.1")
    implementation("io.cloudx:adapter-meta:0.6.1")
}