Class Index

These are the API classes. See all API packages.

A

ActiveComplicationConfig Encapsulates details about an active ComplicationSlotConfig, including whether the provider app considers the current watch face to be safe. 
AmbientComponentState This lends lifecycle-awareness to ambient components. 
AmbientComponentState.ActivityStateRegistry A state registry specifically intended for app components that subscribe to the standard Android lifecycle. 
AmbientComponentState.WatchFaceStateRegistry A state registry specifically intended for watch face components based on the wallpaper visibility. 
AmbientManager Provides APIs via the Wear SDK for components to integrate with ambient mode support on Wear OS. 
AmbientManager.AmbientComponentListener The callbacks that an ambient component must implement and provide to the AmbientManager at the time of registration via AmbientOptions i.e. 
AmbientManager.AmbientTransitionFinishedNotifier Transition callback provided to the component in#onStartAmbientTransition(TransitionDetails, AmbientTransitionFinishedNotifier) allowing it to signal early completion of the ambient entry or exit transition. 
AmbientManager.AmbientTransitionListener The callbacks that an ambient component must implement and provide to the AmbientManager at the time of registration i.e. 
AmbientManager.ConfigurationDetails Details provided to AmbientComponentListener.onEnterAmbient(AmbientManager.ConfigurationDetails,boolean). 
AmbientManager.Controller A controller provided by the Wear AmbientManager for use in controlling a component's behavior while in ambient mode. 
AmbientManager.TransitionDetails Details provided to AmbientTransitionListener.onStartAmbientTransition(TransitionDetails,AmbientTransitionFinishedNotifier). 
AmbientMode Ambient Mode on Wear keeps the display on but in a low powered mode. 
AmbientOptions AmbientOptions provide components a way to convey their specific ambient mode support configuration requirements for use with AmbientManager.createController(Context,AmbientOptions). 

B

BatterySaverMode Battery Saver Mode on Wear attempts to reduce battery consumption. 
BedtimeMode Bedtime Mode on Wear attempts to provide a great sleep experience focusing on the user's health and well-being. 

C

ComplicationData Wire Format class for complication data of all types. 
ComplicationData.Builder Builder class for ComplicationData. 
ComplicationSlotConfig Represents complication provider configuration for a given watch face slot. 
ComplicationSlotConfig.Builder Builder for ComplicationSlotConfig. 
ComplicationsManager Provides access to various complications methods. 
ComplicationText The text within a complication. 

D

DoNotDisturbMode Do Not Disturb Mode attempts to reduce disturbances by preventing the device from interrupting the user and enabling it may mute all sounds, vibrations, notifications, etc. 
DowntimeMode This class provides APIs for managing Downtime Mode on Wear. 
DynamicComplicationText A ComplicationText where the system evaluates a ProtoLayoutDynamicString. 

F

ForegroundGestureSubscriptionParams Encapsulates parameters for subscribing to GestureEvents while the client is in the foreground (visible to the user). 
ForegroundGestureSubscriptionParams.Builder Builder for ForegroundGestureSubscriptionParams. 

G

GestureEvent Object used to report gesture input events. 
GestureInputManager Manager for gesture inputs, allowing to subscribe to GestureEvent events and query different gesture related configurations. 

L

ListWatchFaceSlotsResponse Represents the response of the WatchFacePushManager.listWatchFaceSlots method. 

M

MediaManager Provides a public interface for managing media auto-launch settings. 
ModeManager Provides a means to query and update the state of modes and features on Wear. 

P

PlainComplicationText A ComplicationText to be used when displaying a static string. 
ProtoLayoutDynamicFloat Describes a Proto Layout DynamicFloat that is evaluated remotely. 
ProtoLayoutDynamicString Describes a Proto Layout DynamicString that is evaluated remotely. 

R

RemoteInteractionsManager The API for managing remote interactions. 

S

SchoolMode School Mode on Wear attempts to reduce distractions catered to preparing the device to be used in a school environment. 
Sdk The Wear SDK provides developers with a new way to access Wear specific platform APIs. 
Sdk.VERSION Version constants for Wear SDK used to determine API availability/compatibility. 
Sdk.VERSION_CODES The set of known Wear SDK version codes:  

T

TargetWatchFaceSafety Defines constants that describe whether or not the watch face the complication is being requested for is deemed to be safe. 
TheaterMode Theater Mode attempts to provide support to users in a dark and quiet environment. 
TileInstance Immutable holder for a tile instance. 
TileProvider Immutable holder for tile provider information. 
TilesManager Provides access to tiles management APIs. 
TiltToWake Tilt To Wake refers to the device's ability to wake up upon tilting. 
TimeDependentText Interface for any object that returns different text depending on the given timestamp. 
TimeDifferenceComplicationText Class to generate string representations of time differences. 
TimeDifferenceComplicationText.Builder Builder for TimeDifferenceComplicationText. 
TimeFormatComplicationText Class to generate string representations of dates/times according to a specified format. 
TimeFormatComplicationText.Builder Builder for TimeFormatComplicationText. 
TouchLockMode Touch Lock Mode controls the device's ability to wake the screen via touch. 

W

WatchFaceId Each watch face is distributed as an app. 
WatchFacePushManager Watch Face Push APIs that allow a third party to to add, update and remove watch faces using built with the Watch Face Format. 
WatchFacePushManager.AddException Exception representing an error of the WatchFacePushManager.addWatchFace method. 
WatchFacePushManager.IsActiveException Exception representing an error of the WatchFacePushManager.isWatchFaceActive method. 
WatchFacePushManager.ListException Exception representing an error of the WatchFacePushManager.listWatchFaceSlots method. 
WatchFacePushManager.ReceiverConnectionException Exception thrown when there is a problem with the Watch Face Receiver Service connection, such as:
  • unsuccessful binding. 
WatchFacePushManager.RemoveException Exception representing an error of the WatchFacePushManager.removeWatchFace method. 
WatchFacePushManager.SetActiveException Exception representing an error of the WatchFacePushManager.removeWatchFace method. 
WatchFacePushManager.UpdateException Exception representing an error of the WatchFacePushManager.updateWatchFace method. 
WatchFaceSlot A watch face slot represents a "place" in the Watch Face Push API where a client app can install a watch face. 
WearApiVersion An API version abstraction provided by the Wear SDK that comprises both the Android platform API level as well as the incremental API level associated with changes introduced in a new release of the Wear OS platform API, based upon the Android platform. 
WearHapticFeedbackConstants This API provides access to the device implementation of the respective haptic constants. 
WearSettings Collection of static constants/methods specific to Wear OS platform settings.