urbanairship-core/com.urbanairship/Airship

Airship

object Airship(source)

The Airship singleton provides access to all of the Airship services.

Types

OnReadyCallback

fun interface OnReadyCallback

Properties

ACTION_AIRSHIP_READY

const val ACTION_AIRSHIP_READY: String

Broadcast that is sent when Airship is finished taking off.

actionRegistry

@JvmStatic

val actionRegistry: ActionRegistry

The shared ActionRegistry instance.

airshipConfigOptions

@JvmStatic

val airshipConfigOptions: AirshipConfigOptions

The application's AirshipConfigOptions.

analytics

@JvmStatic

val analytics: Analytics

The shared Analytics instance.

application

@JvmStatic

val application: Application

The application instance.

channel

@JvmStatic

val channel: AirshipChannel

The shared AirshipChannel instance.

channelCapture

@JvmStatic

val channelCapture: ChannelCapture

The shared ChannelCapture instance.

contact

@JvmStatic

val contact: Contact

The shared Contact instance.

deepLinkListener

@JvmStatic

var deepLinkListener: DeepLinkListener?

The shared deep link listener.

EXTRA_AIRSHIP_DEEP_LINK_SCHEME

const val EXTRA_AIRSHIP_DEEP_LINK_SCHEME: String

EXTRA_APP_KEY_KEY

const val EXTRA_APP_KEY_KEY: String

EXTRA_CHANNEL_ID_KEY

const val EXTRA_CHANNEL_ID_KEY: String

EXTRA_PAYLOAD_VERSION_KEY

const val EXTRA_PAYLOAD_VERSION_KEY: String

isFlying

@JvmStatic

val isFlying: Boolean

true if the SDK is fully initialized and ready, false otherwise.

isFlyingOrTakingOff

val isFlyingOrTakingOff: Boolean

true if the SDK is either initialized or initializing, false otherwise.

isTakingOff

@JvmStatic

val isTakingOff: Boolean

true if takeOff has been called but the SDK is still initializing, false otherwise.

localeManager

@JvmStatic

val localeManager: LocaleManager

The shared LocaleManager instance.

logTakeOffStackTrace

@JvmField

@Volatile

var logTakeOffStackTrace: Boolean

If true, a stack trace will be logged when takeOff is called to help diagnose issues with multiple takeOff calls. Defaults to false.

permissionsManager

@JvmStatic

val permissionsManager: PermissionsManager

The shared PermissionsManager instance.

platform

@JvmStatic

val platform: Platform

The detected platform.

privacyManager

@JvmStatic

val privacyManager: PrivacyManager

The shared PrivacyManager instance.

push

@JvmStatic

val push: PushManager

The shared PushManager instance.

runtimeConfig

@JvmStatic

val runtimeConfig: AirshipRuntimeConfig

The runtime configuration.

status

val status: AirshipStatus

The current status of the Airship SDK.

statusFlow

val statusFlow: StateFlow<AirshipStatus>

The current status of the Airship SDK.

urlAllowList

@JvmStatic

val urlAllowList: UrlAllowList

The shared UrlAllowList instance.

version

@JvmStatic

val version: String

The current Airship SDK version.

Functions

deepLink

@MainThread

@JvmStatic

fun deepLink(deepLink: String): Boolean

Processes a deep link.

onReady

@JvmStatic

fun onReady(callback: Airship.OnReadyCallback)

fun onReady(onReady: Airship.() -> Unit)

Adds a callback to be invoked when the SDK is ready. The callback will always be dispatched on Dispatchers.Main.

takeOff

@JvmStatic

@MainThread

fun takeOff(application: Application, onReadyCallback: Airship.OnReadyCallback)

@JvmStatic

@MainThread

fun takeOff(application: Application, options: AirshipConfigOptions?, onReadyCallback: Airship.OnReadyCallback)

@JvmStatic

@JvmOverloads

@MainThread

fun takeOff(application: Application, options: AirshipConfigOptions? = null, onReady: Airship.() -> Unit? = null)

Initializes the Airship SDK.

waitForReady

suspend fun waitForReady(duration: Duration? = null): Boolean

Waits for the SDK to be ready.

waitForReadyBlocking

@JvmStatic

@WorkerThread

fun waitForReadyBlocking(duration: Duration? = null): Boolean

Waits for the SDK to be ready. This method will block the calling thread.