SystemProviders

Kotlin |Java

public class SystemProviders
extends Object

java.lang.Object
↳	androidx.wear.complications.SystemProviders

Methods to retrieve the component names for system complication providers. This will allow these providers to be used as defaults by watch faces.

Summary

Constants
`int`	`APP_SHORTCUT` Id for the 'app shortcut' complication provider.
`int`	`DATE` Id for the 'date' complication provider.
`int`	`DAY_AND_DATE` Id for the 'day and date' complication provider.
`int`	`DAY_OF_WEEK` Id for the 'day of week' complication provider.
`int`	`FAVORITE_CONTACT` Id for the 'favorite contact' complication provider.
`int`	`MOST_RECENT_APP` Id for the 'most recent app' complication provider.
`int`	`NEXT_EVENT` Id for the 'next event' complication provider.
`int`	`NO_PROVIDER` Specifies that no provider should be used.
`int`	`RETAIL_CHAT` Id for the 'retail mode chat' complication provider.
`int`	`RETAIL_STEP_COUNT` Id for the 'retail mode step count' complication provider.
`int`	`STEP_COUNT` Id for the 'step count' complication provider.
`int`	`SUNRISE_SUNSET` Id for the 'sunrise sunset' complication provider.
`int`	`TIME_AND_DATE` Id for the 'time and date' complication provider.
`int`	`UNREAD_NOTIFICATION_COUNT` Id for the 'unread notification count' complication provider.
`int`	`WATCH_BATTERY` Id for the 'watch battery' complication provider.
`int`	`WORLD_CLOCK` Id for the 'world clock' complication provider.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Constants

APP_SHORTCUT

public static final int APP_SHORTCUT

Id for the 'app shortcut' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports the following types: TYPE_SMALL_IMAGE, TYPE_LONG_TEXT.

Constant Value: 6 (0x00000006)

DATE

public static final int DATE

Id for the 'date' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 2 (0x00000002)

DAY_AND_DATE

public static final int DAY_AND_DATE

Id for the 'day and date' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 16 (0x00000010)

DAY_OF_WEEK

public static final int DAY_OF_WEEK

Id for the 'day of week' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 13 (0x0000000d)

FAVORITE_CONTACT

public static final int FAVORITE_CONTACT

Id for the 'favorite contact' complication provider.

This is not a safe provider, so if a watch face uses this as a default it will receive data of TYPE_NO_PERMISSION until the user has granted the RECEIVE_COMPLICATION_DATA.

This provider supports only TYPE_SMALL_IMAGE.

Constant Value: 14 (0x0000000e)

MOST_RECENT_APP

public static final int MOST_RECENT_APP

Id for the 'most recent app' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports TYPE_SMALL_IMAGE, TYPE_LONG_TEXT.

Constant Value: 15 (0x0000000f)

NEXT_EVENT

public static final int NEXT_EVENT

Id for the 'next event' complication provider.

This is not a safe provider, so if a watch face uses this as a default it will receive data of TYPE_NO_PERMISSION until the user has granted the RECEIVE_COMPLICATION_DATA.

This provider supports the following types: TYPE_SHORT_TEXT, TYPE_LONG_TEXT.

Constant Value: 9 (0x00000009)

NO_PROVIDER

public static final int NO_PROVIDER

Specifies that no provider should be used.

Constant Value: -1 (0xffffffff)

RETAIL_CHAT

public static final int RETAIL_CHAT

Id for the 'retail mode chat' complication provider.

This provider shows fake 'unread chat messages' data, and the tap action launches the retail mode chat app. This provider should only be set as a default if the device is in retail mode.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 11 (0x0000000b)

RETAIL_STEP_COUNT

public static final int RETAIL_STEP_COUNT

Id for the 'retail mode step count' complication provider.

This provider shows fake step count data, and the tap action launches the retail mode health app. This provider should only be set as a default if the device is in retail mode.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 10 (0x0000000a)

STEP_COUNT

public static final int STEP_COUNT

Id for the 'step count' complication provider.

This is a safe provider (because it only shows a daily total), so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 4 (0x00000004)

SUNRISE_SUNSET

public static final int SUNRISE_SUNSET

Id for the 'sunrise sunset' complication provider.

This provider shows next sunrise or sunset time according to current timezone and location.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 12 (0x0000000c)

TIME_AND_DATE

public static final int TIME_AND_DATE

Id for the 'time and date' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 3 (0x00000003)

UNREAD_NOTIFICATION_COUNT

public static final int UNREAD_NOTIFICATION_COUNT

Id for the 'unread notification count' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports the following types: TYPE_ICON, TYPE_SHORT_TEXT.

Constant Value: 7 (0x00000007)

WATCH_BATTERY

public static final int WATCH_BATTERY

Id for the 'watch battery' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports the following types: TYPE_ICON, TYPE_SHORT_TEXT, TYPE_LONG_TEXT, TYPE_RANGED_VALUE.

Constant Value: 1 (0x00000001)

WORLD_CLOCK

public static final int WORLD_CLOCK

Id for the 'world clock' complication provider.

This is a safe provider, so if a watch face uses this as a default it will be able to receive data from it even before the RECEIVE_COMPLICATION_DATA permission has been granted.

This provider supports only TYPE_SHORT_TEXT.

Constant Value: 5 (0x00000005)