Class Index



AccountEventTemplate A class that represents a custom account event template for the application. 
Action The base action class that describes an operation to perform. 
ActionArguments Container for the argument data passed to an Action
ActionCompletionCallback An interface for callbacks signaling the completion of an Action
ActionRegistry Class responsible for runtime-persisting actions and associating them with names and predicates. 
ActionRegistry.Entry An entry in the action registry. 
ActionRegistry.Predicate ActionArgument predicate  
ActionResult Stores the results of running an Action
ActionRunRequest ActionRunRequests provides a fluent API for running Actions. 
ActionRunRequestFactory Factory class for creating ActionRunRequest
ActionSchedule Defines an action schedule. 
ActionScheduleEdits Edits for an action schedule. 
ActionScheduleEdits.Builder ActionScheduleEdits builder. 
ActionScheduleInfo Class encapsulating the implementor-set information for an action schedule. 
ActionScheduleInfo.Builder Builder class. 
ActionService Service class for running actions via push payload. 
ActionsNotificationExtender Notification builder extender to add UA notification action buttons to a notification. 
ActionValue An ActionValue is a representation of any value that can be described using JSON. 
ActionValueException Exceptions thrown when creating ActionValues from objects. 
ActivityMonitor Global activity monitor. 
ActivityMonitor.Listener Listener class for activity updates. 
ActivityMonitor.SimpleListener A convenience class to extend when you only want to listen for a subset of of activity events. 
AddCustomEventAction An action that adds a custom event. 
AddCustomEventAction.AddCustomEventActionPredicate Default AddCustomEventAction predicate. 
AddTagsAction An action that adds tags. 
AddTagsAction.AddTagsPredicate Default AddTagsAction predicate. 
AirshipComponent Base class for Urban Airship components. 
AirshipConfigOptions This class holds the set of options necessary to properly initialize UAirship
AirshipConfigOptions.Builder Airship config builder. 
AirshipReceiver Base intent receiver to process registration and push events from Urban Airship. 
AirshipReceiver.ActionButtonInfo Contains info about a notification action button. 
AirshipReceiver.NotificationInfo Contains information about a posted notification. 
Analytics This class is the primary interface to the UrbanAirship Analytics API. 
AnalyticsEnablePreference CheckboxPreference to enable/disable analytic events. 
AnalyticsListener An analytics event listener. 
ApplicationMetrics ApplicationMetrics stores metric information about the application. 
AssociatedIdentifiers Creates a map of associated identifier. 
AssociatedIdentifiers.Editor Interface use to modify identifiers in the AssociatedIdentifiers object. 
Audience Audience conditions for an in-app message. 
Audience.Builder Audience builder. 
AudienceChecks Audience checks. 
Automation This class is the primary interface to the Urban Airship On Device Automation API. 
Autopilot Autopilot allows UAirship.takeOff to be called without overriding the Application class. 


BannerAdapter Banner display adapter. 
BannerAdapterFactory BannerAdapter factory. 
BannerDismissLayout The BannerDismissLayout allows dismissing a banner with a vertical swipe gesture. 
BannerDismissLayout.Listener Interface to listen for dismissing the message view. 
BannerDisplayContent Display content for a TYPE_BANNER in-app message. 
BannerDisplayContent.Builder Banner Display Content Builder. 
BannerFragment A fragment that displays an in-app message banner. 
BannerFragment.Builder BannerFragment builder. 
ButtonInfo In-app button display info. 
ButtonInfo.Builder Button info builder class. 


Callback Callback when executing a PassRequest
Cancelable Interface for an cancelable operation. 
CancelableOperation A cancelable operation that executes its task on a specific looper. 
CancelSchedulesAction Action to cancel automation schedules. 
ChannelCapture ChannelCapture checks the device clipboard for a String that is prefixed by an expected token on app foreground and posts a notification that allows the user to copy the Channel or optionally open a url with the channel as an argument. 
ChannelCaptureAction Action to temporarily enable channel capture. 
ChannelIdPreference The Channel ID preference. 
CircularRegion A CircularRegion defines a circular region with a radius, latitude and longitude. 
ClipboardAction An action that adds text to the clipboard. 
CoreActivity An activity that forwards the notification proxy intents to the CoreReceiver. 
CoreReceiver This class is the core Broadcast Receiver for the Urban Airship library. 
CustomDisplayContent Display content for a TYPE_CUSTOM in-app message. 
CustomEvent A class that represents a custom event for the application. 
CustomEvent.Builder Builder class for CustomEvent Objects. 
CustomLayoutNotificationFactory A notification factory that allows the use of layout XML. 


DeepLinkAction Action for opening a deep link. 
DefaultNotificationFactory The default notification factory. 
DisplayContent In-app message display content. 
DisplayHandler Display handler for in-app message displays. 


EnableFeatureAction An action that enables features. 
Event This abstract class encapsulates analytics events. 


FetchDeviceInfoAction Action to fetch a map of device properties. 
FetchDeviceInfoAction.FetchDeviceInfoPredicate Default FetchDeviceInfoAction predicate. 
Field Defines a field that can be sent up when fetching a Pass
Field.Builder Builds the Field object. 
Fonts Helper class to cache and resolve font families. 
FullScreenActivity Full screen in-app message activity. 
FullScreenAdapter Full screen adapter. 
FullScreenAdapterFactory Full screen adapter factory. 
FullScreenDisplayContent Display content for a TYPE_FULLSCREEN in-app message. 
FullScreenDisplayContent.Builder Display Content Builder. 


GooglePlayServicesUtilWrapper Wrapper around Google Play Service Utils. 


HtmlActivity HTML in-app message activity. 
HtmlAdapterFactory HTML adapter factory. 
HtmlDisplayAdapter Html display adapter. 
HtmlDisplayContent Display content for a TYPE_HTML in-app message. 
HtmlDisplayContent.Builder Display Content Builder. 


InAppActionUtils Action utils for in-app messaging. 
InAppMessage Defines an in-app message. 
InAppMessage.Builder In-app message builder. 
InAppMessageActivity In-app message activity. 
InAppMessageAdapter In-app message adapter. 
InAppMessageAdapter.Factory Factory interface for InAppMessageAdapters. 
InAppMessageCache Cache for an in-app message. 
InAppMessageExtender Interface used to extend in-app messages. 
InAppMessageListener Listener for in-app message display events. 
InAppMessageManager In-app messaging manager. 
InAppMessageSchedule Defines an in-app message schedule. 
InAppMessageScheduleEdits Edits for an in-app message schedule. 
InAppMessageScheduleEdits.Builder InAppMessageScheduleEdits builder. 
InAppMessageScheduleInfo Class encapsulating the implementor-set information for an in-app message schedule. 
InAppMessageScheduleInfo.Builder In-app message schedule info builder. 
InAppMessageScheduler Interface for scheduling in-app messages. 
InstallReceiver Tracks Google Play Store install referrals. 


JsonException Thrown when a JsonValue is unable to wrap an object or unable to parse a JSON encoded String. 
JsonList An immutable list of JsonValues. 
JsonMap An immutable mapping of String keys to JsonValues. 
JsonMap.Builder Builder class for JsonMap Objects. 
JsonMatcher Class representing the leaf node of a JsonPredicate that contains the relevant field matching info. 
JsonMatcher.Builder Builder class. 
JsonPredicate Class abstracting a JSON predicate. 
JsonPredicate.Builder Builder class. 
JsonSerializable Interface for classes whose instances can be written as a JsonValue. 
JsonValue A JsonValue is a representation of any value that can be described using JSON. 


LandingPageAction Action for launching a Landing Page. 
LandingPageAction.LandingPagePredicate Default LandingPageAction predicate. 
LandingPageActivity An activity that displays a landing page. 
LegacyInAppMessage Legacy in-app message model object. 
LegacyInAppMessage.Builder InAppMessage Builder. 
LegacyInAppMessageManager Legacy in-app message manager. 
LegacyInAppMessageManager.MessageBuilderExtender Interface to extend the InAppMessage.Builder that generates the message from a legacy in-app message. 
LegacyInAppMessageManager.ScheduleInfoBuilderExtender Interface to extend the InAppMessageScheduleInfo.Builder that generates the in-app schedule info from a legacy in-app message. 
LocalizableRemoteInput Remote Input that stores the resource ID instead of a String. 
LocalizableRemoteInput.Builder Builds the LocalizableRemoteInput. 
LocationBackgroundUpdatesAllowedPreference CheckboxPreference to allow/disallow background location updates. 
LocationEvent This class captures all the necessary information for Urban Airship Analytics
LocationListener A location change listener. 
LocationRequestOptions High level location requirements to be used for UALocationManager and service. 
LocationRequestOptions.Builder Builder to construct LocationRequestOptions. 
LocationService A service that handles requesting location from either the Fused Location Provider or standard Android location. 
LocationUpdatesEnabledPreference CheckboxPreference to enable/disable location updates. 
Logger Shared logging wrapper for all Urban Airship log entries. 
LoggerListener Listener interface for the Urban Airship logger. 


MediaDisplayAdapter Display adapter that handles caching an in-app message. 
MediaEventTemplate A class that represents a custom media event template for the application. 
MediaInfo Media display info. 
MediaInfo.Builder Media info builder. 
MessageActivity Manages the message view pager and display messages  
MessageCenter Primary interface for configuring the default Message Center implementation. 
MessageCenterActivity Displays the Urban Airship Message Center using MessageCenterFragment
MessageCenterFragment The Urban Airship Message Center. 
MessageCenterFragment.NoMessageSelectedFragment Fragment that displays instead of a message in split view when no message has been selected. 
MessageFragment Fragment that displays a RichPushMessage
MessageItemView Message Center item view. 
MessageListFragment Fragment that displays the Urban Airship Message Center. 
MessageListFragment.OnListViewReadyCallback Interface that defines the callback when the list view is ready. 
MessageViewAdapter A generic base adapter that binds items to views using the ViewBinder interface. 
ModalActivity Modal in-app message activity. 
ModalAdapter Modal adapter. 
ModalAdapterFactory Modal adapter factory. 
ModalDisplayContent Display content for a TYPE_MODAL in-app message. 
ModalDisplayContent.Builder Display Content Builder. 


NamedUser The named user is an alternate method of identifying the device. 
NotificationActionButton Model object encapsulating the data relevant to a notification action button. 
NotificationActionButton.Builder Builds the NotificationAction. 
NotificationActionButtonGroup Model object encapsulating the data relevant to a notification action button group. 
NotificationActionButtonGroup.Builder Builds the NotificationActionButtonGroup. 
NotificationFactory Notification factory that provides a pathway for customizing the display of push notifications in the Android NotificationManager
NotificationFactory.Result A container for a NotificationFactory result, containing a nullable Notification instance and a status code. 


OpenExternalUrlAction Action for opening a URL for viewing. 
OpenRichPushInboxAction Starts an activity to display either the RichPushInbox or a RichPushMessage using either startInboxActivity() or startMessageActivity(String)
OverlayRichPushMessageAction Displays an inbox message in a landing page. 


Pass Pass representing either an offer or loyalty wallet object. 
PassRequest Defines a request to fetch a Pass
PassRequest.Builder Builds the PassRequest object. 
PendingResult<T> A pending result. 
PlayServicesErrorActivity Activity that handles errors when trying to use Google Play services. 
PlayServicesErrorActivity.ErrorDialogFragment A DialogFragment that wraps Google Play services error dialogs. 
PlayServicesUtils A utility class to help verify and resolve Google Play services issues. 
Predicate<T> Predicate interface. 
ProximityRegion A ProximityRegion defines a proximity region with an identifier, major, minor and optional latitude, longitude and RSSI. 
PublicNotificationExtender Notification builder extender to add the public notification defined by a PushMessage
PushEnablePreference CheckboxPreference to enable/disable push notifications. 
PushManager This class is the primary interface for customizing the display and behavior of incoming push notifications. 
PushMessage A push message, usually created from handling a message intent from either GCM, or another push notification service  
PushService Service to process incoming push notifications. 


QuietTimeEnablePreference CheckboxPreference to enable/disable quiet time. 
QuietTimeEndPreference DialogPreference to set the quiet time end. 
QuietTimePickerPreference Abstract DialogPreference that allows setting quiet time. 
QuietTimeStartPreference DialogPreference to set the quiet time start. 


RateAppAction Action to link users to the rating section of their respective app store directly or through a prompt. 
RateAppActivity An activity that displays a Rate App prompt that links to an app store. 
RegionEvent A RegionEvent defines a region with an identifier, major and minor and optional proximityRegion and/or circularRegion. 
RemoveTagsAction An action that removes tags. 
RemoveTagsAction.RemoveTagsPredicate Default RemoveTagsAction.RemoveTagsPredicate predicate. 
Request Http request wrapper. 
RequestFactory Class that creates the request. 
ResolutionInfo Info used to generate an event when a message is finished. 
Response Model object containing response information from a request. 
Response.Builder Builds a Request Response. 
ResultCallback<T> Result callback interface. 
RetailEventTemplate A class that represents a custom retail event template for the application. 
RichPushInbox The RichPushInbox singleton provides access to the device's local inbox data. 
RichPushInbox.FetchMessagesCallback A callback used to be notified when refreshing messages. 
RichPushInbox.Listener A listener interface for receiving event callbacks related to inbox updates. 
RichPushInbox.Predicate Predicate interface for RichPushMessage
RichPushMessage The primary data structure for Rich Push messages. 
RichPushUser The Urban Airship rich push user. 
RichPushUser.Listener A listener interface for receiving events for user updates. 


Schedule<T extends ScheduleInfo> Class representing an automation action schedule - wraps ScheduleInfo with the schedule ID. 
ScheduleAction Action to schedule ActionScheduleInfo
ScheduleDelay Defines conditions that might delay the execution of a schedule. 
ScheduleDelay.Builder Builder class. 
ScheduleEdits Available automation schedule edits. 
ScheduleInfo Schedule info interface. 
ShareAction Shows a chooser activity to share text. 
SoundEnablePreference CheckboxPreference to enable/disable push notification sounds. 
StyleNotificationExtender Notification builder extender to add the public notification defined by a PushMessage


TagEditor Channel tag editor. 
TagGroupsEditor Interface used for modifying tag groups. 
TagGroupsMutation Defines a tag group mutations. 
TagSelector Tag selector. 
TextInfo Text display info. 
TextInfo.Builder Text info builder. 
ThemedActivity Activity that automatically uses the AppCompat support library if its available and the application extends the app compat theme. 
Timer Timer that can be stopped and started. 
ToastAction An action that displays text in a toast. 
Trigger Trigger defines a condition to execute an ScheduleInfo
Triggers Class providing factory methods and builder classes for Trigger
Triggers.ActiveSessionTriggerBuilder Active session trigger builder class. 
Triggers.CustomEventTriggerBuilder Custom event trigger Builder class. 
Triggers.LifeCycleTriggerBuilder Lifecycle trigger Builder class. 
Triggers.RegionTriggerBuilder Region trigger Builder class. 
Triggers.ScreenTriggerBuilder Screen trigger Builder class. 
Triggers.VersionTriggerBuilder Version trigger builder class. 


UACheckBoxPreference Urban Airship check box preference. 
UAirship UAirship manages the shared state for all Urban Airship services. 
UAirship.OnReadyCallback Callback interface used to notify app when UAirship is ready. 
UALocationManager High level interface for interacting with location. 
UAWebChromeClient Web Chrome Client that enables full screen video. 
UAWebView A web view that sets settings appropriate for Urban Airship content. 

A web view client that intercepts Urban Airship URLs and enables triggering actions from javascript. 

UserIdPreference The Rich Push User preference. 


ValueMatcher Class representing the field matching type and values contained in a JsonMatcher. 
VibrateEnablePreference CheckboxPreference to enable/disable push notification vibration. 


WalletAction Action for opening Android Pay deep links. 
WearableNotificationExtender Notification builder extender to add the wearable overrides defined by a PushMessage
Whitelist Defines a set of URL patterns to match a URL. 
Whitelist.OnWhitelistCallback Interface that defines a callback that can be used to reject whitelisting of a URL.