Airship Android SDK
Toggle table of contents
androidJvm
Platform filter
androidJvm
Switch theme
Airship Android SDK
urbanairship-adm
com.
urbanairship.
push.
adm
Adm
Handler
Base
Adm
Handler
Job
Base
urbanairship-automation
com.
urbanairship.
automation
Automation
App
State
FOREGROUND
BACKGROUND
Automation
Audience
Companion
Miss
Behavior
CANCEL
SKIP
PENALIZE
Automation
Compound
Audience
Companion
Automation
Delay
Automation
Schedule
Builder
Schedule
Data
Actions
Deferred
In
App
Message
Data
Schedule
Type
ACTIONS
IN_
APP_
MESSAGE
DEFERRED
Automation
Trigger
Compound
Event
Compound
Automation
Trigger
Compound
Automation
Trigger
Type
OR
AND
CHAIN
Event
Automation
Trigger
Event
Automation
Trigger
Type
FOREGROUND
BACKGROUND
SCREEN
VERSION
APP_
INIT
REGION_
ENTER
REGION_
EXIT
CUSTOM_
EVENT_
COUNT
CUSTOM_
EVENT_
VALUE
FEATURE_
FLAG_
INTERACTION
ACTIVE_
SESSION
IN_
APP_
DISPLAY
IN_
APP_
RESOLUTION
IN_
APP_
BUTTON_
TAP
IN_
APP_
PERMISSION_
RESULT
IN_
APP_
FORM_
DISPLAY
IN_
APP_
FORM_
RESULT
IN_
APP_
GESTURE
IN_
APP_
PAGER_
COMPLETED
IN_
APP_
PAGER_
SUMMARY
IN_
APP_
PAGE_
SWIPE
IN_
APP_
PAGE_
VIEW
IN_
APP_
PAGE_
ACTION
In
App
Automation
Remote
Data
Status
UP_
TO_
DATE
STALE
OUT_
OF_
DATE
com.
urbanairship.
automation.
engine
[android
Jvm]Automation
Dao_
Impl
[android
Jvm]Automation
Store_
Impl
com.
urbanairship.
automation.
limits.
storage
[android
Jvm]Frequency
Limit
Dao_
Impl
[android
Jvm]Frequency
Limit
Database_
Impl
com.
urbanairship.
automation.
storage
[android
Jvm]Automation
Dao_
Impl
[android
Jvm]Automation
Database_
Impl
com.
urbanairship.
embedded
Airship
Embedded
Observer
Listener
Airship
Embedded
View
com.
urbanairship.
iam
In
App
Activity
Monitor
Companion
In
App
Message
Builder
Display
Behavior
IMMEDIATE
STANDARD
In
App
Message
Content
Extender
In
App
Message
Display
Delegate
In
App
Messaging
Interface
com.
urbanairship.
iam.
actions
Cancel
Schedules
Action
Companion
Landing
Page
Action
Companion
Schedule
Action
Companion
Schedule
Extender
com.
urbanairship.
iam.
adapter
Custom
Display
Adapter
Callback
Adapter
Suspending
Adapter
Custom
Display
Adapter
Type
HTML
MODAL
FULLSCREEN
BANNER
CUSTOM
Custom
Display
Resolution
Button
Tap
Message
Tap
Timed
Out
User
Dismissed
Display
Finished
Callback
Companion
com.
urbanairship.
iam.
assets
Airship
Cached
Assets
com.
urbanairship.
iam.
content
Airship
Layout
Companion
Banner
Companion
Placement
TOP
BOTTOM
Template
MEDIA_
LEFT
MEDIA_
RIGHT
Custom
Companion
Fullscreen
Companion
Template
HEADER_
MEDIA_
BODY
MEDIA_
HEADER_
BODY
HEADER_
BODY_
MEDIA
HTML
Companion
In
App
Message
Display
Content
Airship
Layout
Content
Banner
Content
Custom
Content
Fullscreen
Content
HTMLContent
Modal
Content
Modal
Companion
Template
HEADER_
MEDIA_
BODY
MEDIA_
HEADER_
BODY
HEADER_
BODY_
MEDIA
com.
urbanairship.
iam.
info
In
App
Message
Button
Info
Behavior
DISMISS
CANCEL
Companion
In
App
Message
Button
Layout
Type
Companion
STACKED
JOINED
SEPARATE
In
App
Message
Media
Info
Companion
Media
Type
YOUTUBE
VIMEO
VIDEO
IMAGE
In
App
Message
Text
Info
Alignment
LEFT
CENTER
RIGHT
Companion
Style
BOLD
ITALIC
UNDERLINE
com.
urbanairship.
iam.
legacy
Legacy
In
App
Message
Legacy
In
App
Messaging
Interface
Message
Convertor
Message
Extender
Schedule
Extender
urbanairship-automation-compose
com.
urbanairship.
automation.
compose
Airship
Embedded
View()
Airship
Embedded
View
Defaults
Airship
Embedded
View
Group()
Airship
Embedded
View
Group
State
Airship
Embedded
View
State
Embedded
View
Item
remember
Airship
Embedded
View
Group
State()
remember
Airship
Embedded
View
State()
urbanairship-core
com.
urbanairship
[android
Jvm]Preference
Data
Dao_
Impl
[android
Jvm]Preference
Data
Database_
Impl
Airship
Component
Airship
Config
Options
Builder
Config
Exception
Site
Airship
Initializer
Airship
Log
Handler
Airship
Loopers
Autopilot
Cancelable
Cancelable
Operation
Channel
Capture
Default
Log
Handler
Fonts
No
Dependency
Airship
Initializer
Pending
Result
Predicate
Privacy
Manager
Feature
Companion
Result
Callback
UAirship
On
Ready
Callback
Platform
UALog
Url
Allow
List
On
Url
Allow
List
Callback
Scope
com.
urbanairship.
actions
Action
Situation
Action
Arguments
Action
Completion
Callback
Action
Registry
Entry
Predicate
Action
Result
Status
Action
Runner
Action
Run
Request
Action
Run
Request
Extender
Action
Value
Action
Value
Exception
Add
Custom
Event
Action
Add
Custom
Event
Action
Predicate
Clipboard
Action
Deep
Link
Action
Deep
Link
Listener
Default
Action
Runner
Enable
Feature
Action
Fetch
Device
Info
Action
Fetch
Device
Info
Predicate
Open
External
Url
Action
Permission
Result
Receiver
Prompt
Permission
Action
Args
Rate
App
Action
Rate
App
Activity
run()
Set
Attributes
Action
Set
Attributes
Predicate
Share
Action
Subscription
List
Action
Toast
Action
Wallet
Action
Wallet
Loading
Activity
com.
urbanairship.
actions.
tags
Add
Tags
Action
Add
Tags
Predicate
Companion
Base
Tags
Action
Remove
Tags
Action
Companion
Remove
Tags
Predicate
Tag
Action
Mutation
Channel
Tag
Groups
Channel
Tags
Contact
Tag
Groups
com.
urbanairship.
activity
Themed
Activity
com.
urbanairship.
analytics
Account
Event
Template
Airship
Event
Data
Analytics
Companion
Associated
Identifiers
Editor
Custom
Event
Builder
Companion
Event
Priority
Event
Type
APP_
FOREGROUND
APP_
BACKGROUND
SCREEN_
TRACKING
ASSOCIATE_
IDENTIFIERS
INSTALL_
ATTRIBUTION
INTERACTIVE_
NOTIFICATION_
ACTION
PUSH_
ARRIVED
REGION_
ENTER
REGION_
EXIT
CUSTOM_
EVENT
FEATURE_
FLAG_
INTERACTION
IN_
APP_
DISPLAY
IN_
APP_
RESOLUTION
IN_
APP_
BUTTON_
TAP
IN_
APP_
PERMISSION_
RESULT
IN_
APP_
FORM_
DISPLAY
IN_
APP_
FORM_
RESULT
IN_
APP_
GESTURE
IN_
APP_
PAGER_
COMPLETED
IN_
APP_
PAGER_
SUMMARY
IN_
APP_
PAGE_
SWIPE
IN_
APP_
PAGE_
VIEW
IN_
APP_
PAGE_
ACTION
Install
Receiver
Media
Event
Template
Retail
Event
Template
Search
Event
Template
com.
urbanairship.
analytics.
data
[android
Jvm]Analytics
Database_
Impl
[android
Jvm]Event
Dao_
Impl
com.
urbanairship.
analytics.
location
Circular
Region
Proximity
Region
Region
Event
Boundary
Builder
com.
urbanairship.
analytics.
templates
Account
Event
Template
Properties
Builder
Companion
Type
REGISTERED
LOGGED_
IN
LOGGED_
OUT
Media
Event
Template
Properties
Builder
Companion
Type
Browsed
Consumed
Shared
Starred
Retail
Event
Template
Properties
Builder
Companion
Type
Added
To
Cart
Browsed
Purchased
Shared
Starred
Wishlist
Search
Event
Template
Properties
Builder
Companion
Type
SEARCH
com.
urbanairship.
annotation
Open
For
Testing
com.
urbanairship.
app
Activity
Listener
Activity
Monitor
Application
Listener
Filtered
Activity
Listener
Forwarding
Activity
Listener
Forwarding
Application
Listener
Global
Activity
Monitor
Companion
Simple
Activity
Listener
Simple
Application
Listener
com.
urbanairship.
cache
[android
Jvm]Cache
Dao_
Impl
[android
Jvm]Cache
Database_
Impl
com.
urbanairship.
channel
Airship
Channel
Airship
Channel
Create
Option
Airship
Channel
Listener
Attribute
Editor
Companion
Channel
Generation
Method
Automatic
Restore
Sms
Validation
Handler
Subscription
List
Editor
Tag
Editor
Tag
Groups
Editor
com.
urbanairship.
contacts
Conflict
Event
Channel
Info
Contact
Contact
Channel
Companion
Email
Registration
Info
Companion
Pending
Registered
Sms
Registration
Info
Companion
Pending
Registered
Contact
Conflict
Listener
Email
Registration
Options
Companion
Open
Channel
Registration
Options
Companion
Scope
APP
WEB
EMAIL
SMS
Scoped
Subscription
List
Editor
Sms
Registration
Options
Companion
com.
urbanairship.
embedded
Airship
Embedded
Info
com.
urbanairship.
google
Google
Play
Services
Util
Wrapper
Play
Services
Error
Activity
Error
Dialog
Fragment
Play
Services
Utils
com.
urbanairship.
http
Request
Auth
Basic
App
Auth
Basic
Auth
Bearer
Token
Channel
Token
Auth
Contact
Token
Auth
Generated
App
Token
Generated
Channel
Token
Request
Body
Gzipped
Json
Json
com.
urbanairship.
images
Image
Size
Resolver
com.
urbanairship.
inputvalidation
Airship
Input
Validation
Override
Replace
Use
Default
Result
Invalid
Valid
Airship
Validation
Override
com.
urbanairship.
json
empty
Json
List()
empty
Json
Map()
extend()
iso
Date
As
Milliseconds()
Json
Exception
Json
List
json
List
Of()
Json
Map
Builder
json
Map
Of()
Json
Matcher
Builder
Json
Predicate
Builder
Predicate
Type
Json
Serializable
Json
Value
optional
Field()
optional
List()
optional
Map()
require
Field()
require
List()
require
Map()
to
Json
List()
to
Json
Map()
try
Parse()
Value
Matcher
com.
urbanairship.
json.
matchers
Array
Length
Matcher
Companion
com.
urbanairship.
meteredusage
[android
Jvm]Events
Dao_
Impl
[android
Jvm]Events
Database_
Impl
com.
urbanairship.
permission
On
Permission
Status
Changed
Listener
Permission
DISPLAY_
NOTIFICATIONS
LOCATION
Permission
Delegate
Permission
Prompt
Fallback
Callback
None
System
Settings
Permission
Request
Result
Permissions
Manager
Permission
Status
GRANTED
DENIED
NOT_
DETERMINED
Single
Permission
Delegate
com.
urbanairship.
push
enable
User
Notifications()
Internal
Notification
Listener
Notification
Action
Button
Info
Notification
Info
Notification
Listener
Push
Listener
Push
Manager
Companion
Push
Message
Push
Notification
Status
push
Notification
Status
Flow
Push
Notification
Status
Listener
Push
Provider
Delivery
Type
Push
Provider
Unavailable
Exception
Registration
Exception
Push
Provider
Type
ADM
FCM
HMS
NONE
Push
Token
Listener
com.
urbanairship.
push.
notifications
Actions
Notification
Extender
Airship
Notification
Provider
Custom
Layout
Notification
Provider
Localizable
Remote
Input
Builder
Notification
Action
Button
Builder
Notification
Action
Button
Group
Builder
Notification
Arguments
Builder
Notification
Channel
Compat
Notification
Channel
Registry
Notification
Provider
Notification
Result
Status
Public
Notification
Extender
Style
Notification
Extender
Wearable
Notification
Extender
com.
urbanairship.
util
Accessibility
Utils
airship
Emoji
Flag
Attributes
Cached
List
Date
Utils
File
Utils
Download
Result
Image
Utils
Drawable
Result
Notification
Id
Generator
Permissions
Requester
UAString
Util
com.
urbanairship.
wallet
Callback
Field
Builder
Pass
Pass
Request
Builder
com.
urbanairship.
webkit
Airship
Web
Chrome
Client
Airship
Web
View
Airship
Web
View
Client
urbanairship-fcm
com.
urbanairship.
push.
fcm
Airship
Firebase
Integration
Airship
Firebase
Messaging
Service
urbanairship-feature-flag
com.
urbanairship.
featureflag
Feature
Flag
Companion
Feature
Flag
Exception
Failed
To
Fetch
Feature
Flag
Manager
Companion
Feature
Flag
Remote
Data
Status
UP_
TO_
DATE
STALE
OUT_
OF_
DATE
Feature
Flag
Result
Cache
urbanairship-hms
com.
urbanairship.
push.
hms
Airship
Hms
Integration
Airship
Hms
Message
Service
urbanairship-live-update
com.
urbanairship.
liveupdate
Callback
Live
Update
Custom
Handler
Live
Update
Result
Callback
Callback
Live
Update
Notification
Handler
Live
Update
Result
Callback
Notification
Result
Custom
Live
Update
Handler
Live
Update
Live
Update
Event
START
END
UPDATE
Live
Update
Handler
Live
Update
Manager
Companion
Live
Update
Result
Cancel
Companion
Notification
Extender
Ok
Notification
Live
Update
Handler
Suspend
Live
Update
Custom
Handler
Suspend
Live
Update
Notification
Handler
com.
urbanairship.
liveupdate.
data
[android
Jvm]Live
Update
Dao_
Impl
[android
Jvm]Live
Update
Database_
Impl
com.
urbanairship.
liveupdate.
notification
Live
Update
Notification
Receiver
urbanairship-message-center
com.
urbanairship.
messagecenter
[android
Jvm]Message
Dao_
Impl
[android
Jvm]Message
Database_
Impl
Inbox
Fetch
Messages
Callback
Inbox
Job
Handler
Inbox
Listener
Message
Companion
Message
Center
Companion
On
Show
Message
Center
Listener
User
Listener
com.
urbanairship.
messagecenter.
actions
Message
Center
Action
com.
urbanairship.
messagecenter.
ui
Message
Activity
Companion
Message
Center
Activity
Message
Center
Fragment
Companion
Listener
Message
Center
List
Fragment
Message
Center
Message
Fragment
Companion
On
Message
Deleted
Listener
Message
Fragment
Companion
Listener
Message
List
Fragment
On
Edit
Listener
On
Message
Click
Listener
com.
urbanairship.
messagecenter.
ui.
view
Message
List
Action
Delete
Messages
Mark
Messages
Read
Refresh
Message
List
State
Content
Error
Loading
Message
List
View
Listener
Message
List
View
Model
Companion
Message
View
Listener
Message
View
Action
Error
Retry
Clicked
Message
View
Model
Companion
Message
View
State
Content
Empty
Error
Type
LOAD_
FAILED
UNAVAILABLE
Loading
com.
urbanairship.
messagecenter.
ui.
widget
Message
List
Item
Accessibility
Action
Listener
Message
Web
View
Message
Web
View
Client
urbanairship-preference-center
com.
urbanairship.
preferencecenter
Open
Preference
Center
Action
Preference
Center
Companion
On
Open
Listener
com.
urbanairship.
preferencecenter.
data
Button
Common
Display
Condition
Opt
In
Status
Status
Companion
OPT_
IN
OPT_
OUT
State
Icon
Display
Item
Alert
Channel
Subscription
Contact
Management
Actionable
Message
Add
Channel
Prompt
Add
Prompt
Error
Messages
Icon
Button
Labeled
Button
Platform
Email
Sms
Prompt
Display
Registration
Options
Email
Sms
Remove
Channel
Prompt
Remove
Prompt
Resend
Options
Sms
Sender
Info
Contact
Subscription
Contact
Subscription
Group
Component
Options
Preference
Center
Config
Section
Common
Section
Break
com.
urbanairship.
preferencecenter.
ui
Preference
Center
Activity
Companion
Preference
Center
Fragment
Companion
On
Display
Preference
Center
Listener
urbanairship-core
/
com.urbanairship.analytics
/
CustomEvent
/
Companion
/
PROPERTIES
PROPERTIES
const
val
PROPERTIES
:
String
The custom properties key.