urbanairship-core/com.urbanairship/UAirship

UAirship

UAirship manages the shared state for all Airship services. UAirship.takeOff() should be called to initialize the class during Application.onCreate() or by using Autopilot.

Types

OnReadyCallback

interface OnReadyCallback

Callback interface used to notify app when UAirship is ready.

Platform

@Retention(value = RetentionPolicy.SOURCE)

annotation class Platform

Properties

ACTION_AIRSHIP_READY

@NonNull

val ACTION_AIRSHIP_READY: String = "com.urbanairship.AIRSHIP_READY"

Broadcast that is sent when UAirship is finished taking off.

actionRegistry

@get:NonNull

open val actionRegistry: ActionRegistry

airshipConfigOptions

@get:NonNull

open val airshipConfigOptions: AirshipConfigOptions

AMAZON_PLATFORM

val AMAZON_PLATFORM: Int = 1

Amazon platform type.

analytics

@get:NonNull

open val analytics: Analytics

ANDROID_PLATFORM

val ANDROID_PLATFORM: Int = 2

Android platform type.

applicationMetrics

@get:NonNull

open val applicationMetrics: ApplicationMetrics

channel

@get:NonNull

open val channel: AirshipChannel

channelCapture

@get:NonNull

open val channelCapture: ChannelCapture

components

open val components: List<AirshipComponent>

contact

@get:NonNull

open val contact: Contact

deepLinkListener

@get:Nullable

open var deepLinkListener: DeepLinkListener

EXTRA_AIRSHIP_DEEP_LINK_SCHEME

@NonNull

val EXTRA_AIRSHIP_DEEP_LINK_SCHEME: String = "uairship"

EXTRA_APP_KEY_KEY

@NonNull

val EXTRA_APP_KEY_KEY: String = "app_key"

EXTRA_CHANNEL_ID_KEY

@NonNull

val EXTRA_CHANNEL_ID_KEY: String = "channel_id"

EXTRA_PAYLOAD_VERSION_KEY

@NonNull

val EXTRA_PAYLOAD_VERSION_KEY: String = "payload_version"

imageLoader

open val imageLoader: ImageLoader

inputValidator

@get:NonNull

open val inputValidator: AirshipInputValidation.Validator

isFlying

open val isFlying: Boolean

isMainProcess

open val isMainProcess: Boolean

isTakingOff

open val isTakingOff: Boolean

localeManager

open val localeManager: LocaleManager

locationClient

open val locationClient: AirshipLocationClient

LOG_TAKE_OFF_STACKTRACE

open var LOG_TAKE_OFF_STACKTRACE: Boolean

Flag to enable printing take off's stacktrace.

permissionsManager

@get:NonNull

open val permissionsManager: PermissionsManager

privacyManager

@get:NonNull

open val privacyManager: PrivacyManager

pushManager

@get:NonNull

open val pushManager: PushManager

remoteData

open val remoteData: RemoteData

runtimeConfig

open val runtimeConfig: AirshipRuntimeConfig

UNKNOWN_PLATFORM

val UNKNOWN_PLATFORM: Int = -1

Unknown platform.

urlAllowList

@get:NonNull

open val urlAllowList: UrlAllowList

Functions

deepLink

@MainThread

open fun deepLink(@NonNull deepLink: String): Boolean

Deep links.

getAppIcon

open fun getAppIcon(): Int

Returns the drawable ID for the current Application's icon.

getAppInfo

@NonNull

open fun getAppInfo(): ApplicationInfo

Returns the current Application's ApplicationInfo.

getApplicationContext

@NonNull

open fun getApplicationContext(): Context

Returns the current Application's context.

getAppName

@NonNull

open fun getAppName(): String

Returns the current Application's name.

getAppVersion

open fun getAppVersion(): Long

Returns the current Application version.

getLocale

open fun getLocale(): Locale

Get the locale stored in UAirship.

getPackageInfo

@Nullable

open fun getPackageInfo(): PackageInfo

Returns the Application's PackageInfo

getPackageManager

@NonNull

open fun getPackageManager(): PackageManager

Returns the Application's package manager.

getPackageName

open fun getPackageName(): String

Returns the Application's package name.

getPlatformType

open fun getPlatformType(): Int

Returns the platform type.

getVersion

@NonNull

open fun getVersion(): String

Returns the current Airship version.

setLocaleOverride

open fun setLocaleOverride(@Nullable locale: Locale)

Sets a locale to be stored in UAirship.

shared

@NonNull

open fun shared(): UAirship

Returns the shared UAirship singleton instance.

@NonNull

open fun shared(@NonNull callback: UAirship.OnReadyCallback): Cancelable

@NonNull

open fun shared(@Nullable looper: Looper, @NonNull callback: UAirship.OnReadyCallback): Cancelable

Requests the airship instance asynchronously.

takeOff

@MainThread

open fun takeOff(@NonNull application: Application)

Take off with config loaded from the airshipconfig.properties file in the assets directory.

@MainThread

open fun takeOff(@NonNull application: Application, @Nullable options: AirshipConfigOptions)

Take off with defined AirshipConfigOptions.

@MainThread

open fun takeOff(@NonNull application: Application, @Nullable readyCallback: UAirship.OnReadyCallback)

@MainThread

open fun takeOff(@NonNull application: Application, @Nullable options: AirshipConfigOptions, @Nullable readyCallback: UAirship.OnReadyCallback)

Take off with a callback to perform airship configuration after takeoff.