DynamicComplicationText
@RequiresApi(value = 33)
class DynamicComplicationText : ComplicationText
A ComplicationText where the system evaluates a DynamicString. By the time this reaches the watch face's Renderer, it'll have been converted to a plain ComplicationText.
Summary
Public constructors |
|---|
@RequiresApi(value = 34)Creates a |
DynamicComplicationText( |
Public functions |
|
|---|---|
open operator Boolean |
|
open Instant |
getNextChangeTime(afterInstant: Instant)Returns the next time after |
open CharSequence |
Returns the text that should be displayed for the given timestamp. |
open Int |
hashCode() |
open Boolean |
|
open Boolean |
returnsSameText(firstInstant: Instant, secondInstant: Instant)Returns true if the result of |
open String |
toString() |
Public properties |
|
|---|---|
DynamicBuilders.DynamicString |
The |
CharSequence |
Used when the system does not support |
Public constructors
DynamicComplicationText
@RequiresApi(value = 34)
DynamicComplicationText(dynamicValue: DynamicBuilders.DynamicString)
Creates a DynamicComplicationText with no fallbackValue for API levels that are known to support dynamic values.
DynamicComplicationText
DynamicComplicationText(
dynamicValue: DynamicBuilders.DynamicString,
fallbackValue: CharSequence
)
| Parameters | |
|---|---|
dynamicValue: DynamicBuilders.DynamicString |
The |
fallbackValue: CharSequence |
Used when the system does not support This is only relevant before IMPORTANT: This is only used when the system does not support |
Public functions
getNextChangeTime
open fun getNextChangeTime(afterInstant: Instant): Instant
Returns the next time after afterInstant at which the text may change.
getTextAt
open fun getTextAt(resources: Resources, instant: Instant): CharSequence
Returns the text that should be displayed for the given timestamp.
returnsSameText
open fun returnsSameText(firstInstant: Instant, secondInstant: Instant): Boolean
Returns true if the result of getTextAt will be the same for both firstInstant and secondInstant.
Public properties
dynamicValue
val dynamicValue: DynamicBuilders.DynamicString
The DynamicString which will be evaluated into a value dynamically.
fallbackValue
val fallbackValue: CharSequence
Used when the system does not support dynamicValue.
This is only relevant before Build.VERSION_CODES.UPSIDE_DOWN_CAKE, use the no-fallback constructor if you target an equal or higher API level.
IMPORTANT: This is only used when the system does not support dynamicValue at all. See ComplicationData.dynamicValueInvalidationFallback for the situation where the dynamicValue cannot be evaluated, e.g. when a data source is not available.