OverlayStyle

Artifact: androidx.wear.watchface:watchface-client

Added in 1.1.0

Deprecated in 1.2.0

Kotlin |Java

class OverlayStyle

This class reflects a snapshot of androidx.wear.watchface.WatchFace.OverlayStyle.

Note while this plumbing got built, it was never used by the system ui on any platform and it will be removed.

Summary

Public constructors
`OverlayStyle()` This function is deprecated. OverlayStyle will be removed in a future release.
`OverlayStyle(backgroundColor: Color?, foregroundColor: Color?)` This function is deprecated. OverlayStyle will be removed in a future release.

Public functions
`open operator Boolean`	`equals(other: Any?)` This function is deprecated. OverlayStyle will be removed in a future release.
`open Int`	`hashCode()` This function is deprecated. OverlayStyle will be removed in a future release.
`open String`	`toString()` This function is deprecated. OverlayStyle will be removed in a future release.

Public properties
`Color?`	`backgroundColor` This property is deprecated. OverlayStyle will be removed in a future release.
`Color?`	`foregroundColor` This property is deprecated. OverlayStyle will be removed in a future release.

Public constructors

OverlayStyle

Added in 1.1.0

Deprecated in 1.2.0

OverlayStyle()

Default constructor when when there's no data available. E.g. when dealing with an old watch face.

OverlayStyle

Added in 1.1.0

Deprecated in 1.2.0

OverlayStyle(backgroundColor: Color?, foregroundColor: Color?)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

backgroundColor

Added in 1.1.0

Deprecated in 1.2.0

val backgroundColor: Color?

The background color of the status indicator tray. This can be any color, including Color.TRANSPARENT. If this is null then the system default will be used.

foregroundColor

Added in 1.1.0

Deprecated in 1.2.0

val foregroundColor: Color?

The background color of items rendered in the status indicator tray. If not null then this must be either Color.BLACK or Color.WHITE. If this is null then the system default will be used.