OngoingActivity
class OngoingActivity
Main class to access the Ongoing Activities API. It's created with the Builder. After it's created (and before building and posting the Notification) apply apply needs to be called:
NotificationCompat.Builder builder = new NotificationCompat.Builder(context) .... OngoingActivity ongoingActivity = new OngoingActivity.Builder(context, notificationId, builder); .... ongoingActivity.apply(context); notificationManager.notify(notificationId, builder.build());
Builder is also usen to take defaults if they are not explicitly set on it (see the Builder for details).
Note that if a Notification with that id was previously posted it will be replaced. If you need more than one Notification with the same ID you can use a String tag to differentiate them in both the Builder and notify
Afterward, update can be used to update the status.
If saving the OngoingActivity instance is not convenient, it can be recovered (after the notification is posted) with recoverOngoingActivity
It's worth mentioning that the information provided may be used/redered differently on different SysUIs, so we can only provide a general expectation.
Summary
Nested types |
|---|
class OngoingActivity.BuilderBuilder used to build an |
Public functions |
|
|---|---|
Unit |
Notify the system that this activity should be shown as an Ongoing Activity. |
Icon? |
Get the animated icon that can be used on some surfaces to represent this |
String? |
Get the Category of this |
String? |
Get the content description of this |
LocusIdCompat? |
Get the LocusId of this |
Int |
Get the notificationId of the notification associated with this |
Int |
Get the id to this |
Icon |
Get the static icon that can be used on some surfaces to represent this |
Status? |
Get the status of this ongoing activity, the status may be displayed on the UI to show progress of the Ongoing Activity. |
String? |
getTag()Get the tag of the notification associated with this |
Long |
Get the time (in |
String? |
getTitle()Get the title of this |
PendingIntent |
Get the intent to be used to go back to the activity when the user interacts with the Ongoing Activity in other surfaces (for example, taps the Icon on the WatchFace). |
java-static OngoingActivity? |
recoverOngoingActivity(context: Context)Convenience method for clients that don’t want to / can’t store the OngoingActivity instance. |
java-static OngoingActivity? |
recoverOngoingActivity(Convenience method for clients that don’t want to / can’t store the OngoingActivity instance. |
java-static OngoingActivity? |
recoverOngoingActivity(context: Context, ongoingActivityId: Int)Convenience method for clients that don’t want to / can’t store the OngoingActivity instance. |
Unit |
@RequiresPermission(value = Manifest.permission.POST_NOTIFICATIONS)Update the status of this Ongoing Activity. |
Public functions
apply
fun apply(context: Context): Unit
Notify the system that this activity should be shown as an Ongoing Activity. This will modify the notification builder associated with this Ongoing Activity, so needs to be called before building and posting that notification.
| Parameters | |
|---|---|
context: Context |
May be used to access system services. A reference will not be kept after this call returns. |
getAnimatedIcon
fun getAnimatedIcon(): Icon?
Get the animated icon that can be used on some surfaces to represent this OngoingActivity. For example, in the WatchFace.
getCategory
fun getCategory(): String?
Get the Category of this OngoingActivity if set, otherwise the category of the corresponding notification.
getContentDescription
fun getContentDescription(): String?
Get the content description of this OngoingActivity if set.
getLocusId
fun getLocusId(): LocusIdCompat?
Get the LocusId of this OngoingActivity, this can be used by the launcher to identify the corresponding launcher item and display it accordingly. If not set, returns the one in the corresponding Notification.
getNotificationId
fun getNotificationId(): Int
Get the notificationId of the notification associated with this OngoingActivity.
getOngoingActivityId
fun getOngoingActivityId(): Int
Get the id to this OngoingActivity. This id is used to reference it in recoverOngoingActivity
getStaticIcon
fun getStaticIcon(): Icon
Get the static icon that can be used on some surfaces to represent this OngoingActivity. For example in the WatchFace in ambient mode. If not set, returns the small icon of the corresponding Notification.
getStatus
fun getStatus(): Status?
Get the status of this ongoing activity, the status may be displayed on the UI to show progress of the Ongoing Activity. If not set, returns the content text of the corresponding Notification.
getTag
fun getTag(): String?
Get the tag of the notification associated with this OngoingActivity, or null if there is none.
getTimestamp
fun getTimestamp(): Long
Get the time (in elapsedRealtime time) the OngoingActivity was built.
getTouchIntent
fun getTouchIntent(): PendingIntent
Get the intent to be used to go back to the activity when the user interacts with the Ongoing Activity in other surfaces (for example, taps the Icon on the WatchFace). If not set, returns the touch intent of the corresponding Notification.
recoverOngoingActivity
java-static fun recoverOngoingActivity(context: Context): OngoingActivity?
Convenience method for clients that don’t want to / can’t store the OngoingActivity instance. Note that if there is more than one Ongoing Activity active you have not guarantee over which one you get, you need to use one of the other variations of this method.
| Parameters | |
|---|---|
context: Context |
May be used to access system services. A reference will not be kept after this call returns. |
| Returns | |
|---|---|
OngoingActivity? |
the Ongoing Activity or null if not found |
recoverOngoingActivity
java-static fun recoverOngoingActivity(
context: Context,
filter: Predicate<OngoingActivity!>
): OngoingActivity?
Convenience method for clients that don’t want to / can’t store the OngoingActivity instance.
| Parameters | |
|---|---|
context: Context |
May be used to access system services. A reference will not be kept after this call returns. |
filter: Predicate<OngoingActivity!> |
used to find the required |
| Returns | |
|---|---|
OngoingActivity? |
the Ongoing Activity or null if not found |
recoverOngoingActivity
java-static fun recoverOngoingActivity(context: Context, ongoingActivityId: Int): OngoingActivity?
Convenience method for clients that don’t want to / can’t store the OngoingActivity instance.
| Parameters | |
|---|---|
context: Context |
May be used to access system services. A reference will not be kept after this call returns. |
ongoingActivityId: Int |
the id of the Ongoing Activity to retrieve, set in |
| Returns | |
|---|---|
OngoingActivity? |
the Ongoing Activity or null if not found |