ComplicationDataSourceInfo

Artifact: androidx.wear.watchface:watchface-complications

Added in 1.0.0

Kotlin |Java

class ComplicationDataSourceInfo

Holder of details of a complication data source, for use by watch faces (for example, to show the current complication data source in settings). A ComplicationDataSourceInfoRetriever can be used to obtain references of this class for each of a watch face's complications.

Summary

Public constructors
`ComplicationDataSourceInfo( appName: String, name: String, icon: Icon, type: ComplicationType, componentName: ComponentName? )`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`String`	`appName` The name of the application containing the complication data source.
`ComponentName?`	`componentName` The complication data source's {@link ComponentName}.
`ComplicationData`	`fallbackPreviewData` Lazily constructed fallback preview `ComplicationData` based on this ComplicationDataSourceInfo.
`Icon`	`icon` The icon for the complication data source.
`String`	`name` The name of the complication data source.
`ComplicationType`	`type` The type of the complication provided by the data source.

Public constructors

ComplicationDataSourceInfo

Added in 1.0.0

ComplicationDataSourceInfo(
    appName: String,
    name: String,
    icon: Icon,
    type: ComplicationType,
    componentName: ComponentName?
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

appName

Added in 1.0.0

val appName: String

The name of the application containing the complication data source.

componentName

Added in 1.0.0

val componentName: ComponentName?

The complication data source's {@link ComponentName}.

This field is populated only on Android R and above and it is null otherwise.

fallbackPreviewData

Added in 1.0.0

val fallbackPreviewData: ComplicationData

Lazily constructed fallback preview ComplicationData based on this ComplicationDataSourceInfo. This is useful when ComplicationDataSourceInfoRetriever.retrievePreviewComplicationData returns null (e.g. on a pre-android R device).

icon

Added in 1.0.0

val icon: Icon

The icon for the complication data source.

name

Added in 1.0.0

val name: String

The name of the complication data source.

type

Added in 1.0.0

val type: ComplicationType

The type of the complication provided by the data source.