Package-level declarations

Types

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

abstract class AirshipComponent @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(context: Context, dataStore: PreferenceDataStore)

Base class for Airship components.

AirshipConfigOptions

class AirshipConfigOptions

This class holds the set of options necessary to properly initialize com.urbanairship.Airship.

AirshipInitializer

open class AirshipInitializer : Initializer<Boolean>

Airship initializer.

AirshipLogHandler

fun interface AirshipLogHandler

Log handler

AirshipStatus

enum AirshipStatus : Enum<AirshipStatus>

Represents the status of the Airship SDK.

Autopilot

open class Autopilot

Autopilot allows Airship.takeOff to be called without overriding the Application class. Typically, Airship.takeOff must be called in Application.onCreate() so that the Airship library is ready to handle incoming events before intents are delivered to any application components. Calling takeOff directly is the simplest integration, however some application frameworks do not provide a way to extend the Application class. Autopilot allows you to provide your bootstrapping code in a way that allows the library to lazily execute it.

Cancelable

interface Cancelable

Interface for an cancelable operation.

CancelableOperation

open class CancelableOperation @JvmOverloads constructor(looper: Looper? = null) : Cancelable, Runnable

A cancelable operation that executes its task on a specific looper.

ChannelCapture

class ChannelCapture @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(context: Context, configOptions: AirshipConfigOptions, airshipChannel: AirshipChannel, preferenceDataStore: PreferenceDataStore, activityMonitor: ActivityMonitor, dispatcher: CoroutineDispatcher = AirshipDispatchers.IO) : AirshipComponent

ChannelCapture detects a knock when the application is foregrounded 6 times in 30 seconds. When a knock is detected, it writes the channel ID to the clipboard as ua:.

DefaultLogHandler

class DefaultLogHandler : AirshipLogHandler

Default log handling. Sends all logs to android.util.Log.

Fonts

class Fonts

Helper class to cache and resolve font families.

NoDependencyAirshipInitializer

class ~~NoDependencyAirshipInitializer~~ : AirshipInitializer

No dependency Airship initializer.

PendingResult

class PendingResult<T> : Cancelable, Future<T?>

A pending result.

Platform

enum Platform : Enum<Platform>

Represents the mobile platforms supported by Airship.

Predicate

fun interface Predicate<T : Any>

Predicate interface.

PreferenceDataDao_Impl

@Generated(value = ["androidx.room.RoomProcessor"])

class PreferenceDataDao_Impl(__db: RoomDatabase) : <ERROR CLASS> ERROR CLASS: Symbol not found for PreferenceDataDao

@Generated(value = ["androidx.room.RoomProcessor"])

class PreferenceDataDao_Impl(__db: RoomDatabase) : <ERROR CLASS> ERROR CLASS: Symbol not found for PreferenceDataDao

PreferenceDataDatabase_Impl

@Generated(value = ["androidx.room.RoomProcessor"])

class PreferenceDataDatabase_Impl : <ERROR CLASS> ERROR CLASS: Symbol not found for PreferenceDataDatabase

@Generated(value = ["androidx.room.RoomProcessor"])

class PreferenceDataDatabase_Impl : <ERROR CLASS> ERROR CLASS: Symbol not found for PreferenceDataDatabase

PrivacyManager

class PrivacyManager @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP]) constructor(dataStore: PreferenceDataStore, defaultEnabledFeatures: PrivacyManager.Feature, configObserver: RemoteConfigObserver = RemoteConfigObserver(dataStore), resetEnabledFeatures: Boolean = false, dispatcher: CoroutineDispatcher = Dispatchers.Default)

The privacy manager allow enabling/disabling features in the SDK that require user data. The SDK will not make any network requests or collect data if all features our disabled, with a few exceptions when going from enabled -> disabled. To have the SDK opt-out of all features on startup, set the default enabled features in the AirshipConfig to Feature.NONE, or in the airshipconfig.properties file with enabledFeatures = none.

ResultCallback

fun interface ResultCallback<T>

Result callback interface.

UAirship

class ~~UAirship~~

UAirship has been renamed to Airship. This class is a temporary compatibility layer and will be removed in a future release.

UALog

object UALog

Shared logging wrapper for all Airship log entries. This class serves to consolidate the tag and log level in a single location.

UrlAllowList

class UrlAllowList

Defines a set of URL patterns to match a URL.

Functions

airshipConfigOptions

fun airshipConfigOptions(block: AirshipConfigOptions.Builder.() -> Unit): AirshipConfigOptions

Creates a new AirshipConfigOptions with the given options.