xref: /aosp_15_r20/prebuilts/sdk/opt/wear/34.1/public/api/wear-sdk.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b)
1// Signature format: 2.0
2package com.google.wear {
3
4  public final class Sdk {
5    method @Deprecated @Nullable public static <T> T getWearManager(@NonNull Class<T>);
6    method @Nullable public static <T> T getWearManager(@NonNull android.content.Context, @NonNull Class<T>);
7    method public static boolean hasApiFeature(String);
8    method public static boolean isApiVersionAtLeast(@NonNull com.google.wear.WearApiVersion);
9    field @Deprecated public static final String FEATURE_WEAR_TIRAMISU_QPR1_API = "com.google.wear.api.T_QPR1";
10    field @Deprecated public static final String FEATURE_WEAR_TIRAMISU_QPR2_API = "com.google.wear.api.T_QPR2";
11    field @Deprecated public static final String FEATURE_WEAR_TIRAMISU_QPR3_API = "com.google.wear.api.T_QPR3";
12    field @Deprecated public static final String FEATURE_WEAR_TIRAMISU_QPR4_API = "com.google.wear.api.T_QPR4";
13  }
14
15  public static final class Sdk.VERSION {
16    method public static boolean isIncrementalRelease();
17    field public static final int RELEASE;
18    field public static final int WEAR_SDK_INT;
19  }
20
21  public static final class Sdk.VERSION_CODES {
22    field @NonNull public static final com.google.wear.WearApiVersion WEAR_TIRAMISU_1;
23    field @NonNull public static final com.google.wear.WearApiVersion WEAR_TIRAMISU_2;
24    field @NonNull public static final com.google.wear.WearApiVersion WEAR_TIRAMISU_3;
25    field @NonNull public static final com.google.wear.WearApiVersion WEAR_TIRAMISU_4;
26    field @NonNull public static final com.google.wear.WearApiVersion WEAR_UDC_1;
27  }
28
29  public final class WearApiVersion implements java.lang.Comparable<com.google.wear.WearApiVersion> {
30    method public int compareTo(@NonNull com.google.wear.WearApiVersion);
31  }
32
33}
34
35package com.google.wear.input {
36
37  public final class WearHapticFeedbackConstants {
38    method public static int getScrollItemFocus();
39    method public static int getScrollLimit();
40    method public static int getScrollTick();
41  }
42
43}
44
45package com.google.wear.modes {
46
47  public class AmbientMode {
48    method @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
49    method @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public long getOverriddenReasons();
50    method @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public boolean isActive();
51    method @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public boolean isConfigured();
52    method @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public boolean isOverridden();
53    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
54    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_DISPLAY_CONFIG) public void setConfigured(boolean);
55  }
56
57  public class BatterySaverMode {
58    method @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public void addActiveLevelListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);
59    method @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public int getActiveLevel();
60    method @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public int getConfiguredLevel();
61    method @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public long getOverriddenReasons();
62    method @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public boolean isOverridden();
63    method public void removeActiveLevelListener(@NonNull java.util.function.Consumer<java.lang.Integer>);
64    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_BATTERY_SAVER) public void setConfiguredLevel(int);
65    field public static final int BATTERY_SAVER_LEVEL_NORMAL = 1; // 0x1
66    field public static final int BATTERY_SAVER_LEVEL_OFF = 0; // 0x0
67  }
68
69  public class BedtimeMode {
70    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
71    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public long getOverriddenReasons();
72    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isActive();
73    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isConfigured();
74    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isOverridden();
75    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
76    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_FOCUS_MODES) public void setConfigured(boolean);
77  }
78
79  public class DoNotDisturbMode {
80    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
81    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public long getOverriddenReasons();
82    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isActive();
83    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isConfigured();
84    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isOverridden();
85    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
86    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_FOCUS_MODES) public void setConfigured(boolean);
87  }
88
89  public final class ModeManager {
90    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_DISPLAY_CONFIG) public com.google.wear.modes.AmbientMode getAmbientMode() throws java.lang.SecurityException;
91    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_BATTERY_SAVER) public com.google.wear.modes.BatterySaverMode getBatterySaverMode() throws java.lang.SecurityException;
92    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public com.google.wear.modes.BedtimeMode getBedtimeMode();
93    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public com.google.wear.modes.DoNotDisturbMode getDoNotDisturbMode() throws java.lang.SecurityException;
94    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public com.google.wear.modes.SchoolMode getSchoolMode();
95    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public com.google.wear.modes.TheaterMode getTheaterMode() throws java.lang.SecurityException;
96    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public com.google.wear.modes.TiltToWake getTiltToWake() throws java.lang.SecurityException;
97    method @Nullable @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public com.google.wear.modes.TouchLockMode getTouchLockMode() throws java.lang.SecurityException;
98    field public static final long FLAG_OVERRIDDEN_BY_BATTERY_SAVER_MODE = 8L; // 0x8L
99    field public static final long FLAG_OVERRIDDEN_BY_BEDTIME_MODE = 4L; // 0x4L
100    field public static final long FLAG_OVERRIDDEN_BY_SCHOOL_MODE = 32L; // 0x20L
101    field public static final long FLAG_OVERRIDDEN_BY_SCREEN_READER = 2L; // 0x2L
102    field public static final long FLAG_OVERRIDDEN_BY_THEATER_MODE = 16L; // 0x10L
103    field public static final long FLAG_OVERRIDDEN_BY_UNKNOWN_REASON = 1L; // 0x1L
104  }
105
106  public class SchoolMode {
107    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
108    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public long getOverriddenReasons();
109    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isActive();
110    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isConfigured();
111    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isOverridden();
112    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
113    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_FOCUS_MODES) public void setConfigured(boolean);
114  }
115
116  public class TheaterMode {
117    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
118    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public long getOverriddenReasons();
119    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isActive();
120    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isConfigured();
121    method @RequiresPermission(com.google.wear.services.Permissions.READ_FOCUS_MODES) public boolean isOverridden();
122    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
123    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_FOCUS_MODES) public void setConfigured(boolean);
124  }
125
126  public class TiltToWake {
127    method @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
128    method @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public long getOverriddenReasons();
129    method @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public boolean isActive();
130    method @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public boolean isConfigured();
131    method @RequiresPermission(com.google.wear.services.Permissions.READ_GESTURES_CONFIG) public boolean isOverridden();
132    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
133    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_GESTURES_CONFIG) public void setConfigured(boolean);
134  }
135
136  public class TouchLockMode {
137    method @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public void addIsActiveListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Boolean>);
138    method @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public long getOverriddenReasons();
139    method @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public boolean isActive();
140    method @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public boolean isConfigured();
141    method @RequiresPermission(com.google.wear.services.Permissions.READ_TOUCH_LOCK) public boolean isOverridden();
142    method public void removeIsActiveListener(@NonNull java.util.function.Consumer<java.lang.Boolean>);
143    method @RequiresPermission(com.google.wear.services.Permissions.WRITE_TOUCH_LOCK) public void setConfigured(boolean);
144  }
145
146}
147
148package com.google.wear.services.ambient {
149
150  public class AmbientComponentState {
151    method public static com.google.wear.services.ambient.AmbientComponentState.ActivityStateRegistry makeActivityStateRegistry();
152    method public static com.google.wear.services.ambient.AmbientComponentState.WatchFaceStateRegistry makeWatchFaceStateRegistry();
153  }
154
155  public static final class AmbientComponentState.ActivityStateRegistry {
156    method public void onPause();
157    method public void onResume();
158  }
159
160  public static final class AmbientComponentState.WatchFaceStateRegistry {
161    method public void onVisibilityChanged(boolean);
162  }
163
164  public class AmbientManager {
165    method public com.google.wear.services.ambient.AmbientManager.Controller createController(@NonNull android.content.Context, @NonNull com.google.wear.services.ambient.AmbientOptions);
166  }
167
168  @MainThread public static interface AmbientManager.AmbientComponentListener {
169    method public default void onEnterAmbient(com.google.wear.services.ambient.AmbientManager.ConfigurationDetails, boolean);
170    method public default void onExitAmbient();
171    method public default void onUpdateAmbient();
172  }
173
174  public static interface AmbientManager.AmbientTransitionFinishedNotifier {
175    method @MainThread public void notifyFinished();
176  }
177
178  public static interface AmbientManager.AmbientTransitionListener {
179    method @WorkerThread public void onCancelAmbientTransition(boolean);
180    method @MainThread public void onStartAmbientTransition(com.google.wear.services.ambient.AmbientManager.TransitionDetails, com.google.wear.services.ambient.AmbientManager.AmbientTransitionFinishedNotifier);
181  }
182
183  public static interface AmbientManager.ConfigurationDetails {
184    method public boolean isBurnInProtectionEnabled();
185    method public boolean isLowBitDepthEnabled();
186  }
187
188  public static final class AmbientManager.Controller {
189    method public void destroy();
190    method public int getAmbientSupportLevel();
191    method public boolean isAmbientSupportEnabled();
192    method public boolean isAutoResumeEnabled();
193    method public boolean isComponentInAmbient();
194    method public boolean isSystemInAmbient();
195    method public void setAmbientSupportLevel(int);
196  }
197
198  public static interface AmbientManager.TransitionDetails {
199    method public long getMaxTransitionDurationMillis();
200    method public int getTransitionDirection();
201    field public static final int TRANSIT_TO_AMBIENT = 1; // 0x1
202    field public static final int TRANSIT_TO_INTERACTIVE = 2; // 0x2
203  }
204
205  public final class AmbientOptions {
206    method public static com.google.wear.services.ambient.AmbientOptions makeActivityOptions(@NonNull android.app.Activity, @NonNull com.google.wear.services.ambient.AmbientComponentState.ActivityStateRegistry, @NonNull com.google.wear.services.ambient.AmbientManager.AmbientComponentListener, @Nullable com.google.wear.services.ambient.AmbientManager.AmbientTransitionListener);
207    method public static com.google.wear.services.ambient.AmbientOptions makeWatchFaceOptions(@NonNull android.content.ComponentName, @NonNull com.google.wear.services.ambient.AmbientComponentState.WatchFaceStateRegistry, @NonNull com.google.wear.services.ambient.AmbientManager.AmbientComponentListener, @Nullable com.google.wear.services.ambient.AmbientManager.AmbientTransitionListener);
208    field public static final int AMBIENT_SUPPORT_AUTORESUME_ONLY = 1; // 0x1
209    field public static final int AMBIENT_SUPPORT_NONE = 0; // 0x0
210    field public static final int AMBIENT_SUPPORT_TAKEOVER_DISPLAY = 2; // 0x2
211  }
212
213}
214
215package com.google.wear.services.remoteinteractions {
216
217  public final class RemoteInteractionsManager {
218    method public void registerRemoteActivityHelperStatusListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);
219    method public void registerRemoteAuthClientStatusListener(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<java.lang.Integer>);
220    method public void unregisterRemoteActivityHelperStatusListener(@NonNull java.util.function.Consumer<java.lang.Integer>);
221    method public void unregisterRemoteAuthClientStatusListener(@NonNull java.util.function.Consumer<java.lang.Integer>);
222    field public static final int STATUS_AVAILABLE = 3; // 0x3
223    field public static final int STATUS_TEMPORARILY_UNAVAILABLE = 2; // 0x2
224    field public static final int STATUS_UNAVAILABLE = 1; // 0x1
225    field public static final int STATUS_UNKNOWN = 0; // 0x0
226  }
227
228}
229
230package com.google.wear.services.tiles {
231
232  public class TileInstance {
233    method public int getId();
234    method @NonNull public com.google.wear.services.tiles.TileProvider getTileProvider();
235  }
236
237  public class TileProvider {
238    method @NonNull public android.content.ComponentName getComponentName();
239  }
240
241  public class TilesManager {
242    method public void getActiveTiles(@NonNull java.util.concurrent.Executor, @NonNull android.os.OutcomeReceiver<java.util.List<com.google.wear.services.tiles.TileInstance>,java.lang.Exception>);
243  }
244
245}
246
247package com.google.wear.settings {
248
249  public class WearSettings {
250    method public static boolean isWristDetectionAutoLockingEnabled(@NonNull android.content.Context);
251  }
252
253}
254
255