sdk/com.adswizz.sdk/AdswizzSDK

AdswizzSDK

Properties

Set or retrieve the Afr configuration for the companion banner.

Use this property to add your own AnalyticsConnector to receive all the events from the SDK and forward them to your own ingestion pipeline (Firebase, Mixpanel etc). AdswizzSDK keeps a strong reference to the AnalyticsConnector, so it's your responsibility to handle lifecycle of the AnalyticsConnector instance while listening for analytics events

ccpaConfig

var ~~ccpaConfig~~: CCPAConfig

Set or retrieve the CCPA configuration.

consent

var consent: AdswizzPrivacyConsent

Handle AdswizzPrivacyConsent object

disableDataCollection

var disableDataCollection: Boolean

Enable or disable data collection.

disabledRAD

var disabledRAD: Boolean

Enable or disable RAD for podcasts.

gdprConsent

var ~~gdprConsent~~: GDPRConsent

Set or retrieve the GDPR consent status.

gppConsent

var ~~gppConsent~~: String?

Set or retrieve gpp consent string

integratorContext

var integratorContext: IntegratorContext?

For correct macro expansion, implement the IntegratorContext interface and provide it to the SDK using the integratorContext property.

isInitialized

val isInitialized: Boolean

This property stores initialization status. Use completion block of initialize function to be sure that initialization process of AdswizzSDK completed.

logger

var logger: Logger?

omidPartner

val omidPartner: String

omidPartnerVersion

val omidPartnerVersion: String

omidVersion

const val omidVersion: String

xpaid

val xpaid: String?

Functions

cleanup

fun cleanup()

Perform SDK cleanup and release all SDK components. Call it when you no longer need the SDK.

getPermissionStatus

fun getPermissionStatus(permission: String): Boolean

Return status of permission previously set with setPermissionStatus.
permission permission name

getVersion

fun getVersion(): <Error class: unknown class>

initialize

fun initialize(context: Context, adswizzSDKConfig: AdswizzSDKConfig? = null, completion: () -> Unit? = null)

SDK initialization. The recommended way to do this is in the onCreate of your application. If adswizzSDKConfig is used to provide installationId and playerId at runtime. They can be set also in manifest and they are mandatory to SDK initialization.
context: application context
adswizzSDKConfig: optional AdswizzSDKConfig that contains installationId and playerId.
completion: optional completion callback which signals when AdswizzSDK is fully initialised.

setAdCompanionOptions

fun setAdCompanionOptions(adCompanionOptions: AdCompanionOptions)

This function is used to change the default AdCompanionView behaviour by changing the exposure time or to setting the preferred resource type

setInteractivityListener

fun setInteractivityListener(adManager: AdBaseManager, interactivityListener: InteractivityListener?)

This function sets a callback for interactivity events that are not covered by the AdManager.Listener callback

setPermissionStatus

fun setPermissionStatus(permission: String, value: Boolean)

Use this function to deny unwanted permissions to the AdswizzSDK. By default, the AdswizzSDK will use all the permissions that the host app uses.
permission permission name.
value: status of the permission to be set (allow = true, deny = false)