datalayer-watch/com.google.android.horologist.datalayer.watch/WearDataLayerAppHelper

WearDataLayerAppHelper

class WearDataLayerAppHelper(context: Context, registry: WearDataLayerRegistry, scope: CoroutineScope, appStoreUri: String? = null) : DataLayerAppHelper

Subclass of DataLayerAppHelper for use on Wear devices.

Parameter appStoreUri should be provided when using functions like installOnNode with an iOS device.

Constructors

constructor(context: Context, registry: WearDataLayerRegistry, scope: CoroutineScope, appStoreUri: String? = null)

Properties

connectedAndInstalledNodes

open override val connectedAndInstalledNodes: Flow<Set<Node>>

surfacesInfo

val surfacesInfo: Flow<SurfacesInfo>

Return the SurfacesInfo of this node.

Functions

connectedNodes

suspend fun connectedNodes(): List<AppHelperNodeStatus>

installOnNode

open suspend override fun installOnNode(nodeId: String): AppHelperResultCode

isAvailable

suspend fun isAvailable(): Boolean

markActivityLaunchedOnce

suspend fun markActivityLaunchedOnce()

Marks that the main activity has been launched at least once.

markComplicationAsActivated

suspend fun markComplicationAsActivated(complicationName: String, complicationInstanceId: Int, complicationType: ComplicationType)

Marks a complication as activated. Call this in ComplicationDataSourceService.onComplicationActivated.

markComplicationAsDeactivated

suspend fun markComplicationAsDeactivated(complicationName: String, complicationInstanceId: Int, complicationType: ComplicationType)

Marks a complication as deactivated. Call this in ComplicationDataSourceService.onComplicationDeactivated.

markSetupComplete

suspend fun markSetupComplete()

Marks that the necessary setup steps have been completed in the app such that it is ready for use. Typically this should be called when any pairing/login has been completed. If used for prompting login, it should also be called during startup if login happened before

markSetupNoLongerComplete

suspend fun markSetupNoLongerComplete()

Marks that the app is no longer considered in a fully setup state. For example, the user has logged out. This will roll the state back to the app having been used once - if the setup had previously been completed, but will have no effect if this is not the case.

markTileAsInstalled

suspend fun markTileAsInstalled(tileName: String)

Marks a tile as installed. Call this in TileService#onTileAddEvent. Supplying a name is mandatory to disambiguate from the installation or removal of other tiles your app may have.

markTileAsRemoved

suspend fun markTileAsRemoved(tileName: String)

Marks a tile as removed. Call this in TileService#onTileRemoveEvent. Supplying a name is mandatory to disambiguate from the installation or removal of other tiles your app may have.

startCompanion

@CheckResult

open suspend override fun startCompanion(nodeId: String): AppHelperResultCode

startRemoteActivity

suspend fun startRemoteActivity(nodeId: String, config: ActivityConfig): AppHelperResultCode

startRemoteOwnApp

suspend fun startRemoteOwnApp(nodeId: String): AppHelperResultCode