WatchFaceConfigIntentHelper

public final class WatchFaceConfigIntentHelper

Helper functions for use by watch face configuration activities. In general, there are two distinct users:

• ones creating Intents

• ones receiving and responding to those Intents.

To register a configuration activity for a watch face, add a <meta-data> entry to the watch face component in its Android Manifest file with an intent action to be fired to start the activity. The following meta-data will register the androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR action to be started when configuring a watch face on the wearable device:

<meta-data
android:name="com.google.android.wearable.watchface.wearableConfigurationAction"
android:value="androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR" />

To register a configuration activity to be started on a companion phone, add the following alternative meta-data entry to the watch face component:

<meta-data
android:name="com.google.android.wearable.watchface.companionConfigurationAction"
android:value="androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR" />

The activity should have an intent filter which lists the action specified in the meta-data block above, in addition to the two categories present in the following example:

<activity android:name=".MyWatchFaceConfigActivity">
<intent-filter>
<action android:name="androidx.wear.watchface.editor.action.WATCH_FACE_EDITOR" />
<category android:name=
"com.google.android.wearable.watchface.category.WEARABLE_CONFIGURATION" />
<category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</activity>

For phone side configuration activities, substitute the category com.google.android.wearable.watchface.category.COMPANION_CONFIGURATION for com.google.android.wearable.watchface.category.WEARABLE_CONFIGURATION.

Summary

public static final @Nullable String getPeerIdExtra(@NonNull Intent watchFaceIntent)

public static final @Nullable ComponentName getWatchFaceComponentExtra(@NonNull Intent watchFaceIntent)

public static final @NonNull Intent putPeerIdExtra(@NonNull Intent watchFaceIntent, @NonNull String peerId)

public static final @NonNull Intent putWatchFaceComponentExtra(
    @NonNull Intent watchFaceIntent,
    @NonNull ComponentName componentName
)