# ShortTextComplicationData

Artifact: [androidx.wear.watchface:watchface-complications-data](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/complications/data/Data.kt+class:androidx.wear.watchface.complications.data.ShortTextComplicationData) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0)

*** ** * ** ***

<br />

```
class ShortTextComplicationData : ComplicationData
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) ||
|   | ↳ | [androidx.wear.watchface.complications.data.ShortTextComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData) |

*** ** * ** ***

Type used for complications where the primary piece of data is a short piece of text (expected to be no more than seven characters in length). The text may be accompanied by an icon or a title or both.

If only one of icon and title is provided, it is expected that it will be displayed. If both are provided, it is expected that at least one of these will be displayed.

If a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#monochromaticImage()` and a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#smallImage()` are both specified then only one should be displayed. If the complication is drawn with a single color it's recommended to choose `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#monochromaticImage()` and apply a tint. If the complication is rendered with multiple colors it's recommended to choose the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#smallImage()`. It's best practice for a ComplicationDataSource to specify both a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#monochromaticImage()` and a `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#smallImage()`

A data source that wants to serve a ShortTextComplicationData must include the following meta data in its manifest (NB the value is a comma separated list):

```kotlin
<meta-data android:name="android.support.wearable.complications.SUPPORTED_TYPES"
   android:value="SHORT_TEXT"/>
```

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData`. |

| ### Public companion properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#MAX_TEXT_LENGTH()` The maximum length of `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#text()` in characters. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#TYPE()` The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` corresponding to objects of this type. |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#getNextChangeInstant(java.time.Instant)(afterInstant: https://developer.android.com/reference/java/time/Instant.html)` Returns the next `https://developer.android.com/reference/java/time/Instant.html` after `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#getNextChangeInstant(java.time.Instant)` at which any field of the complication may change. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#hasPlaceholderFields()()` Returns `true` if any of the fields of this ComplicationData are placeholders. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#contentDescription()` The content description field for accessibility. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#monochromaticImage()` A simple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage` image that can be tinted by the watch face. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#smallImage()` A `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage` that is expected to cover a small fraction of a watch face occupied by a single complication. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#text()` The body `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText` of the complication. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#title()` The optional title `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText`. |

### Inherited functions

From [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#hashCode()()`

### Inherited properties

From [androidx.wear.watchface.complications.data.ComplicationData](https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData) `https://developer.android.com/reference/android/content/ComponentName.html?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#dataSource()`

The `https://developer.android.com/reference/android/content/ComponentName.html` of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/datasource/ComplicationDataSourceService` that provided the ComplicationData.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#displayPolicy()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationDisplayPolicies` for this complication.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#dynamicValueInvalidationFallback()`

Used in case any dynamic value has been invalidated.
`https://developer.android.com/reference/android/os/PersistableBundle.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#extras()`

A copy of any extras set by a complication provider with the privileged permission `com.google.wear.permission.SET_COMPLICATION_EXTRAS` or `https://developer.android.com/reference/android/os/PersistableBundle.html#EMPTY`.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#persistencePolicy()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationPersistencePolicies` for this complication.
`https://developer.android.com/reference/android/app/PendingIntent.html?` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapAction()`

The `https://developer.android.com/reference/android/app/PendingIntent.html` to send when the complication is tapped on.
`https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapActionLostDueToSerialization()`

`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#tapAction()` which is a `https://developer.android.com/reference/android/app/PendingIntent.html` unfortunately can't be serialized.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#type()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` of this complication data.
`https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/TimeRange` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#validTimeRange()`

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/TimeRange` within which the complication should be displayed.

## Public companion properties

### MAX_TEXT_LENGTH

```
val MAX_TEXT_LENGTH: Int
```

The maximum length of `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ShortTextComplicationData#text()` in characters.

### TYPE

```
val TYPE: ComplicationType
```

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationType` corresponding to objects of this type.

## Public functions

### getNextChangeInstant

```
open fun getNextChangeInstant(afterInstant: Instant): Instant
```

Returns the next `https://developer.android.com/reference/java/time/Instant.html` after `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationData#getNextChangeInstant(java.time.Instant)` at which any field of the complication may change. If there's no scheduled changes then `https://developer.android.com/reference/java/time/Instant.html#MAX` will be returned.

See `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#getNextChangeTime(java.time.Instant)`

| Parameters |
|---|---|
| `afterInstant: https://developer.android.com/reference/java/time/Instant.html` | The reference `https://developer.android.com/reference/java/time/Instant.html`, after which changes will be reported. |

### hasPlaceholderFields

```
open fun hasPlaceholderFields(): Boolean
```

Returns `true` if any of the fields of this ComplicationData are placeholders. I.e. if any fields are equal to: `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#PLACEHOLDER()`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/PhotoImageComplicationData#PLACEHOLDER()`, or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/RangedValueComplicationData#PLACEHOLDER()`.

### toString

```
open fun toString(): String
```

## Public properties

### contentDescription

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

```
val contentDescription: ComplicationText?
```

The content description field for accessibility.

### monochromaticImage

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

```
val monochromaticImage: MonochromaticImage?
```

A simple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage` image that can be tinted by the watch face. If the monochromaticImage is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/MonochromaticImage#PLACEHOLDER()` the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

### smallImage

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

```
val smallImage: SmallImage?
```

A `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage` that is expected to cover a small fraction of a watch face occupied by a single complication. If the smallImage is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/SmallImage#PLACEHOLDER()` the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

### text

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

```
val text: ComplicationText
```

The body `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText` of the complication. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the text is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#PLACEHOLDER()` the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.

### title

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

```
val title: ComplicationText?
```

The optional title `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText`. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated. If the title is equal to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/data/ComplicationText#PLACEHOLDER()` the renderer must treat it as a placeholder rather than rendering normally, its suggested it should be rendered as a light grey box.