# OngoingActivity.Builder

# OngoingActivity.Builder

Artifact:[androidx.wear:wear-ongoing](https://developer.android.com/jetpack/androidx/releases/wear)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/ongoing/OngoingActivity.java+class:androidx.wear.ongoing.OngoingActivity.Builder)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/ongoing/OngoingActivity.Builder "View this page in Java")

<br />

```
class OngoingActivity.Builder
```

<br />

*** ** * ** ***

Builder used to build an[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity)

Note that many fields take a default value from the provided notification if not explicitly set. If set explicitly and in the notification, the value set through the[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder)will be used.

The only required fields (set through the builder or the notification) are static icon and pending intent.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                         ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                                         |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#Builder(android.content.Context,int,androidx.core.app.NotificationCompat.Builder))`(` ` context: `[Context](https://developer.android.com/reference/android/content/Context.html)`,` ` notificationId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` notificationBuilder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder) `)` Construct a new empty[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), associated with the given notification.                                                                                                               |
| [Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#Builder(android.content.Context,java.lang.String,int,androidx.core.app.NotificationCompat.Builder))`(` ` context: `[Context](https://developer.android.com/reference/android/content/Context.html)`,` ` tag: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`,` ` notificationId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`,` ` notificationBuilder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder) `)` Construct a new empty[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), associated with the given notification. |

|                                                  ### Public functions                                                   |
|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity)                 | [build](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#build())`()` Combine all options provided and the information in the notification if needed, return a new[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity)object.                                                                                                                                                                                                                                                |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setAnimatedIcon](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setAnimatedIcon(android.graphics.drawable.Icon))`(animatedIcon: `[Icon](https://developer.android.com/reference/android/graphics/drawable/Icon.html)`?)` Set the animated icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).                                                                                                                   |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setAnimatedIcon](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setAnimatedIcon(int))`(animatedIcon: @`[DrawableRes](https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes)` `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Set the animated icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).                                                      |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setCategory](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setCategory(java.lang.String))`(category: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Set the category of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).                                                                                                                                                                                                |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setContentDescription](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setContentDescription(java.lang.String))`(contentDescription: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the content description of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).                                                                                                                                                      |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setLocusId](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setLocusId(androidx.core.content.LocusIdCompat))`(locusId: `[LocusIdCompat](https://developer.android.com/reference/kotlin/androidx/core/content/LocusIdCompat)`?)` Set the corresponding LocusId of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity), this will be used by the launcher to identify the corresponding launcher item and display it accordingly.                                       |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setOngoingActivityId](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setOngoingActivityId(int))`(ongoingActivityId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Give an id to this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity), as a way to reference it in[recoverOngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity#recoverOngoingActivity(android.content.Context,int)) |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setStaticIcon](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setStaticIcon(android.graphics.drawable.Icon))`(staticIcon: `[Icon](https://developer.android.com/reference/android/graphics/drawable/Icon.html)`)` Set the static icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity), for example in the WatchFace in ambient mode.                                                                              |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setStaticIcon](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setStaticIcon(int))`(staticIcon: @`[DrawableRes](https://developer.android.com/reference/kotlin/androidx/annotation/DrawableRes)` `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Set the static icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity), for example in the WatchFace in ambient mode.                |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setStatus](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setStatus(androidx.wear.ongoing.Status))`(status: `[Status](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/Status)`)` Set the initial status of this ongoing activity, the status may be displayed on the UI to show progress of the Ongoing Activity.                                                                                                                                                                                       |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setTitle](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setTitle(java.lang.String))`(title: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`?)` Sets the Title of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).                                                                                                                                                                                                           |
| [OngoingActivity.Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder) | [setTouchIntent](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#setTouchIntent(android.app.PendingIntent))`(touchIntent: `[PendingIntent](https://developer.android.com/reference/android/app/PendingIntent.html)`)` 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).                                                                                                                                  |

## Public constructors

### Builder

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Construct a new empty[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), associated with the given notification.  

|                                                                    Parameters                                                                    |
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `context: `[Context](https://developer.android.com/reference/android/content/Context.html)                                                       | to be used during the life of this[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), will NOT pass a reference into the built[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity) |
| `notificationId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                    | id that will be used to post the notification associated with this Ongoing Activity                                                                                                                                                                                                        |
| `notificationBuilder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder) | builder for the notification associated with this Ongoing Activity                                                                                                                                                                                                                         |

### Builder

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Construct a new empty[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), associated with the given notification.  

|                                                                    Parameters                                                                    |
|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `context: `[Context](https://developer.android.com/reference/android/content/Context.html)                                                       | to be used during the life of this[Builder](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder), will NOT pass a reference into the built[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity) |
| `tag: `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                                         | tag that will be used to post the notification associated with this Ongoing Activity                                                                                                                                                                                                       |
| `notificationId: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                                                    | id that will be used to post the notification associated with this Ongoing Activity                                                                                                                                                                                                        |
| `notificationBuilder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder) | builder for the notification associated with this Ongoing Activity                                                                                                                                                                                                                         |

## Public functions

### build

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

```
fun build(): OngoingActivity
```

Combine all options provided and the information in the notification if needed, return a new[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity)object. See particular setters for information on what defaults from the notification are used.  

|                                                        Throws                                                         |
|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
| [java.lang.IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the static icon or the touch intent are not provided. |

### setAnimatedIcon

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Set the animated icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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.  

### setAnimatedIcon

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Set the animated icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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.  

### setCategory

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Set the category of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity). It may be used by the system to prioritize displaying the[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).

If set, it Must be one of the predefined notification categories (see the`CATEGORY_*`constants in[NotificationCompat](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat)) that best describes this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity).

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

### setContentDescription

Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/wear#1.1.0)  

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

Sets the content description of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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.  

### setLocusId

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Set the corresponding LocusId of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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.  

### setOngoingActivityId

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

```
fun setOngoingActivityId(ongoingActivityId: Int): OngoingActivity.Builder
```

Give an id to this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity), as a way to reference it in[recoverOngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity#recoverOngoingActivity(android.content.Context,int))  

### setStaticIcon

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

```
fun setStaticIcon(staticIcon: Icon): OngoingActivity.Builder
```

Set the static icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#build())will throw an exception.  

### setStaticIcon

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Set the static icon that can be used on some surfaces to represent this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#build())will throw an exception.  

### setStatus

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

```
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.  

### setTitle

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

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

Sets the Title of this[OngoingActivity](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/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.  

### setTouchIntent

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)  

```
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](https://developer.android.com/reference/kotlin/androidx/wear/ongoing/OngoingActivity.Builder#build())will throw an exception.