# Status

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/Status.java+class:androidx.wear.ongoing.Status) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear#1.0.0)

*** ** * ** ***


```
public final class Status implements TimeDependentText
```

<br />

*** ** * ** ***

Base class to represent the status of an Ongoing Activity and render it.

A status is composed of Parts, and they are joined together with a template.

Note that for backwards compatibility reasons the code rendering this status message may not have all of the \[Part\] classes that are available in later versions of the library. Templates that do not have values for all of the named parts will not be used. The template list will be iterated through looking for the first template with all matching named parts available, this will be selected for rendering the status.

To provide for backwards compatibility, you should provide one (or more) fallback templates which use status parts from earlier versions of the API. e.g. TextPart, TimerPart \&StopwatchPart

The status and part classes here use timestamps for updating the displayed representation of the status, in cases when this is needed (chronometers), as returned by `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()`

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/ongoing/Status.Builder` Helper to Build OngoingActivityStatus instances. |
| `public abstract class https://developer.android.com/reference/androidx/wear/ongoing/Status.Part implements https://developer.android.com/reference/androidx/wear/ongoing/TimeDependentText` Abstract class to represent An Ongoing activity status or part of it. |
| `public final class https://developer.android.com/reference/androidx/wear/ongoing/Status.StopwatchPart extends https://developer.android.com/reference/androidx/wear/ongoing/Status.TimerOrStopwatchPart` An Ongoing activity status (or part of it) representing a stopwatch |
| `public final class https://developer.android.com/reference/androidx/wear/ongoing/Status.TextPart extends https://developer.android.com/reference/androidx/wear/ongoing/Status.Part` An Ongoing activity status (or part of it) representing a plain, static text. |
| `public abstract class https://developer.android.com/reference/androidx/wear/ongoing/Status.TimerOrStopwatchPart extends https://developer.android.com/reference/androidx/wear/ongoing/Status.Part` Base class for `https://developer.android.com/reference/androidx/wear/ongoing/Status.TimerPart` and `https://developer.android.com/reference/androidx/wear/ongoing/Status.StopwatchPart`, defines the getters but can't be created directly, create one of those instead. |
| `public final class https://developer.android.com/reference/androidx/wear/ongoing/Status.TimerPart extends https://developer.android.com/reference/androidx/wear/ongoing/Status.TimerOrStopwatchPart` An Ongoing activity status (or part of it) representing a timer. |

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/ongoing/Status` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#forPart(androidx.wear.ongoing.Status.Part)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/ongoing/Status.Part part)` Convenience method for creating a Status with no template and a single Part. |
| `long` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#getNextChangeTimeMillis(long)(long fromTimeMillis)` Returns the next time this status could have a different rendering. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/ongoing/Status.Part` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#getPart(java.lang.String)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html name)` Returns the value of the part with the given name. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Set.html<https://developer.android.com/reference/java/lang/String.html>` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#getPartNames()()` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/CharSequence.html>` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#getTemplates()()` |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/wear/ongoing/Status#getText(android.content.Context,long)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, long timeNowMillis)` Returns a textual representation of this status at the given time. |

## Public methods

### forPart

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

```
public static @NonNull Status forPart(@NonNull Status.Part part)
```

Convenience method for creating a Status with no template and a single Part.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/ongoing/Status.Part part` | The only Part that composes this status. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/ongoing/Status` | A new `https://developer.android.com/reference/androidx/wear/ongoing/Status` with just one Part. |

### getNextChangeTimeMillis

```
public long getNextChangeTimeMillis(long fromTimeMillis)
```

Returns the next time this status could have a different rendering. There is no guarantee that the rendering will change at the returned time (for example, if some information in the status is not rendered).

| Parameters |
|---|---|
| `long fromTimeMillis` | current time, usually now as returned by `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()`. In most cases `getText` and `getNextChangeTimeMillis` should be called with the exact same timestamp, so changes are not missed. |

| Returns |
|---|---|
| `long` | the next time (counting from fromTimeMillis) that this status may produce a different result when calling getText(). |

### getPart

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

```
public @Nullable Status.Part getPart(@NonNull String name)
```

Returns the value of the part with the given name.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html name` | the name to lookup. |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/ongoing/Status.Part` | the part with the given name, can be null. |

### getPartNames

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

```
public @NonNull Set<String> getPartNames()
```

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Set.html<https://developer.android.com/reference/java/lang/String.html>` | the names of the parts provide to this status. |

### getTemplates

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

```
public @NonNull List<CharSequence> getTemplates()
```

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/CharSequence.html>` | the list of templates that this status has. |

### getText

```
public @NonNull CharSequence getText(@NonNull Context context, long timeNowMillis)
```

Returns a textual representation of this status at the given time. The first template that has all required information will be used, and each part will be used in their respective placeholder/s.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context` | may be used for internationalization. Only used while this method executed. |
| `long timeNowMillis` | the timestamp of the time we want to display, usually now, as |

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/CharSequence.html` | the rendered text, for best compatibility, display using a TextView. |