OngoingActivity.Builder

Builder(
    context: Context,
    notificationId: Int,
    notificationBuilder: NotificationCompat.Builder
)

Construct a new empty Builder, associated with the given notification.

Builder(
    context: Context,
    tag: String,
    notificationId: Int,
    notificationBuilder: NotificationCompat.Builder
)

Construct a new empty Builder, associated with the given notification.

fun build(): OngoingActivity

Combine all options provided and the information in the notification if needed, return a new OngoingActivity object. See particular setters for information on what defaults from the notification are used.

fun setAnimatedIcon(animatedIcon: Icon?): OngoingActivity.Builder

Set the animated icon that can be used on some surfaces to represent this OngoingActivity. For example, in the WatchFace. Should be white with a transparent background, preferably an AnimatedVectorDrawable.

If not provided, or set to null, the static icon will be used.

fun setAnimatedIcon(animatedIcon: @DrawableRes Int): OngoingActivity.Builder

Set the animated icon that can be used on some surfaces to represent this OngoingActivity. For example, in the WatchFace. Should be white with a transparent background, preferably an AnimatedVectorDrawable.

If not provided, the static icon will be used.

fun setCategory(category: String?): OngoingActivity.Builder

Set the category of this OngoingActivity. It may be used by the system to prioritize displaying the OngoingActivity.

If set, it Must be one of the predefined notification categories (see the CATEGORY_* constants in NotificationCompat) that best describes this OngoingActivity.

If this is not set (or null), the notification's category is used if present.

fun setContentDescription(contentDescription: String?): OngoingActivity.Builder

Sets the content description of this OngoingActivity. If this is set to a non-null value, it could be used by accesibility services to describe the ongoing activity.

No defaults from the notification are used for this field.

fun setLocusId(locusId: LocusIdCompat?): OngoingActivity.Builder

Set the corresponding LocusId of this OngoingActivity, this will be used by the launcher to identify the corresponding launcher item and display it accordingly.

If set to null or not set, the launcher will use heuristics to do the matching.

fun setOngoingActivityId(ongoingActivityId: Int): OngoingActivity.Builder

Give an id to this OngoingActivity, as a way to reference it in recoverOngoingActivity

fun setStaticIcon(staticIcon: Icon): OngoingActivity.Builder

Set the static icon that can be used on some surfaces to represent this OngoingActivity, for example in the WatchFace in ambient mode. Should be white with a transparent background, preferably a VectorDrawable.

If not set, the smallIcon of the notification will be used. If neither is set, build will throw an exception.

fun setStaticIcon(staticIcon: @DrawableRes Int): OngoingActivity.Builder

Set the static icon that can be used on some surfaces to represent this OngoingActivity, for example in the WatchFace in ambient mode. Should be white with a transparent background, preferably a VectorDrawable.

If not set, the smallIcon of the notification will be used. If neither is set, build will throw an exception.

fun setStatus(status: Status): OngoingActivity.Builder

Set the initial status of this ongoing activity, the status may be displayed on the UI to show progress of the Ongoing Activity.

If not provided, the contentText of the notification will be used.

fun setTitle(title: String?): OngoingActivity.Builder

Sets the Title of this OngoingActivity. If this is set to a non-null value, it could be used by the launcher to override the app's title.

No defaults from the notification are used for this field.

fun setTouchIntent(touchIntent: PendingIntent): OngoingActivity.Builder

Set 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, the contentIntent of the notification will be used. If neither is set, build will throw an exception.