blob: 507d1d82330c742b0ba31206a57b138f6cac424e [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbyec91531a2015-04-01 17:41:55 -070019import android.annotation.AttrRes;
Bo Liu58a57662019-03-06 20:21:45 +000020import android.annotation.CallbackExecutor;
Tor Norbye1c2bf032015-03-02 10:57:08 -080021import android.annotation.CheckResult;
Tor Norbye3e4cda72015-06-10 08:14:31 -070022import android.annotation.ColorInt;
23import android.annotation.ColorRes;
24import android.annotation.DrawableRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070025import android.annotation.IntDef;
26import android.annotation.NonNull;
27import android.annotation.Nullable;
Tor Norbye788fc2b2015-07-05 16:10:42 -070028import android.annotation.RequiresPermission;
Tor Norbyed9273d62013-05-30 15:59:53 -070029import android.annotation.StringDef;
Tor Norbye7b9c9122013-05-30 16:48:33 -070030import android.annotation.StringRes;
31import android.annotation.StyleRes;
32import android.annotation.StyleableRes;
Jinsuk Kim66d1eb22014-06-06 16:12:18 +090033import android.annotation.SystemApi;
Jeff Sharkeya73b8fd2016-01-06 17:02:08 -070034import android.annotation.TestApi;
Mathew Inwood5c0d3542018-08-14 13:54:31 +010035import android.annotation.UnsupportedAppUsage;
Jeff Sharkey8588bc12016-01-06 16:47:42 -070036import android.annotation.UserIdInt;
Selim Cinek7fa385a2018-01-24 08:35:28 -080037import android.app.ActivityManager;
Tony Mak46aabe52016-11-14 12:53:06 +000038import android.app.IApplicationThread;
39import android.app.IServiceConnection;
Zak Cohen56345f42017-01-26 13:54:28 -080040import android.app.VrManager;
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -070041import android.content.pm.ApplicationInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042import android.content.pm.PackageManager;
43import android.content.res.AssetManager;
Alan Viverette45c4bbb2015-01-05 14:59:19 -080044import android.content.res.ColorStateList;
Dianne Hackborn756220b2012-08-14 16:45:30 -070045import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080046import android.content.res.Resources;
47import android.content.res.TypedArray;
Vasu Nori74f170f2010-06-01 18:06:18 -070048import android.database.DatabaseErrorHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049import android.database.sqlite.SQLiteDatabase;
50import android.database.sqlite.SQLiteDatabase.CursorFactory;
51import android.graphics.Bitmap;
52import android.graphics.drawable.Drawable;
53import android.net.Uri;
Patrick Baumannef4c4072018-02-01 08:54:05 -080054import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080055import android.os.Bundle;
Jeff Sharkey6feb50b2013-10-15 12:38:15 -070056import android.os.Environment;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080057import android.os.Handler;
Jeff Sharkey8439ac02017-12-12 17:26:23 -070058import android.os.HandlerExecutor;
Dianne Hackbornff170242014-11-19 10:59:01 -080059import android.os.IBinder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060import android.os.Looper;
Jeff Sharkey6feb50b2013-10-15 12:38:15 -070061import android.os.StatFs;
Dianne Hackborn79af1dd2012-08-16 16:42:52 -070062import android.os.UserHandle;
Jeff Sharkey8c165792012-10-22 14:08:29 -070063import android.os.UserManager;
Jeff Sharkey60a82cd2017-04-18 18:19:16 -060064import android.os.storage.StorageManager;
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -070065import android.provider.MediaStore;
Chen Xu8eb62f92019-10-13 17:30:32 -070066import android.telephony.TelephonyRegistryManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067import android.util.AttributeSet;
Jeff Browna492c3a2012-08-23 19:48:44 -070068import android.view.Display;
Jeff Sharkeye13529a2015-12-09 14:15:27 -070069import android.view.DisplayAdjustments;
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -070070import android.view.View;
Jon Miranda836c0a82014-08-11 12:32:26 -070071import android.view.ViewDebug;
Jeff Browna492c3a2012-08-23 19:48:44 -070072import android.view.WindowManager;
Felipe Lemebb567ae2017-10-04 09:56:21 -070073import android.view.autofill.AutofillManager.AutofillClient;
Felipe Lemecbf7f262019-04-17 13:57:59 -070074import android.view.contentcapture.ContentCaptureManager.ContentCaptureClient;
Abodunrinwa Tokif001fef2017-01-04 23:51:42 +000075import android.view.textclassifier.TextClassificationManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076
atrosta6a4d602019-08-21 16:48:56 +010077import com.android.internal.compat.IPlatformCompat;
atrostff948d82019-10-10 19:27:31 +010078import com.android.internal.compat.IPlatformCompatNative;
atrosta6a4d602019-08-21 16:48:56 +010079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080080import java.io.File;
81import java.io.FileInputStream;
82import java.io.FileNotFoundException;
83import java.io.FileOutputStream;
84import java.io.IOException;
85import java.io.InputStream;
Tor Norbyed9273d62013-05-30 15:59:53 -070086import java.lang.annotation.Retention;
87import java.lang.annotation.RetentionPolicy;
Jeff Sharkey8439ac02017-12-12 17:26:23 -070088import java.util.concurrent.Executor;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089
90/**
91 * Interface to global information about an application environment. This is
92 * an abstract class whose implementation is provided by
93 * the Android system. It
94 * allows access to application-specific resources and classes, as well as
95 * up-calls for application-level operations such as launching activities,
96 * broadcasting and receiving intents, etc.
97 */
98public abstract class Context {
Jeff Sharkey30e06bb2017-04-24 11:18:03 -060099 /** @hide */
100 @IntDef(flag = true, prefix = { "MODE_" }, value = {
101 MODE_PRIVATE,
102 MODE_WORLD_READABLE,
103 MODE_WORLD_WRITEABLE,
104 MODE_APPEND,
105 })
106 @Retention(RetentionPolicy.SOURCE)
107 public @interface FileMode {}
108
109 /** @hide */
110 @IntDef(flag = true, prefix = { "MODE_" }, value = {
111 MODE_PRIVATE,
112 MODE_WORLD_READABLE,
113 MODE_WORLD_WRITEABLE,
114 MODE_MULTI_PROCESS,
115 })
116 @Retention(RetentionPolicy.SOURCE)
117 public @interface PreferencesMode {}
118
119 /** @hide */
120 @IntDef(flag = true, prefix = { "MODE_" }, value = {
121 MODE_PRIVATE,
122 MODE_WORLD_READABLE,
123 MODE_WORLD_WRITEABLE,
124 MODE_ENABLE_WRITE_AHEAD_LOGGING,
125 MODE_NO_LOCALIZED_COLLATORS,
126 })
127 @Retention(RetentionPolicy.SOURCE)
128 public @interface DatabaseMode {}
129
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800130 /**
131 * File creation mode: the default mode, where the created file can only
132 * be accessed by the calling application (or all applications sharing the
133 * same user ID).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800134 */
135 public static final int MODE_PRIVATE = 0x0000;
Jeff Sharkey634dc422016-01-30 17:44:15 -0700136
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800137 /**
Jeff Sharkey634dc422016-01-30 17:44:15 -0700138 * File creation mode: allow all other applications to have read access to
139 * the created file.
140 * <p>
Dave Friedmancfe50882017-07-05 00:40:07 -0700141 * Starting from {@link android.os.Build.VERSION_CODES#N}, attempting to use this
142 * mode throws a {@link SecurityException}.
Jeff Sharkey634dc422016-01-30 17:44:15 -0700143 *
Nick Kralevich15069212013-01-09 15:54:56 -0800144 * @deprecated Creating world-readable files is very dangerous, and likely
Jeff Sharkey634dc422016-01-30 17:44:15 -0700145 * to cause security holes in applications. It is strongly
146 * discouraged; instead, applications should use more formal
147 * mechanism for interactions such as {@link ContentProvider},
148 * {@link BroadcastReceiver}, and {@link android.app.Service}.
149 * There are no guarantees that this access mode will remain on
150 * a file, such as when it goes through a backup and restore.
151 * @see android.support.v4.content.FileProvider
152 * @see Intent#FLAG_GRANT_WRITE_URI_PERMISSION
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800153 */
Dianne Hackborn556b09e2012-09-23 17:46:53 -0700154 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155 public static final int MODE_WORLD_READABLE = 0x0001;
Jeff Sharkey634dc422016-01-30 17:44:15 -0700156
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800157 /**
Jeff Sharkey634dc422016-01-30 17:44:15 -0700158 * File creation mode: allow all other applications to have write access to
159 * the created file.
160 * <p>
Dave Friedmancfe50882017-07-05 00:40:07 -0700161 * Starting from {@link android.os.Build.VERSION_CODES#N}, attempting to use this
Jeff Sharkey634dc422016-01-30 17:44:15 -0700162 * mode will throw a {@link SecurityException}.
163 *
Nick Kralevich15069212013-01-09 15:54:56 -0800164 * @deprecated Creating world-writable files is very dangerous, and likely
Jeff Sharkey634dc422016-01-30 17:44:15 -0700165 * to cause security holes in applications. It is strongly
166 * discouraged; instead, applications should use more formal
167 * mechanism for interactions such as {@link ContentProvider},
168 * {@link BroadcastReceiver}, and {@link android.app.Service}.
169 * There are no guarantees that this access mode will remain on
170 * a file, such as when it goes through a backup and restore.
171 * @see android.support.v4.content.FileProvider
172 * @see Intent#FLAG_GRANT_WRITE_URI_PERMISSION
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800173 */
Dianne Hackborn556b09e2012-09-23 17:46:53 -0700174 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800175 public static final int MODE_WORLD_WRITEABLE = 0x0002;
Jeff Sharkey634dc422016-01-30 17:44:15 -0700176
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800177 /**
178 * File creation mode: for use with {@link #openFileOutput}, if the file
179 * already exists then write data to the end of the existing file
180 * instead of erasing it.
181 * @see #openFileOutput
182 */
183 public static final int MODE_APPEND = 0x8000;
184
185 /**
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800186 * SharedPreference loading flag: when set, the file on disk will
187 * be checked for modification even if the shared preferences
188 * instance is already loaded in this process. This behavior is
189 * sometimes desired in cases where the application has multiple
190 * processes, all writing to the same SharedPreferences file.
191 * Generally there are better forms of communication between
192 * processes, though.
193 *
194 * <p>This was the legacy (but undocumented) behavior in and
195 * before Gingerbread (Android 2.3) and this flag is implied when
kopriva219f7dc2018-10-09 13:42:28 -0700196 * targeting such releases. For applications targeting SDK
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800197 * versions <em>greater than</em> Android 2.3, this flag must be
198 * explicitly set if desired.
199 *
200 * @see #getSharedPreferences
Christopher Tated5748b82015-05-08 18:14:01 -0700201 *
202 * @deprecated MODE_MULTI_PROCESS does not work reliably in
203 * some versions of Android, and furthermore does not provide any
204 * mechanism for reconciling concurrent modifications across
205 * processes. Applications should not attempt to use it. Instead,
206 * they should use an explicit cross-process data management
207 * approach such as {@link android.content.ContentProvider ContentProvider}.
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800208 */
Christopher Tated5748b82015-05-08 18:14:01 -0700209 @Deprecated
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800210 public static final int MODE_MULTI_PROCESS = 0x0004;
211
212 /**
Jeff Brown47847f32012-03-22 19:13:11 -0700213 * Database open flag: when set, the database is opened with write-ahead
214 * logging enabled by default.
215 *
216 * @see #openOrCreateDatabase(String, int, CursorFactory)
217 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
218 * @see SQLiteDatabase#enableWriteAheadLogging
219 */
220 public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008;
221
Sunny Goyala21e6b22015-12-02 09:51:02 -0800222 /**
223 * Database open flag: when set, the database is opened without support for
224 * localized collators.
225 *
226 * @see #openOrCreateDatabase(String, int, CursorFactory)
227 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
228 * @see SQLiteDatabase#NO_LOCALIZED_COLLATORS
229 */
230 public static final int MODE_NO_LOCALIZED_COLLATORS = 0x0010;
231
Tor Norbyed9273d62013-05-30 15:59:53 -0700232 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700233 @IntDef(flag = true, prefix = { "BIND_" }, value = {
234 BIND_AUTO_CREATE,
235 BIND_DEBUG_UNBIND,
236 BIND_NOT_FOREGROUND,
237 BIND_ABOVE_CLIENT,
238 BIND_ALLOW_OOM_MANAGEMENT,
239 BIND_WAIVE_PRIORITY,
240 BIND_IMPORTANT,
Amith Yamasani5016a782019-06-17 16:20:24 -0700241 BIND_ADJUST_WITH_ACTIVITY,
242 BIND_NOT_PERCEPTIBLE,
243 BIND_INCLUDE_CAPABILITIES
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700244 })
Tor Norbyed9273d62013-05-30 15:59:53 -0700245 @Retention(RetentionPolicy.SOURCE)
246 public @interface BindServiceFlags {}
247
Jeff Brown47847f32012-03-22 19:13:11 -0700248 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800249 * Flag for {@link #bindService}: automatically create the service as long
250 * as the binding exists. Note that while this will create the service,
Scott Main4b5da682010-10-21 11:49:12 -0700251 * its {@link android.app.Service#onStartCommand}
252 * method will still only be called due to an
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800253 * explicit call to {@link #startService}. Even without that, though,
254 * this still provides you with access to the service object while the
255 * service is created.
256 *
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700257 * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH},
258 * not supplying this flag would also impact how important the system
259 * consider's the target service's process to be. When set, the only way
260 * for it to be raised was by binding from a service in which case it will
261 * only be important when that activity is in the foreground. Now to
262 * achieve this behavior you must explicitly supply the new flag
263 * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications
264 * that don't specify {@link #BIND_AUTO_CREATE} will automatically have
265 * the flags {@link #BIND_WAIVE_PRIORITY} and
266 * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve
267 * the same result.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800268 */
269 public static final int BIND_AUTO_CREATE = 0x0001;
270
271 /**
272 * Flag for {@link #bindService}: include debugging help for mismatched
273 * calls to unbind. When this flag is set, the callstack of the following
274 * {@link #unbindService} call is retained, to be printed if a later
275 * incorrect unbind call is made. Note that doing this requires retaining
276 * information about the binding that was made for the lifetime of the app,
277 * resulting in a leak -- this should only be used for debugging.
278 */
279 public static final int BIND_DEBUG_UNBIND = 0x0002;
280
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800281 /**
282 * Flag for {@link #bindService}: don't allow this binding to raise
283 * the target service's process to the foreground scheduling priority.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700284 * It will still be raised to at least the same memory priority
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800285 * as the client (so that its process will not be killable in any
286 * situation where the client is not killable), but for CPU scheduling
287 * purposes it may be left in the background. This only has an impact
288 * in the situation where the binding client is a foreground process
289 * and the target service is in a background process.
290 */
291 public static final int BIND_NOT_FOREGROUND = 0x0004;
292
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700293 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700294 * Flag for {@link #bindService}: indicates that the client application
295 * binding to this service considers the service to be more important than
296 * the app itself. When set, the platform will try to have the out of
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700297 * memory killer kill the app before it kills the service it is bound to, though
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700298 * this is not guaranteed to be the case.
299 */
300 public static final int BIND_ABOVE_CLIENT = 0x0008;
301
302 /**
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700303 * Flag for {@link #bindService}: allow the process hosting the bound
304 * service to go through its normal memory management. It will be
305 * treated more like a running service, allowing the system to
306 * (temporarily) expunge the process if low on memory or for some other
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700307 * whim it may have, and being more aggressive about making it a candidate
308 * to be killed (and restarted) if running for a long time.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700309 */
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700310 public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010;
311
312 /**
313 * Flag for {@link #bindService}: don't impact the scheduling or
314 * memory management priority of the target service's hosting process.
315 * Allows the service's process to be managed on the background LRU list
316 * just like a regular application process in the background.
317 */
318 public static final int BIND_WAIVE_PRIORITY = 0x0020;
319
320 /**
321 * Flag for {@link #bindService}: this service is very important to
322 * the client, so should be brought to the foreground process level
323 * when the client is. Normally a process can only be raised to the
324 * visibility level by a client, even if that client is in the foreground.
325 */
326 public static final int BIND_IMPORTANT = 0x0040;
327
328 /**
329 * Flag for {@link #bindService}: If binding from an activity, allow the
330 * target service's process importance to be raised based on whether the
331 * activity is visible to the user, regardless whether another flag is
332 * used to reduce the amount that the client process's overall importance
333 * is used to impact it.
334 */
Dianne Hackborn2c84cfc2011-10-31 15:39:59 -0700335 public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080;
336
337 /**
Amith Yamasani5016a782019-06-17 16:20:24 -0700338 * Flag for {@link #bindService}: If binding from an app that is visible or user-perceptible,
339 * lower the target service's importance to below the perceptible level. This allows
340 * the system to (temporarily) expunge the bound process from memory to make room for more
341 * important user-perceptible processes.
342 */
343 public static final int BIND_NOT_PERCEPTIBLE = 0x00000100;
344
345 /**
Amith Yamasanif178c962019-03-21 19:40:11 -0700346 * Flag for {@link #bindService}: If binding from an app that has specific capabilities
347 * due to its foreground state such as an activity or foreground service, then this flag will
348 * allow the bound app to get the same capabilities, as long as it has the required permissions
349 * as well.
350 */
Amith Yamasani5016a782019-06-17 16:20:24 -0700351 public static final int BIND_INCLUDE_CAPABILITIES = 0x000001000;
Amith Yamasanif178c962019-03-21 19:40:11 -0700352
Amith Yamasani0b3ae0e2019-05-10 10:29:47 -0700353 /*********** Public flags above this line ***********/
354 /*********** Hidden flags below this line ***********/
355
356 /**
Yohei Yukawa59730962019-03-18 10:47:22 -0700357 * Flag for {@link #bindService}: This flag is intended to be used only by the system to adjust
358 * the scheduling policy for IMEs (and any other out-of-process user-visible components that
359 * work closely with the top app) so that UI hosted in such services can have the same
360 * scheduling policy (e.g. SCHED_FIFO when it is enabled and TOP_APP_PRIORITY_BOOST otherwise)
361 * as the actual top-app.
362 * @hide
363 */
364 public static final int BIND_SCHEDULE_LIKE_TOP_APP = 0x00080000;
365
366 /**
Michal Karpinskie069b002019-03-07 16:15:14 +0000367 * Flag for {@link #bindService}: allow background activity starts from the bound service's
368 * process.
369 * This flag is only respected if the caller is holding
370 * {@link android.Manifest.permission#START_ACTIVITIES_FROM_BACKGROUND}.
371 * @hide
372 */
373 public static final int BIND_ALLOW_BACKGROUND_ACTIVITY_STARTS = 0x00100000;
374
375 /**
Dianne Hackbornc390aa82019-01-09 16:38:22 -0800376 * @hide Flag for {@link #bindService}: the service being bound to represents a
377 * protected system component, so must have association restrictions applied to it.
378 * That is, a system config must have one or more allow-association tags limiting
379 * which packages it can interact with. If it does not have any such association
380 * restrictions, a default empty set will be created.
381 */
382 public static final int BIND_RESTRICT_ASSOCIATIONS = 0x00200000;
383
384 /**
Svet Ganovd223db32017-12-22 09:43:48 -0800385 * @hide Flag for {@link #bindService}: allows binding to a service provided
386 * by an instant app. Note that the caller may not have access to the instant
387 * app providing the service which is a violation of the instant app sandbox.
388 * This flag is intended ONLY for development/testing and should be used with
389 * great care. Only the system is allowed to use this flag.
390 */
391 public static final int BIND_ALLOW_INSTANT = 0x00400000;
392
393 /**
Dianne Hackborn83b40f62017-04-26 13:59:47 -0700394 * @hide Flag for {@link #bindService}: like {@link #BIND_NOT_FOREGROUND}, but puts it
395 * up in to the important background state (instead of transient).
396 */
397 public static final int BIND_IMPORTANT_BACKGROUND = 0x00800000;
398
399 /**
Felipe Lemea1b79bf2016-05-24 13:06:54 -0700400 * @hide Flag for {@link #bindService}: allows application hosting service to manage whitelists
401 * such as temporary allowing a {@code PendingIntent} to bypass Power Save mode.
402 */
403 public static final int BIND_ALLOW_WHITELIST_MANAGEMENT = 0x01000000;
404
405 /**
Dianne Hackbornd69e4c12015-04-24 09:54:54 -0700406 * @hide Flag for {@link #bindService}: Like {@link #BIND_FOREGROUND_SERVICE},
407 * but only applies while the device is awake.
408 */
409 public static final int BIND_FOREGROUND_SERVICE_WHILE_AWAKE = 0x02000000;
410
411 /**
412 * @hide Flag for {@link #bindService}: For only the case where the binding
413 * is coming from the system, set the process state to FOREGROUND_SERVICE
414 * instead of the normal maximum of IMPORTANT_FOREGROUND. That is, this is
415 * saying that the process shouldn't participate in the normal power reduction
416 * modes (removing network access etc).
417 */
418 public static final int BIND_FOREGROUND_SERVICE = 0x04000000;
419
420 /**
Dianne Hackbornf0f94d12014-03-17 16:04:21 -0700421 * @hide Flag for {@link #bindService}: Treat the binding as hosting
422 * an activity, an unbinding as the activity going in the background.
423 * That is, when unbinding, the process when empty will go on the activity
424 * LRU list instead of the regular one, keeping it around more aggressively
425 * than it otherwise would be. This is intended for use with IMEs to try
426 * to keep IME processes around for faster keyboard switching.
427 */
428 public static final int BIND_TREAT_LIKE_ACTIVITY = 0x08000000;
429
430 /**
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700431 * @hide An idea that is not yet implemented.
432 * Flag for {@link #bindService}: If binding from an activity, consider
433 * this service to be visible like the binding activity is. That is,
434 * it will be treated as something more important to keep around than
435 * invisible background activities. This will impact the number of
436 * recent activities the user can switch between without having them
437 * restart. There is no guarantee this will be respected, as the system
Amith Yamasanif235d0b2019-03-20 22:49:43 -0700438 * tries to balance such requests from one app vs. the importance of
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700439 * keeping other apps around.
440 */
Dianne Hackbornc8230512013-07-13 21:32:12 -0700441 public static final int BIND_VISIBLE = 0x10000000;
442
443 /**
444 * @hide
445 * Flag for {@link #bindService}: Consider this binding to be causing the target
446 * process to be showing UI, so it will be do a UI_HIDDEN memory trim when it goes
447 * away.
448 */
449 public static final int BIND_SHOWING_UI = 0x20000000;
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700450
451 /**
Dianne Hackborn2c84cfc2011-10-31 15:39:59 -0700452 * Flag for {@link #bindService}: Don't consider the bound service to be
453 * visible, even if the caller is visible.
454 * @hide
455 */
456 public static final int BIND_NOT_VISIBLE = 0x40000000;
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700457
Alan Viverette713a5cd2015-12-16 15:46:32 -0500458 /**
Robert Sesekb9a86662015-12-09 16:22:45 -0500459 * Flag for {@link #bindService}: The service being bound is an
460 * {@link android.R.attr#isolatedProcess isolated},
461 * {@link android.R.attr#externalService external} service. This binds the service into the
462 * calling application's package, rather than the package in which the service is declared.
Robert Sesek55b2d112016-05-17 18:53:13 -0400463 * <p>
464 * When using this flag, the code for the service being bound will execute under the calling
465 * application's package name and user ID. Because the service must be an isolated process,
466 * it will not have direct access to the application's data, though.
467 *
468 * The purpose of this flag is to allow applications to provide services that are attributed
469 * to the app using the service, rather than the application providing the service.
470 * </p>
Robert Sesekb9a86662015-12-09 16:22:45 -0500471 */
472 public static final int BIND_EXTERNAL_SERVICE = 0x80000000;
473
Dianne Hackborna631d562018-11-20 15:58:15 -0800474 /**
475 * These bind flags reduce the strength of the binding such that we shouldn't
476 * consider it as pulling the process up to the level of the one that is bound to it.
477 * @hide
478 */
479 public static final int BIND_REDUCTION_FLAGS =
480 Context.BIND_ALLOW_OOM_MANAGEMENT | Context.BIND_WAIVE_PRIORITY
Amith Yamasani5016a782019-06-17 16:20:24 -0700481 | Context.BIND_NOT_PERCEPTIBLE | Context.BIND_NOT_VISIBLE;
Dianne Hackborna631d562018-11-20 15:58:15 -0800482
Chad Brubaker6d6015f2017-04-18 11:25:16 -0700483 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700484 @IntDef(flag = true, prefix = { "RECEIVER_VISIBLE_" }, value = {
485 RECEIVER_VISIBLE_TO_INSTANT_APPS
486 })
Chad Brubaker6d6015f2017-04-18 11:25:16 -0700487 @Retention(RetentionPolicy.SOURCE)
488 public @interface RegisterReceiverFlags {}
489
490 /**
491 * Flag for {@link #registerReceiver}: The receiver can receive broadcasts from Instant Apps.
492 */
493 public static final int RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x1;
494
Robert Sesekb9a86662015-12-09 16:22:45 -0500495 /**
Alan Viverette713a5cd2015-12-16 15:46:32 -0500496 * Returns an AssetManager instance for the application's package.
497 * <p>
498 * <strong>Note:</strong> Implementations of this method should return
499 * an AssetManager instance that is consistent with the Resources instance
500 * returned by {@link #getResources()}. For example, they should share the
501 * same {@link Configuration} object.
502 *
503 * @return an AssetManager instance for the application's package
504 * @see #getResources()
505 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800506 public abstract AssetManager getAssets();
507
Alan Viverette713a5cd2015-12-16 15:46:32 -0500508 /**
509 * Returns a Resources instance for the application's package.
510 * <p>
511 * <strong>Note:</strong> Implementations of this method should return
512 * a Resources instance that is consistent with the AssetManager instance
513 * returned by {@link #getAssets()}. For example, they should share the
514 * same {@link Configuration} object.
515 *
516 * @return a Resources instance for the application's package
517 * @see #getAssets()
518 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800519 public abstract Resources getResources();
520
521 /** Return PackageManager instance to find global package information. */
522 public abstract PackageManager getPackageManager();
523
524 /** Return a ContentResolver instance for your application's package. */
525 public abstract ContentResolver getContentResolver();
526
527 /**
528 * Return the Looper for the main thread of the current process. This is
529 * the thread used to dispatch calls to application components (activities,
530 * services, etc).
Jeff Brownf9e989d2013-04-04 23:04:03 -0700531 * <p>
532 * By definition, this method returns the same result as would be obtained
533 * by calling {@link Looper#getMainLooper() Looper.getMainLooper()}.
534 * </p>
535 *
536 * @return The main looper.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 */
538 public abstract Looper getMainLooper();
Scott Main4b5da682010-10-21 11:49:12 -0700539
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 /**
Jeff Sharkey8439ac02017-12-12 17:26:23 -0700541 * Return an {@link Executor} that will run enqueued tasks on the main
542 * thread associated with this context. This is the thread used to dispatch
543 * calls to application components (activities, services, etc).
544 */
545 public Executor getMainExecutor() {
546 // This is pretty inefficient, which is why ContextImpl overrides it
547 return new HandlerExecutor(new Handler(getMainLooper()));
548 }
549
550 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800551 * Return the context of the single, global Application object of the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800552 * current process. This generally should only be used if you need a
553 * Context whose lifecycle is separate from the current context, that is
554 * tied to the lifetime of the process rather than the current component.
Scott Main4b5da682010-10-21 11:49:12 -0700555 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800556 * <p>Consider for example how this interacts with
Brad Fitzpatrick36af7942010-12-08 11:31:07 -0800557 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}:
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800558 * <ul>
559 * <li> <p>If used from an Activity context, the receiver is being registered
560 * within that activity. This means that you are expected to unregister
561 * before the activity is done being destroyed; in fact if you do not do
562 * so, the framework will clean up your leaked registration as it removes
563 * the activity and log an error. Thus, if you use the Activity context
564 * to register a receiver that is static (global to the process, not
565 * associated with an Activity instance) then that registration will be
566 * removed on you at whatever point the activity you used is destroyed.
567 * <li> <p>If used from the Context returned here, the receiver is being
568 * registered with the global state associated with your application. Thus
569 * it will never be unregistered for you. This is necessary if the receiver
570 * is associated with static data, not a particular component. However
571 * using the ApplicationContext elsewhere can easily lead to serious leaks
572 * if you forget to unregister, unbind, etc.
573 * </ul>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800574 */
575 public abstract Context getApplicationContext();
576
Phil Weaver846cda932017-06-15 10:10:06 -0700577 /** Non-activity related autofill ids are unique in the app */
578 private static int sLastAutofillId = View.NO_ID;
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700579
580 /**
Phil Weaver846cda932017-06-15 10:10:06 -0700581 * Gets the next autofill ID.
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700582 *
Phil Weaver846cda932017-06-15 10:10:06 -0700583 * <p>All IDs will be smaller or the same as {@link View#LAST_APP_AUTOFILL_ID}. All IDs
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700584 * returned will be unique.
585 *
586 * @return A ID that is unique in the process
587 *
588 * {@hide}
589 */
Phil Weaver846cda932017-06-15 10:10:06 -0700590 public int getNextAutofillId() {
591 if (sLastAutofillId == View.LAST_APP_AUTOFILL_ID - 1) {
592 sLastAutofillId = View.NO_ID;
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700593 }
594
Phil Weaver846cda932017-06-15 10:10:06 -0700595 sLastAutofillId++;
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700596
Phil Weaver846cda932017-06-15 10:10:06 -0700597 return sLastAutofillId;
Philip P. Moltmanneab62ba2017-03-20 10:55:43 -0700598 }
599
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800600 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700601 * Add a new {@link ComponentCallbacks} to the base application of the
602 * Context, which will be called at the same times as the ComponentCallbacks
603 * methods of activities and other components are called. Note that you
604 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when
605 * appropriate in the future; this will not be removed for you.
Dianne Hackborn905577f2011-09-07 18:31:28 -0700606 *
607 * @param callback The interface to call. This can be either a
608 * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface.
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700609 */
610 public void registerComponentCallbacks(ComponentCallbacks callback) {
611 getApplicationContext().registerComponentCallbacks(callback);
612 }
613
614 /**
John Spurlock6098c5d2013-06-17 10:32:46 -0400615 * Remove a {@link ComponentCallbacks} object that was previously registered
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700616 * with {@link #registerComponentCallbacks(ComponentCallbacks)}.
617 */
618 public void unregisterComponentCallbacks(ComponentCallbacks callback) {
619 getApplicationContext().unregisterComponentCallbacks(callback);
620 }
621
622 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800623 * Return a localized, styled CharSequence from the application's package's
624 * default string table.
625 *
626 * @param resId Resource id for the CharSequence text
627 */
Chris Craikceb26932018-02-01 15:51:34 -0800628 @NonNull
Tor Norbye7b9c9122013-05-30 16:48:33 -0700629 public final CharSequence getText(@StringRes int resId) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800630 return getResources().getText(resId);
631 }
632
633 /**
Alan Viveretteb4004df2015-04-29 16:55:42 -0700634 * Returns a localized string from the application's package's
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800635 * default string table.
636 *
637 * @param resId Resource id for the string
Alan Viveretteb4004df2015-04-29 16:55:42 -0700638 * @return The string data associated with the resource, stripped of styled
639 * text information.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800640 */
Alan Viveretteb4004df2015-04-29 16:55:42 -0700641 @NonNull
Tor Norbye7b9c9122013-05-30 16:48:33 -0700642 public final String getString(@StringRes int resId) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800643 return getResources().getString(resId);
644 }
645
646 /**
Alan Viveretteb4004df2015-04-29 16:55:42 -0700647 * Returns a localized formatted string from the application's package's
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800648 * default string table, substituting the format arguments as defined in
649 * {@link java.util.Formatter} and {@link java.lang.String#format}.
650 *
651 * @param resId Resource id for the format string
Alan Viveretteb4004df2015-04-29 16:55:42 -0700652 * @param formatArgs The format arguments that will be used for
653 * substitution.
654 * @return The string data associated with the resource, formatted and
655 * stripped of styled text information.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800656 */
Alan Viveretteb4004df2015-04-29 16:55:42 -0700657 @NonNull
Tor Norbye7b9c9122013-05-30 16:48:33 -0700658 public final String getString(@StringRes int resId, Object... formatArgs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800659 return getResources().getString(resId, formatArgs);
660 }
661
Alan Viverette8eea3ea2014-02-03 18:40:20 -0800662 /**
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800663 * Returns a color associated with a particular resource ID and styled for
664 * the current theme.
665 *
666 * @param id The desired resource identifier, as generated by the aapt
667 * tool. This integer encodes the package, type, and resource
668 * entry. The value 0 is an invalid identifier.
669 * @return A single color value in the form 0xAARRGGBB.
670 * @throws android.content.res.Resources.NotFoundException if the given ID
671 * does not exist.
672 */
Tor Norbye3e4cda72015-06-10 08:14:31 -0700673 @ColorInt
674 public final int getColor(@ColorRes int id) {
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800675 return getResources().getColor(id, getTheme());
676 }
677
678 /**
679 * Returns a drawable object associated with a particular resource ID and
Alan Viverette8eea3ea2014-02-03 18:40:20 -0800680 * styled for the current theme.
681 *
682 * @param id The desired resource identifier, as generated by the aapt
683 * tool. This integer encodes the package, type, and resource
684 * entry. The value 0 is an invalid identifier.
Chris Craikceb26932018-02-01 15:51:34 -0800685 * @return An object that can be used to draw this resource.
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800686 * @throws android.content.res.Resources.NotFoundException if the given ID
687 * does not exist.
Alan Viverette8eea3ea2014-02-03 18:40:20 -0800688 */
Chris Craik1194b0b2018-03-23 13:36:24 -0700689 @Nullable
Tor Norbye3e4cda72015-06-10 08:14:31 -0700690 public final Drawable getDrawable(@DrawableRes int id) {
Alan Viverette8eea3ea2014-02-03 18:40:20 -0800691 return getResources().getDrawable(id, getTheme());
692 }
693
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800694 /**
695 * Returns a color state list associated with a particular resource ID and
696 * styled for the current theme.
697 *
698 * @param id The desired resource identifier, as generated by the aapt
699 * tool. This integer encodes the package, type, and resource
700 * entry. The value 0 is an invalid identifier.
Chris Craikceb26932018-02-01 15:51:34 -0800701 * @return A color state list.
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800702 * @throws android.content.res.Resources.NotFoundException if the given ID
703 * does not exist.
704 */
Chris Craikceb26932018-02-01 15:51:34 -0800705 @NonNull
Tor Norbye3e4cda72015-06-10 08:14:31 -0700706 public final ColorStateList getColorStateList(@ColorRes int id) {
Alan Viverette45c4bbb2015-01-05 14:59:19 -0800707 return getResources().getColorStateList(id, getTheme());
708 }
709
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800710 /**
711 * Set the base theme for this context. Note that this should be called
712 * before any views are instantiated in the Context (for example before
713 * calling {@link android.app.Activity#setContentView} or
714 * {@link android.view.LayoutInflater#inflate}).
715 *
716 * @param resid The style resource describing the theme.
717 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700718 public abstract void setTheme(@StyleRes int resid);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800719
Dianne Hackborn247fe742011-01-08 17:25:57 -0800720 /** @hide Needed for some internal implementation... not public because
721 * you can't assume this actually means anything. */
Mathew Inwood5c0d3542018-08-14 13:54:31 +0100722 @UnsupportedAppUsage
Dianne Hackborn247fe742011-01-08 17:25:57 -0800723 public int getThemeResId() {
724 return 0;
725 }
726
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800727 /**
728 * Return the Theme object associated with this Context.
729 */
Jon Miranda836c0a82014-08-11 12:32:26 -0700730 @ViewDebug.ExportedProperty(deepExport = true)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800731 public abstract Resources.Theme getTheme();
732
733 /**
734 * Retrieve styled attribute information in this Context's theme. See
Jeff Brown6e539312015-02-24 18:53:21 -0800735 * {@link android.content.res.Resources.Theme#obtainStyledAttributes(int[])}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800736 * for more information.
737 *
Jeff Brown6e539312015-02-24 18:53:21 -0800738 * @see android.content.res.Resources.Theme#obtainStyledAttributes(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800739 */
Aurimas Liutikas77acf4b2018-12-19 17:31:03 -0800740 @NonNull
741 public final TypedArray obtainStyledAttributes(@NonNull @StyleableRes int[] attrs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800742 return getTheme().obtainStyledAttributes(attrs);
743 }
744
745 /**
746 * Retrieve styled attribute information in this Context's theme. See
Jeff Brown6e539312015-02-24 18:53:21 -0800747 * {@link android.content.res.Resources.Theme#obtainStyledAttributes(int, int[])}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800748 * for more information.
749 *
Jeff Brown6e539312015-02-24 18:53:21 -0800750 * @see android.content.res.Resources.Theme#obtainStyledAttributes(int, int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800751 */
Aurimas Liutikas77acf4b2018-12-19 17:31:03 -0800752 @NonNull
753 public final TypedArray obtainStyledAttributes(@StyleRes int resid,
754 @NonNull @StyleableRes int[] attrs) throws Resources.NotFoundException {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800755 return getTheme().obtainStyledAttributes(resid, attrs);
756 }
757
758 /**
759 * Retrieve styled attribute information in this Context's theme. See
Jeff Brown6e539312015-02-24 18:53:21 -0800760 * {@link android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800761 * for more information.
762 *
Jeff Brown6e539312015-02-24 18:53:21 -0800763 * @see android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800764 */
Aurimas Liutikas77acf4b2018-12-19 17:31:03 -0800765 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800766 public final TypedArray obtainStyledAttributes(
Aurimas Liutikas77acf4b2018-12-19 17:31:03 -0800767 @Nullable AttributeSet set, @NonNull @StyleableRes int[] attrs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800768 return getTheme().obtainStyledAttributes(set, attrs, 0, 0);
769 }
770
771 /**
772 * Retrieve styled attribute information in this Context's theme. See
Jeff Brown6e539312015-02-24 18:53:21 -0800773 * {@link android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800774 * for more information.
775 *
Jeff Brown6e539312015-02-24 18:53:21 -0800776 * @see android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800777 */
Aurimas Liutikas77acf4b2018-12-19 17:31:03 -0800778 @NonNull
779 public final TypedArray obtainStyledAttributes(@Nullable AttributeSet set,
780 @NonNull @StyleableRes int[] attrs, @AttrRes int defStyleAttr,
Tor Norbyec91531a2015-04-01 17:41:55 -0700781 @StyleRes int defStyleRes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800782 return getTheme().obtainStyledAttributes(
783 set, attrs, defStyleAttr, defStyleRes);
784 }
785
786 /**
787 * Return a class loader you can use to retrieve classes in this package.
788 */
789 public abstract ClassLoader getClassLoader();
790
791 /** Return the name of this application's package. */
792 public abstract String getPackageName();
793
Jaewan Kim0980c7f2018-11-28 23:55:15 +0900794 /**
795 * @hide Return the name of the base context this context is derived from.
796 * This is the same as {@link #getOpPackageName()} except in
797 * cases where system components are loaded into other app processes, in which
798 * case {@link #getOpPackageName()} will be the name of the primary package in
799 * that process (so that app ops uid verification will work with the name).
800 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +0100801 @UnsupportedAppUsage
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -0800802 public abstract String getBasePackageName();
803
Jaewan Kim0980c7f2018-11-28 23:55:15 +0900804 /**
805 * Return the package name that should be used for {@link android.app.AppOpsManager} calls from
806 * this context, so that app ops manager's uid verification will work with the name.
807 * <p>
808 * This is not generally intended for third party application developers.
809 */
Adrian Roosebc927c2019-02-28 16:21:18 +0100810 @NonNull
Adrian Roosfe6aeaf2019-01-22 16:58:56 +0100811 public String getOpPackageName() {
812 throw new RuntimeException("Not implemented. Must override in a subclass.");
813 }
Dianne Hackborn95d78532013-09-11 09:51:14 -0700814
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -0700815 /** Return the full application info for this context's package. */
816 public abstract ApplicationInfo getApplicationInfo();
Scott Main4b5da682010-10-21 11:49:12 -0700817
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800818 /**
Kenny Root32148392010-01-21 15:40:47 -0800819 * Return the full path to this context's primary Android package.
820 * The Android package is a ZIP file which contains the application's
821 * primary resources.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800822 *
823 * <p>Note: this is not generally useful for applications, since they should
824 * not be directly accessing the file system.
825 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800826 * @return String Path to the resources.
827 */
828 public abstract String getPackageResourcePath();
829
830 /**
Kenny Root32148392010-01-21 15:40:47 -0800831 * Return the full path to this context's primary Android package.
832 * The Android package is a ZIP file which contains application's
833 * primary code and assets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800834 *
835 * <p>Note: this is not generally useful for applications, since they should
836 * not be directly accessing the file system.
837 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800838 * @return String Path to the code and assets.
839 */
840 public abstract String getPackageCodePath();
841
842 /**
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700843 * @hide
844 * @deprecated use {@link #getSharedPreferencesPath(String)}
Joe Onorato23ecae32009-06-10 17:07:15 -0700845 */
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700846 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +0100847 @UnsupportedAppUsage
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700848 public File getSharedPrefsFile(String name) {
849 return getSharedPreferencesPath(name);
850 }
Joe Onorato23ecae32009-06-10 17:07:15 -0700851
852 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800853 * Retrieve and hold the contents of the preferences file 'name', returning
854 * a SharedPreferences through which you can retrieve and modify its
855 * values. Only one instance of the SharedPreferences object is returned
856 * to any callers for the same name, meaning they will see each other's
857 * edits as soon as they are made.
858 *
Jonathan Dormody1bca5db2017-11-16 11:25:20 -0700859 * This method is thead-safe.
860 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800861 * @param name Desired preferences file. If a preferences file by this name
862 * does not exist, it will be created when you retrieve an
863 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600864 * @param mode Operating mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800865 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400866 * @return The single {@link SharedPreferences} instance that can be used
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800867 * to retrieve and modify the preference values.
868 *
869 * @see #MODE_PRIVATE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800870 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600871 public abstract SharedPreferences getSharedPreferences(String name, @PreferencesMode int mode);
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700872
873 /**
874 * Retrieve and hold the contents of the preferences file, returning
875 * a SharedPreferences through which you can retrieve and modify its
876 * values. Only one instance of the SharedPreferences object is returned
877 * to any callers for the same name, meaning they will see each other's
878 * edits as soon as they are made.
879 *
880 * @param file Desired preferences file. If a preferences file by this name
881 * does not exist, it will be created when you retrieve an
882 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600883 * @param mode Operating mode.
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700884 *
885 * @return The single {@link SharedPreferences} instance that can be used
886 * to retrieve and modify the preference values.
887 *
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700888 * @see #getSharedPreferencesPath(String)
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700889 * @see #MODE_PRIVATE
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -0600890 * @removed
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700891 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600892 public abstract SharedPreferences getSharedPreferences(File file, @PreferencesMode int mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800893
894 /**
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600895 * Move an existing shared preferences file from the given source storage
Jeff Sharkey35871f22016-01-29 17:13:29 -0700896 * context to this context. This is typically used to migrate data between
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600897 * storage locations after an upgrade, such as moving to device protected
898 * storage.
Jeff Sharkey35871f22016-01-29 17:13:29 -0700899 *
900 * @param sourceContext The source context which contains the existing
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600901 * shared preferences to move.
Jeff Sharkey35871f22016-01-29 17:13:29 -0700902 * @param name The name of the shared preferences file.
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600903 * @return {@code true} if the move was successful or if the shared
Jeff Sharkey35871f22016-01-29 17:13:29 -0700904 * preferences didn't exist in the source context, otherwise
905 * {@code false}.
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600906 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey35871f22016-01-29 17:13:29 -0700907 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600908 public abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name);
909
Jeff Sharkey35871f22016-01-29 17:13:29 -0700910 /**
911 * Delete an existing shared preferences file.
912 *
913 * @param name The name (unique in the application package) of the shared
914 * preferences file.
915 * @return {@code true} if the shared preferences file was successfully
916 * deleted; else {@code false}.
917 * @see #getSharedPreferences(String, int)
918 */
919 public abstract boolean deleteSharedPreferences(String name);
920
Christopher Tatefe2368c2017-05-17 15:42:35 -0700921 /** @hide */
922 public abstract void reloadSharedPreferences();
923
Jeff Sharkey35871f22016-01-29 17:13:29 -0700924 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800925 * Open a private file associated with this Context's application package
926 * for reading.
927 *
928 * @param name The name of the file to open; can not contain path
929 * separators.
930 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400931 * @return The resulting {@link FileInputStream}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800932 *
933 * @see #openFileOutput
934 * @see #fileList
935 * @see #deleteFile
936 * @see java.io.FileInputStream#FileInputStream(String)
937 */
938 public abstract FileInputStream openFileInput(String name)
939 throws FileNotFoundException;
940
941 /**
Nick Kralevich15069212013-01-09 15:54:56 -0800942 * Open a private file associated with this Context's application package
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700943 * for writing. Creates the file if it doesn't already exist.
944 * <p>
945 * No additional permissions are required for the calling app to read or
946 * write the returned file.
Ricardo Cervera90a5f982014-04-04 10:26:05 -0700947 *
Nick Kralevich15069212013-01-09 15:54:56 -0800948 * @param name The name of the file to open; can not contain path
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700949 * separators.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600950 * @param mode Operating mode.
John Spurlock6098c5d2013-06-17 10:32:46 -0400951 * @return The resulting {@link FileOutputStream}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800952 * @see #MODE_APPEND
953 * @see #MODE_PRIVATE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800954 * @see #openFileInput
955 * @see #fileList
956 * @see #deleteFile
957 * @see java.io.FileOutputStream#FileOutputStream(String)
958 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600959 public abstract FileOutputStream openFileOutput(String name, @FileMode int mode)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800960 throws FileNotFoundException;
961
962 /**
963 * Delete the given private file associated with this Context's
964 * application package.
965 *
966 * @param name The name of the file to delete; can not contain path
967 * separators.
968 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400969 * @return {@code true} if the file was successfully deleted; else
970 * {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800971 *
972 * @see #openFileInput
973 * @see #openFileOutput
974 * @see #fileList
975 * @see java.io.File#delete()
976 */
977 public abstract boolean deleteFile(String name);
978
979 /**
980 * Returns the absolute path on the filesystem where a file created with
981 * {@link #openFileOutput} is stored.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700982 * <p>
983 * The returned path may change over time if the calling app is moved to an
984 * adopted storage device, so only relative paths should be persisted.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800985 *
986 * @param name The name of the file for which you would like to get
987 * its path.
988 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400989 * @return An absolute path to the given file.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800990 *
991 * @see #openFileOutput
992 * @see #getFilesDir
993 * @see #getDir
994 */
995 public abstract File getFileStreamPath(String name);
996
997 /**
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700998 * Returns the absolute path on the filesystem where a file created with
999 * {@link #getSharedPreferences(String, int)} is stored.
1000 * <p>
1001 * The returned path may change over time if the calling app is moved to an
1002 * adopted storage device, so only relative paths should be persisted.
1003 *
1004 * @param name The name of the shared preferences for which you would like
1005 * to get a path.
1006 * @return An absolute path to the given file.
1007 * @see #getSharedPreferences(String, int)
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001008 * @removed
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -07001009 */
1010 public abstract File getSharedPreferencesPath(String name);
1011
1012 /**
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001013 * Returns the absolute path to the directory on the filesystem where all
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001014 * private files belonging to this app are stored. Apps should not use this
1015 * path directly; they should instead use {@link #getFilesDir()},
1016 * {@link #getCacheDir()}, {@link #getDir(String, int)}, or other storage
1017 * APIs on this class.
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001018 * <p>
1019 * The returned path may change over time if the calling app is moved to an
1020 * adopted storage device, so only relative paths should be persisted.
1021 * <p>
1022 * No additional permissions are required for the calling app to read or
1023 * write files under the returned path.
1024 *
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001025 * @see ApplicationInfo#dataDir
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001026 */
1027 public abstract File getDataDir();
1028
1029 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001030 * Returns the absolute path to the directory on the filesystem where files
1031 * created with {@link #openFileOutput} are stored.
1032 * <p>
1033 * The returned path may change over time if the calling app is moved to an
1034 * adopted storage device, so only relative paths should be persisted.
1035 * <p>
1036 * No additional permissions are required for the calling app to read or
1037 * write files under the returned path.
Ricardo Cervera90a5f982014-04-04 10:26:05 -07001038 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001039 * @return The path of the directory holding application files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001040 * @see #openFileOutput
1041 * @see #getFileStreamPath
1042 * @see #getDir
1043 */
1044 public abstract File getFilesDir();
Scott Main4b5da682010-10-21 11:49:12 -07001045
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001046 /**
Christopher Tatea7835b62014-07-11 17:25:57 -07001047 * Returns the absolute path to the directory on the filesystem similar to
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001048 * {@link #getFilesDir()}. The difference is that files placed under this
1049 * directory will be excluded from automatic backup to remote storage. See
Christopher Tatea7835b62014-07-11 17:25:57 -07001050 * {@link android.app.backup.BackupAgent BackupAgent} for a full discussion
1051 * of the automatic backup mechanism in Android.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001052 * <p>
1053 * The returned path may change over time if the calling app is moved to an
1054 * adopted storage device, so only relative paths should be persisted.
1055 * <p>
1056 * No additional permissions are required for the calling app to read or
1057 * write files under the returned path.
Christopher Tatea7835b62014-07-11 17:25:57 -07001058 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001059 * @return The path of the directory holding application files that will not
1060 * be automatically backed up to remote storage.
Christopher Tatea7835b62014-07-11 17:25:57 -07001061 * @see #openFileOutput
1062 * @see #getFileStreamPath
1063 * @see #getDir
1064 * @see android.app.backup.BackupAgent
1065 */
1066 public abstract File getNoBackupFilesDir();
1067
1068 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001069 * Returns the absolute path to the directory on the primary shared/external
1070 * storage device where the application can place persistent files it owns.
1071 * These files are internal to the applications, and not typically visible
1072 * to the user as media.
1073 * <p>
1074 * This is like {@link #getFilesDir()} in that these files will be deleted
1075 * when the application is uninstalled, however there are some important
1076 * differences:
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001077 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001078 * <li>Shared storage may not always be available, since removable media can
1079 * be ejected by the user. Media state can be checked using
1080 * {@link Environment#getExternalStorageState(File)}.
1081 * <li>There is no security enforced with these files. For example, any
1082 * application holding
1083 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001084 * these files.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001085 * </ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001086 * <p>
1087 * If a shared storage device is emulated (as determined by
1088 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1089 * backed by a private user data partition, which means there is little
1090 * benefit to storing data here instead of the private directories returned
1091 * by {@link #getFilesDir()}, etc.
1092 * <p>
1093 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001094 * are required to read or write to the returned path; it's always
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001095 * accessible to the calling app. This only applies to paths generated for
1096 * package name of the calling application. To access paths belonging to
1097 * other packages,
1098 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or
1099 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required.
1100 * <p>
1101 * On devices with multiple users (as described by {@link UserManager}),
1102 * each user has their own isolated shared storage. Applications only have
1103 * access to the shared storage for the user they're running as.
1104 * <p>
1105 * The returned path may change over time if different shared storage media
1106 * is inserted, so only relative paths should be persisted.
1107 * <p>
1108 * Here is an example of typical code to manipulate a file in an
1109 * application's shared storage:
1110 * </p>
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001111 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
1112 * private_file}
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001113 * <p>
1114 * If you supply a non-null <var>type</var> to this function, the returned
1115 * file will be a path to a sub-directory of the given type. Though these
1116 * files are not automatically scanned by the media scanner, you can
1117 * explicitly add them to the media database with
1118 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[], android.media.MediaScannerConnection.OnScanCompletedListener)
1119 * MediaScannerConnection.scanFile}. Note that this is not the same as
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001120 * {@link android.os.Environment#getExternalStoragePublicDirectory
1121 * Environment.getExternalStoragePublicDirectory()}, which provides
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001122 * directories of media shared by all applications. The directories returned
1123 * here are owned by the application, and their contents will be removed
1124 * when the application is uninstalled. Unlike
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001125 * {@link android.os.Environment#getExternalStoragePublicDirectory
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001126 * Environment.getExternalStoragePublicDirectory()}, the directory returned
1127 * here will be automatically created for you.
1128 * <p>
1129 * Here is an example of typical code to manipulate a picture in an
1130 * application's shared storage and add it to the media database:
1131 * </p>
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001132 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
1133 * private_picture}
Jeff Sharkey8c165792012-10-22 14:08:29 -07001134 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001135 * @param type The type of files directory to return. May be {@code null}
1136 * for the root of the files directory or one of the following
1137 * constants for a subdirectory:
1138 * {@link android.os.Environment#DIRECTORY_MUSIC},
1139 * {@link android.os.Environment#DIRECTORY_PODCASTS},
1140 * {@link android.os.Environment#DIRECTORY_RINGTONES},
1141 * {@link android.os.Environment#DIRECTORY_ALARMS},
1142 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
1143 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
1144 * {@link android.os.Environment#DIRECTORY_MOVIES}.
1145 * @return the absolute path to application-specific directory. May return
1146 * {@code null} if shared storage is not currently available.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001147 * @see #getFilesDir
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001148 * @see #getExternalFilesDirs(String)
1149 * @see Environment#getExternalStorageState(File)
1150 * @see Environment#isExternalStorageEmulated(File)
1151 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001152 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001153 @Nullable
1154 public abstract File getExternalFilesDir(@Nullable String type);
Scott Main4b5da682010-10-21 11:49:12 -07001155
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001156 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001157 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001158 * shared/external storage devices where the application can place
1159 * persistent files it owns. These files are internal to the application,
1160 * and not typically visible to the user as media.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001161 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001162 * This is like {@link #getFilesDir()} in that these files will be deleted
1163 * when the application is uninstalled, however there are some important
1164 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001165 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001166 * <li>Shared storage may not always be available, since removable media can
1167 * be ejected by the user. Media state can be checked using
1168 * {@link Environment#getExternalStorageState(File)}.
1169 * <li>There is no security enforced with these files. For example, any
1170 * application holding
1171 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1172 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001173 * </ul>
1174 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001175 * If a shared storage device is emulated (as determined by
1176 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1177 * backed by a private user data partition, which means there is little
1178 * benefit to storing data here instead of the private directories returned
1179 * by {@link #getFilesDir()}, etc.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001180 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001181 * Shared storage devices returned here are considered a stable part of the
1182 * device, including physical media slots under a protective cover. The
1183 * returned paths do not include transient devices, such as USB flash drives
1184 * connected to handheld devices.
1185 * <p>
1186 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001187 * example, an app may choose to store large files on the device with the
1188 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001189 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001190 * No additional permissions are required for the calling app to read or
1191 * write files under the returned path. Write access outside of these paths
1192 * on secondary external storage devices is not available.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001193 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001194 * The returned path may change over time if different shared storage media
1195 * is inserted, so only relative paths should be persisted.
Jeff Sharkey8c165792012-10-22 14:08:29 -07001196 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001197 * @param type The type of files directory to return. May be {@code null}
1198 * for the root of the files directory or one of the following
1199 * constants for a subdirectory:
1200 * {@link android.os.Environment#DIRECTORY_MUSIC},
1201 * {@link android.os.Environment#DIRECTORY_PODCASTS},
1202 * {@link android.os.Environment#DIRECTORY_RINGTONES},
1203 * {@link android.os.Environment#DIRECTORY_ALARMS},
1204 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
1205 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
1206 * {@link android.os.Environment#DIRECTORY_MOVIES}.
1207 * @return the absolute paths to application-specific directories. Some
1208 * individual paths may be {@code null} if that shared storage is
1209 * not currently available. The first path returned is the same as
1210 * {@link #getExternalFilesDir(String)}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001211 * @see #getExternalFilesDir(String)
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001212 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001213 * @see Environment#isExternalStorageEmulated(File)
1214 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001215 */
1216 public abstract File[] getExternalFilesDirs(String type);
1217
1218 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001219 * Return the primary shared/external storage directory where this
1220 * application's OBB files (if there are any) can be found. Note if the
1221 * application does not have any OBB files, this directory may not exist.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001222 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001223 * This is like {@link #getFilesDir()} in that these files will be deleted
1224 * when the application is uninstalled, however there are some important
1225 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001226 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001227 * <li>Shared storage may not always be available, since removable media can
1228 * be ejected by the user. Media state can be checked using
1229 * {@link Environment#getExternalStorageState(File)}.
1230 * <li>There is no security enforced with these files. For example, any
1231 * application holding
1232 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001233 * these files.
1234 * </ul>
1235 * <p>
1236 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Dave Friedmancfe50882017-07-05 00:40:07 -07001237 * are required to read or write to the path that this method returns.
1238 * However, starting from {@link android.os.Build.VERSION_CODES#M},
1239 * to read the OBB expansion files, you must declare the
1240 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission in the app manifest and ask for
1241 * permission at runtime as follows:
1242 * </p>
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001243 * <p>
Dave Friedmancfe50882017-07-05 00:40:07 -07001244 * {@code <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
1245 * android:maxSdkVersion="23" />}
1246 * </p>
1247 * <p>
1248 * Starting from {@link android.os.Build.VERSION_CODES#N},
1249 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE}
1250 * permission is not required, so don’t ask for this
1251 * permission at runtime. To handle both cases, your app must first try to read the OBB file,
1252 * and if it fails, you must request
1253 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission at runtime.
1254 * </p>
1255 *
1256 * <p>
1257 * The following code snippet shows how to do this:
1258 * </p>
1259 *
1260 * <pre>
1261 * File obb = new File(obb_filename);
1262 * boolean open_failed = false;
1263 *
1264 * try {
1265 * BufferedReader br = new BufferedReader(new FileReader(obb));
1266 * open_failed = false;
1267 * ReadObbFile(br);
1268 * } catch (IOException e) {
1269 * open_failed = true;
1270 * }
1271 *
1272 * if (open_failed) {
1273 * // request READ_EXTERNAL_STORAGE permission before reading OBB file
1274 * ReadObbFileWithPermission();
1275 * }
1276 * </pre>
1277 *
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001278 * On devices with multiple users (as described by {@link UserManager}),
Jeff Sharkey8c165792012-10-22 14:08:29 -07001279 * multiple users may share the same OBB storage location. Applications
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001280 * should ensure that multiple instances running under different users don't
1281 * interfere with each other.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001282 *
1283 * @return the absolute path to application-specific directory. May return
1284 * {@code null} if shared storage is not currently available.
1285 * @see #getObbDirs()
1286 * @see Environment#getExternalStorageState(File)
1287 * @see Environment#isExternalStorageEmulated(File)
1288 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborn805fd7e2011-01-16 18:30:29 -08001289 */
1290 public abstract File getObbDir();
1291
1292 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001293 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001294 * shared/external storage devices where the application's OBB files (if
1295 * there are any) can be found. Note if the application does not have any
1296 * OBB files, these directories may not exist.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001297 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001298 * This is like {@link #getFilesDir()} in that these files will be deleted
1299 * when the application is uninstalled, however there are some important
1300 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001301 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001302 * <li>Shared storage may not always be available, since removable media can
1303 * be ejected by the user. Media state can be checked using
1304 * {@link Environment#getExternalStorageState(File)}.
1305 * <li>There is no security enforced with these files. For example, any
1306 * application holding
1307 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1308 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001309 * </ul>
1310 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001311 * Shared storage devices returned here are considered a stable part of the
1312 * device, including physical media slots under a protective cover. The
1313 * returned paths do not include transient devices, such as USB flash drives
1314 * connected to handheld devices.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001315 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001316 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001317 * example, an app may choose to store large files on the device with the
1318 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001319 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001320 * No additional permissions are required for the calling app to read or
1321 * write files under the returned path. Write access outside of these paths
1322 * on secondary external storage devices is not available.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001323 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001324 * @return the absolute paths to application-specific directories. Some
1325 * individual paths may be {@code null} if that shared storage is
1326 * not currently available. The first path returned is the same as
1327 * {@link #getObbDir()}
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001328 * @see #getObbDir()
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001329 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001330 * @see Environment#isExternalStorageEmulated(File)
1331 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001332 */
1333 public abstract File[] getObbDirs();
1334
1335 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001336 * Returns the absolute path to the application specific cache directory on
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001337 * the filesystem.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001338 * <p>
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001339 * The system will automatically delete files in this directory as disk
1340 * space is needed elsewhere on the device. The system will always delete
1341 * older files first, as reported by {@link File#lastModified()}. If
1342 * desired, you can exert more control over how files are deleted using
1343 * {@link StorageManager#setCacheBehaviorGroup(File, boolean)} and
1344 * {@link StorageManager#setCacheBehaviorTombstone(File, boolean)}.
1345 * <p>
1346 * Apps are strongly encouraged to keep their usage of cache space below the
1347 * quota returned by
1348 * {@link StorageManager#getCacheQuotaBytes(java.util.UUID)}. If your app
1349 * goes above this quota, your cached files will be some of the first to be
1350 * deleted when additional disk space is needed. Conversely, if your app
1351 * stays under this quota, your cached files will be some of the last to be
1352 * deleted when additional disk space is needed.
1353 * <p>
1354 * Note that your cache quota will change over time depending on how
1355 * frequently the user interacts with your app, and depending on how much
1356 * system-wide disk space is used.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001357 * <p>
1358 * The returned path may change over time if the calling app is moved to an
1359 * adopted storage device, so only relative paths should be persisted.
1360 * <p>
1361 * Apps require no extra permissions to read or write to the returned path,
1362 * since this path lives in their private storage.
Scott Main4b5da682010-10-21 11:49:12 -07001363 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001364 * @return The path of the directory holding application cache files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001365 * @see #openFileOutput
1366 * @see #getFileStreamPath
1367 * @see #getDir
Kevin Hufnaglee9681e12016-09-23 16:44:03 -07001368 * @see #getExternalCacheDir
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001369 */
1370 public abstract File getCacheDir();
1371
1372 /**
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001373 * Returns the absolute path to the application specific cache directory on
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001374 * the filesystem designed for storing cached code.
1375 * <p>
1376 * The system will delete any files stored in this location both when your
1377 * specific application is upgraded, and when the entire platform is
1378 * upgraded.
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001379 * <p>
1380 * This location is optimal for storing compiled or optimized code generated
1381 * by your application at runtime.
1382 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001383 * The returned path may change over time if the calling app is moved to an
1384 * adopted storage device, so only relative paths should be persisted.
1385 * <p>
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001386 * Apps require no extra permissions to read or write to the returned path,
1387 * since this path lives in their private storage.
1388 *
1389 * @return The path of the directory holding application code cache files.
1390 */
1391 public abstract File getCodeCacheDir();
1392
1393 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001394 * Returns absolute path to application-specific directory on the primary
1395 * shared/external storage device where the application can place cache
1396 * files it owns. These files are internal to the application, and not
1397 * typically visible to the user as media.
1398 * <p>
1399 * This is like {@link #getCacheDir()} in that these files will be deleted
1400 * when the application is uninstalled, however there are some important
1401 * differences:
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001402 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001403 * <li>The platform does not always monitor the space available in shared
1404 * storage, and thus may not automatically delete these files. Apps should
1405 * always manage the maximum space used in this location. Currently the only
1406 * time files here will be deleted by the platform is when running on
1407 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and
1408 * {@link Environment#isExternalStorageEmulated(File)} returns true.
1409 * <li>Shared storage may not always be available, since removable media can
1410 * be ejected by the user. Media state can be checked using
1411 * {@link Environment#getExternalStorageState(File)}.
1412 * <li>There is no security enforced with these files. For example, any
1413 * application holding
1414 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001415 * these files.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001416 * </ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001417 * <p>
1418 * If a shared storage device is emulated (as determined by
Kevin Hufnaglee9681e12016-09-23 16:44:03 -07001419 * {@link Environment#isExternalStorageEmulated(File)}), its contents are
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001420 * backed by a private user data partition, which means there is little
1421 * benefit to storing data here instead of the private directory returned by
1422 * {@link #getCacheDir()}.
1423 * <p>
1424 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001425 * are required to read or write to the returned path; it's always
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001426 * accessible to the calling app. This only applies to paths generated for
1427 * package name of the calling application. To access paths belonging to
1428 * other packages,
1429 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or
1430 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required.
1431 * <p>
1432 * On devices with multiple users (as described by {@link UserManager}),
1433 * each user has their own isolated shared storage. Applications only have
1434 * access to the shared storage for the user they're running as.
1435 * <p>
1436 * The returned path may change over time if different shared storage media
1437 * is inserted, so only relative paths should be persisted.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001438 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001439 * @return the absolute path to application-specific directory. May return
1440 * {@code null} if shared storage is not currently available.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001441 * @see #getCacheDir
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001442 * @see #getExternalCacheDirs()
1443 * @see Environment#getExternalStorageState(File)
1444 * @see Environment#isExternalStorageEmulated(File)
1445 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001446 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001447 @Nullable
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001448 public abstract File getExternalCacheDir();
Scott Main4b5da682010-10-21 11:49:12 -07001449
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001450 /**
Fyodor Kupolov61221292016-09-02 15:21:03 -07001451 * Returns absolute path to application-specific directory in the preloaded cache.
1452 * <p>Files stored in the cache directory can be deleted when the device runs low on storage.
1453 * There is no guarantee when these files will be deleted.
1454 * @hide
1455 */
1456 @Nullable
1457 @SystemApi
1458 public abstract File getPreloadsFileCache();
1459
1460 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001461 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001462 * shared/external storage devices where the application can place cache
1463 * files it owns. These files are internal to the application, and not
1464 * typically visible to the user as media.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001465 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001466 * This is like {@link #getCacheDir()} in that these files will be deleted
1467 * when the application is uninstalled, however there are some important
1468 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001469 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001470 * <li>The platform does not always monitor the space available in shared
1471 * storage, and thus may not automatically delete these files. Apps should
1472 * always manage the maximum space used in this location. Currently the only
1473 * time files here will be deleted by the platform is when running on
1474 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and
1475 * {@link Environment#isExternalStorageEmulated(File)} returns true.
1476 * <li>Shared storage may not always be available, since removable media can
1477 * be ejected by the user. Media state can be checked using
1478 * {@link Environment#getExternalStorageState(File)}.
1479 * <li>There is no security enforced with these files. For example, any
1480 * application holding
1481 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1482 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001483 * </ul>
1484 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001485 * If a shared storage device is emulated (as determined by
1486 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1487 * backed by a private user data partition, which means there is little
1488 * benefit to storing data here instead of the private directory returned by
1489 * {@link #getCacheDir()}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001490 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001491 * Shared storage devices returned here are considered a stable part of the
1492 * device, including physical media slots under a protective cover. The
1493 * returned paths do not include transient devices, such as USB flash drives
1494 * connected to handheld devices.
1495 * <p>
1496 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001497 * example, an app may choose to store large files on the device with the
1498 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001499 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001500 * No additional permissions are required for the calling app to read or
1501 * write files under the returned path. Write access outside of these paths
1502 * on secondary external storage devices is not available.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001503 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001504 * The returned paths may change over time if different shared storage media
1505 * is inserted, so only relative paths should be persisted.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001506 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001507 * @return the absolute paths to application-specific directories. Some
1508 * individual paths may be {@code null} if that shared storage is
1509 * not currently available. The first path returned is the same as
1510 * {@link #getExternalCacheDir()}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001511 * @see #getExternalCacheDir()
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001512 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001513 * @see Environment#isExternalStorageEmulated(File)
1514 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001515 */
1516 public abstract File[] getExternalCacheDirs();
1517
1518 /**
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001519 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001520 * shared/external storage devices where the application can place media
1521 * files. These files are scanned and made available to other apps through
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001522 * {@link MediaStore}.
1523 * <p>
1524 * This is like {@link #getExternalFilesDirs} in that these files will be
1525 * deleted when the application is uninstalled, however there are some
1526 * important differences:
1527 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001528 * <li>Shared storage may not always be available, since removable media can
1529 * be ejected by the user. Media state can be checked using
1530 * {@link Environment#getExternalStorageState(File)}.
1531 * <li>There is no security enforced with these files. For example, any
1532 * application holding
1533 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1534 * these files.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001535 * </ul>
1536 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001537 * Shared storage devices returned here are considered a stable part of the
1538 * device, including physical media slots under a protective cover. The
1539 * returned paths do not include transient devices, such as USB flash drives
1540 * connected to handheld devices.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001541 * <p>
1542 * An application may store data on any or all of the returned devices. For
1543 * example, an app may choose to store large files on the device with the
1544 * most available space, as measured by {@link StatFs}.
1545 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001546 * No additional permissions are required for the calling app to read or
1547 * write files under the returned path. Write access outside of these paths
1548 * on secondary external storage devices is not available.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001549 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001550 * The returned paths may change over time if different shared storage media
1551 * is inserted, so only relative paths should be persisted.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001552 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001553 * @return the absolute paths to application-specific directories. Some
1554 * individual paths may be {@code null} if that shared storage is
1555 * not currently available.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001556 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001557 * @see Environment#isExternalStorageEmulated(File)
1558 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001559 */
1560 public abstract File[] getExternalMediaDirs();
1561
1562 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001563 * Returns an array of strings naming the private files associated with
1564 * this Context's application package.
1565 *
1566 * @return Array of strings naming the private files.
1567 *
1568 * @see #openFileInput
1569 * @see #openFileOutput
1570 * @see #deleteFile
1571 */
1572 public abstract String[] fileList();
1573
1574 /**
1575 * Retrieve, creating if needed, a new directory in which the application
1576 * can place its own custom data files. You can use the returned File
1577 * object to create and access files in this directory. Note that files
1578 * created through a File object will only be accessible by your own
1579 * application; you can only set the mode of the entire directory, not
1580 * of individual files.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001581 * <p>
1582 * The returned path may change over time if the calling app is moved to an
1583 * adopted storage device, so only relative paths should be persisted.
1584 * <p>
1585 * Apps require no extra permissions to read or write to the returned path,
1586 * since this path lives in their private storage.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001587 *
Nick Kralevich92091fa2012-12-12 16:24:31 -08001588 * @param name Name of the directory to retrieve. This is a directory
Nick Kralevich15069212013-01-09 15:54:56 -08001589 * that is created as part of your application data.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001590 * @param mode Operating mode.
Nick Kralevich15069212013-01-09 15:54:56 -08001591 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001592 * @return A {@link File} object for the requested directory. The directory
Nick Kralevich15069212013-01-09 15:54:56 -08001593 * will have been created if it does not already exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 *
1595 * @see #openFileOutput(String, int)
1596 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001597 public abstract File getDir(String name, @FileMode int mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598
1599 /**
1600 * Open a new private SQLiteDatabase associated with this Context's
Jeff Sharkey634dc422016-01-30 17:44:15 -07001601 * application package. Create the database file if it doesn't exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001602 *
1603 * @param name The name (unique in the application package) of the database.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001604 * @param mode Operating mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001605 * @param factory An optional factory class that is called to instantiate a
Jeff Sharkey634dc422016-01-30 17:44:15 -07001606 * cursor when query is called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001607 * @return The contents of a newly created database with the given name.
Jeff Sharkey634dc422016-01-30 17:44:15 -07001608 * @throws android.database.sqlite.SQLiteException if the database file
1609 * could not be opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610 * @see #MODE_PRIVATE
Jeff Brown47847f32012-03-22 19:13:11 -07001611 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Sunny Goyala21e6b22015-12-02 09:51:02 -08001612 * @see #MODE_NO_LOCALIZED_COLLATORS
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001613 * @see #deleteDatabase
1614 */
1615 public abstract SQLiteDatabase openOrCreateDatabase(String name,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001616 @DatabaseMode int mode, CursorFactory factory);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617
1618 /**
Vasu Nori74f170f2010-06-01 18:06:18 -07001619 * Open a new private SQLiteDatabase associated with this Context's
Jeff Sharkey634dc422016-01-30 17:44:15 -07001620 * application package. Creates the database file if it doesn't exist.
1621 * <p>
1622 * Accepts input param: a concrete instance of {@link DatabaseErrorHandler}
1623 * to be used to handle corruption when sqlite reports database corruption.
1624 * </p>
Vasu Nori74f170f2010-06-01 18:06:18 -07001625 *
1626 * @param name The name (unique in the application package) of the database.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001627 * @param mode Operating mode.
Vasu Nori74f170f2010-06-01 18:06:18 -07001628 * @param factory An optional factory class that is called to instantiate a
Jeff Sharkey634dc422016-01-30 17:44:15 -07001629 * cursor when query is called.
1630 * @param errorHandler the {@link DatabaseErrorHandler} to be used when
1631 * sqlite reports database corruption. if null,
1632 * {@link android.database.DefaultDatabaseErrorHandler} is
1633 * assumed.
Vasu Nori74f170f2010-06-01 18:06:18 -07001634 * @return The contents of a newly created database with the given name.
Jeff Sharkey634dc422016-01-30 17:44:15 -07001635 * @throws android.database.sqlite.SQLiteException if the database file
1636 * could not be opened.
Vasu Nori74f170f2010-06-01 18:06:18 -07001637 * @see #MODE_PRIVATE
Jeff Brown47847f32012-03-22 19:13:11 -07001638 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Sunny Goyala21e6b22015-12-02 09:51:02 -08001639 * @see #MODE_NO_LOCALIZED_COLLATORS
Vasu Nori74f170f2010-06-01 18:06:18 -07001640 * @see #deleteDatabase
1641 */
1642 public abstract SQLiteDatabase openOrCreateDatabase(String name,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001643 @DatabaseMode int mode, CursorFactory factory,
Tor Norbyed9273d62013-05-30 15:59:53 -07001644 @Nullable DatabaseErrorHandler errorHandler);
Vasu Nori74f170f2010-06-01 18:06:18 -07001645
1646 /**
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001647 * Move an existing database file from the given source storage context to
1648 * this context. This is typically used to migrate data between storage
1649 * locations after an upgrade, such as migrating to device protected
1650 * storage.
Jeff Sharkeyd21cad12016-05-20 11:30:07 -06001651 * <p>
1652 * The database must be closed before being moved.
Jeff Sharkey35871f22016-01-29 17:13:29 -07001653 *
1654 * @param sourceContext The source context which contains the existing
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001655 * database to move.
Jeff Sharkey35871f22016-01-29 17:13:29 -07001656 * @param name The name of the database file.
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001657 * @return {@code true} if the move was successful or if the database didn't
1658 * exist in the source context, otherwise {@code false}.
1659 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey35871f22016-01-29 17:13:29 -07001660 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001661 public abstract boolean moveDatabaseFrom(Context sourceContext, String name);
1662
Jeff Sharkey35871f22016-01-29 17:13:29 -07001663 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001664 * Delete an existing private SQLiteDatabase associated with this Context's
1665 * application package.
1666 *
1667 * @param name The name (unique in the application package) of the
1668 * database.
1669 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001670 * @return {@code true} if the database was successfully deleted; else {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 *
1672 * @see #openOrCreateDatabase
1673 */
1674 public abstract boolean deleteDatabase(String name);
1675
1676 /**
1677 * Returns the absolute path on the filesystem where a database created with
1678 * {@link #openOrCreateDatabase} is stored.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001679 * <p>
1680 * The returned path may change over time if the calling app is moved to an
1681 * adopted storage device, so only relative paths should be persisted.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 *
1683 * @param name The name of the database for which you would like to get
1684 * its path.
1685 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001686 * @return An absolute path to the given database.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001687 *
1688 * @see #openOrCreateDatabase
1689 */
1690 public abstract File getDatabasePath(String name);
1691
1692 /**
1693 * Returns an array of strings naming the private databases associated with
1694 * this Context's application package.
1695 *
1696 * @return Array of strings naming the private databases.
1697 *
1698 * @see #openOrCreateDatabase
1699 * @see #deleteDatabase
1700 */
1701 public abstract String[] databaseList();
1702
1703 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001704 * @deprecated Use {@link android.app.WallpaperManager#getDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001705 * WallpaperManager.get()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001706 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001707 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001708 public abstract Drawable getWallpaper();
1709
1710 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001711 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001712 * WallpaperManager.peek()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001713 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001714 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001715 public abstract Drawable peekWallpaper();
1716
1717 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001718 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth()
1719 * WallpaperManager.getDesiredMinimumWidth()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001720 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001721 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001722 public abstract int getWallpaperDesiredMinimumWidth();
1723
1724 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001725 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight()
1726 * WallpaperManager.getDesiredMinimumHeight()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001727 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001728 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001729 public abstract int getWallpaperDesiredMinimumHeight();
1730
1731 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001732 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001733 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001734 * <p>This method requires the caller to hold the permission
1735 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001736 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001737 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001738 public abstract void setWallpaper(Bitmap bitmap) throws IOException;
1739
1740 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001741 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001742 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001743 * <p>This method requires the caller to hold the permission
1744 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001745 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001746 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001747 public abstract void setWallpaper(InputStream data) throws IOException;
1748
1749 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001750 * @deprecated Use {@link android.app.WallpaperManager#clear
1751 * WallpaperManager.clear()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001752 * <p>This method requires the caller to hold the permission
1753 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001754 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001755 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001756 public abstract void clearWallpaper() throws IOException;
1757
1758 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001759 * Same as {@link #startActivity(Intent, Bundle)} with no options
1760 * specified.
1761 *
1762 * @param intent The description of the activity to start.
1763 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001764 * @throws ActivityNotFoundException &nbsp;
Svet Ganov1ed0e552015-06-11 01:15:43 -07001765 *`
John Spurlock6098c5d2013-06-17 10:32:46 -04001766 * @see #startActivity(Intent, Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -07001767 * @see PackageManager#resolveActivity
1768 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001769 public abstract void startActivity(@RequiresPermission Intent intent);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001770
1771 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001772 * Version of {@link #startActivity(Intent)} that allows you to specify the
1773 * user the activity will be started for. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001774 * that are not pre-installed on the system image.
Amith Yamasani82644082012-08-03 13:09:11 -07001775 * @param intent The description of the activity to start.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001776 * @param user The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -04001777 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani82644082012-08-03 13:09:11 -07001778 * @hide
1779 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001780 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Philip P. Moltmann4e615e62018-08-28 14:57:49 -07001781 @SystemApi
Adrian Roosebc927c2019-02-28 16:21:18 +01001782 public void startActivityAsUser(@RequiresPermission @NonNull Intent intent,
1783 @NonNull UserHandle user) {
Amith Yamasani82644082012-08-03 13:09:11 -07001784 throw new RuntimeException("Not implemented. Must override in a subclass.");
1785 }
1786
1787 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001788 * Launch a new activity. You will not receive any information about when
1789 * the activity exits.
1790 *
1791 * <p>Note that if this method is being called from outside of an
1792 * {@link android.app.Activity} Context, then the Intent must include
1793 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because,
1794 * without being started from an existing Activity, there is no existing
1795 * task in which to place the new activity and thus it needs to be placed
1796 * in its own separate task.
1797 *
1798 * <p>This method throws {@link ActivityNotFoundException}
1799 * if there was no Activity found to run the given Intent.
1800 *
1801 * @param intent The description of the activity to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001802 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001803 * May be null if there are no options. See {@link android.app.ActivityOptions}
1804 * for how to build the Bundle supplied here; there are no supported definitions
1805 * for building it manually.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001806 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001807 * @throws ActivityNotFoundException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001808 *
Scott Main60dd5202012-06-23 00:01:22 -07001809 * @see #startActivity(Intent)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001810 * @see PackageManager#resolveActivity
1811 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001812 public abstract void startActivity(@RequiresPermission Intent intent,
1813 @Nullable Bundle options);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001814
1815 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001816 * Version of {@link #startActivity(Intent, Bundle)} that allows you to specify the
1817 * user the activity will be started for. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001818 * that are not pre-installed on the system image.
Amith Yamasani258848d2012-08-10 17:06:33 -07001819 * @param intent The description of the activity to start.
1820 * @param options Additional options for how the Activity should be started.
1821 * May be null if there are no options. See {@link android.app.ActivityOptions}
1822 * for how to build the Bundle supplied here; there are no supported definitions
1823 * for building it manually.
Dianne Hackborn221ea892013-08-04 16:50:16 -07001824 * @param userId The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -04001825 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani258848d2012-08-10 17:06:33 -07001826 * @hide
1827 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001828 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001829 @UnsupportedAppUsage
Tor Norbye788fc2b2015-07-05 16:10:42 -07001830 public void startActivityAsUser(@RequiresPermission Intent intent, @Nullable Bundle options,
1831 UserHandle userId) {
Amith Yamasani258848d2012-08-10 17:06:33 -07001832 throw new RuntimeException("Not implemented. Must override in a subclass.");
1833 }
1834
1835 /**
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001836 * Version of {@link #startActivity(Intent, Bundle)} that returns a result to the caller. This
1837 * is only supported for Views and Fragments.
1838 * @param who The identifier for the calling element that will receive the result.
1839 * @param intent The intent to start.
1840 * @param requestCode The code that will be returned with onActivityResult() identifying this
1841 * request.
1842 * @param options Additional options for how the Activity should be started.
1843 * May be null if there are no options. See {@link android.app.ActivityOptions}
1844 * for how to build the Bundle supplied here; there are no supported definitions
1845 * for building it manually.
1846 * @hide
1847 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001848 @UnsupportedAppUsage
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001849 public void startActivityForResult(
1850 @NonNull String who, Intent intent, int requestCode, @Nullable Bundle options) {
1851 throw new RuntimeException("This method is only implemented for Activity-based Contexts. "
1852 + "Check canStartActivityForResult() before calling.");
1853 }
1854
1855 /**
1856 * Identifies whether this Context instance will be able to process calls to
1857 * {@link #startActivityForResult(String, Intent, int, Bundle)}.
1858 * @hide
1859 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001860 @UnsupportedAppUsage
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001861 public boolean canStartActivityForResult() {
1862 return false;
1863 }
1864
1865 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001866 * Same as {@link #startActivities(Intent[], Bundle)} with no options
1867 * specified.
1868 *
1869 * @param intents An array of Intents to be started.
1870 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001871 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborna4972e92012-03-14 10:38:05 -07001872 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001873 * @see #startActivities(Intent[], Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -07001874 * @see PackageManager#resolveActivity
1875 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001876 public abstract void startActivities(@RequiresPermission Intent[] intents);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001877
1878 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001879 * Launch multiple new activities. This is generally the same as calling
1880 * {@link #startActivity(Intent)} for the first Intent in the array,
1881 * that activity during its creation calling {@link #startActivity(Intent)}
1882 * for the second entry, etc. Note that unlike that approach, generally
1883 * none of the activities except the last in the array will be created
1884 * at this point, but rather will be created when the user first visits
1885 * them (due to pressing back from the activity on top).
1886 *
1887 * <p>This method throws {@link ActivityNotFoundException}
1888 * if there was no Activity found for <em>any</em> given Intent. In this
1889 * case the state of the activity stack is undefined (some Intents in the
1890 * list may be on it, some not), so you probably want to avoid such situations.
1891 *
1892 * @param intents An array of Intents to be started.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001893 * @param options Additional options for how the Activity should be started.
Elliot Waite54de7742017-01-11 15:30:35 -08001894 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001895 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001896 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001897 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001898 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001899 * @see #startActivities(Intent[])
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001900 * @see PackageManager#resolveActivity
1901 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001902 public abstract void startActivities(@RequiresPermission Intent[] intents, Bundle options);
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001903
1904 /**
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001905 * @hide
1906 * Launch multiple new activities. This is generally the same as calling
1907 * {@link #startActivity(Intent)} for the first Intent in the array,
1908 * that activity during its creation calling {@link #startActivity(Intent)}
1909 * for the second entry, etc. Note that unlike that approach, generally
1910 * none of the activities except the last in the array will be created
1911 * at this point, but rather will be created when the user first visits
1912 * them (due to pressing back from the activity on top).
1913 *
1914 * <p>This method throws {@link ActivityNotFoundException}
1915 * if there was no Activity found for <em>any</em> given Intent. In this
1916 * case the state of the activity stack is undefined (some Intents in the
1917 * list may be on it, some not), so you probably want to avoid such situations.
1918 *
1919 * @param intents An array of Intents to be started.
1920 * @param options Additional options for how the Activity should be started.
1921 * @param userHandle The user for whom to launch the activities
Elliot Waite54de7742017-01-11 15:30:35 -08001922 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001923 * Context.startActivity(Intent, Bundle)} for more details.
1924 *
Selim Cinek7fa385a2018-01-24 08:35:28 -08001925 * @return The corresponding flag {@link ActivityManager#START_CANCELED},
1926 * {@link ActivityManager#START_SUCCESS} etc. indicating whether the launch was
1927 * successful.
1928 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001929 * @throws ActivityNotFoundException &nbsp;
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001930 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001931 * @see #startActivities(Intent[])
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001932 * @see PackageManager#resolveActivity
1933 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001934 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Selim Cinek7fa385a2018-01-24 08:35:28 -08001935 public int startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle) {
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001936 throw new RuntimeException("Not implemented. Must override in a subclass.");
1937 }
1938
1939 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001940 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)}
1941 * with no options specified.
1942 *
1943 * @param intent The IntentSender to launch.
1944 * @param fillInIntent If non-null, this will be provided as the
1945 * intent parameter to {@link IntentSender#sendIntent}.
1946 * @param flagsMask Intent flags in the original IntentSender that you
1947 * would like to change.
1948 * @param flagsValues Desired values for any bits set in
1949 * <var>flagsMask</var>
1950 * @param extraFlags Always set to 0.
1951 *
1952 * @see #startActivity(Intent)
1953 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle)
1954 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001955 public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent,
1956 @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues,
1957 int extraFlags) throws IntentSender.SendIntentException;
Dianne Hackborna4972e92012-03-14 10:38:05 -07001958
1959 /**
1960 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001961 * to start. If the IntentSender is for an activity, that activity will be started
Dianne Hackbornae22c052009-09-17 18:46:22 -07001962 * as if you had called the regular {@link #startActivity(Intent)}
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001963 * here; otherwise, its associated action will be executed (such as
1964 * sending a broadcast) as if you had called
1965 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Scott Main4b5da682010-10-21 11:49:12 -07001966 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001967 * @param intent The IntentSender to launch.
1968 * @param fillInIntent If non-null, this will be provided as the
1969 * intent parameter to {@link IntentSender#sendIntent}.
1970 * @param flagsMask Intent flags in the original IntentSender that you
1971 * would like to change.
1972 * @param flagsValues Desired values for any bits set in
1973 * <var>flagsMask</var>
1974 * @param extraFlags Always set to 0.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001975 * @param options Additional options for how the Activity should be started.
Elliot Waite54de7742017-01-11 15:30:35 -08001976 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001977 * Context.startActivity(Intent, Bundle)} for more details. If options
1978 * have also been supplied by the IntentSender, options given here will
1979 * override any that conflict with those given by the IntentSender.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001980 *
1981 * @see #startActivity(Intent, Bundle)
1982 * @see #startIntentSender(IntentSender, Intent, int, int, int)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001983 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001984 public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent,
1985 @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues,
1986 int extraFlags, @Nullable Bundle options) throws IntentSender.SendIntentException;
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001987
1988 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001989 * Broadcast the given intent to all interested BroadcastReceivers. This
1990 * call is asynchronous; it returns immediately, and you will continue
1991 * executing while the receivers are run. No results are propagated from
1992 * receivers and receivers can not abort the broadcast. If you want
1993 * to allow receivers to propagate results or abort the broadcast, you must
1994 * send an ordered broadcast using
1995 * {@link #sendOrderedBroadcast(Intent, String)}.
1996 *
1997 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1998 *
1999 * @param intent The Intent to broadcast; all receivers matching this
2000 * Intent will receive the broadcast.
2001 *
2002 * @see android.content.BroadcastReceiver
2003 * @see #registerReceiver
2004 * @see #sendBroadcast(Intent, String)
2005 * @see #sendOrderedBroadcast(Intent, String)
2006 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2007 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002008 public abstract void sendBroadcast(@RequiresPermission Intent intent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002009
2010 /**
2011 * Broadcast the given intent to all interested BroadcastReceivers, allowing
2012 * an optional required permission to be enforced. This
2013 * call is asynchronous; it returns immediately, and you will continue
2014 * executing while the receivers are run. No results are propagated from
2015 * receivers and receivers can not abort the broadcast. If you want
2016 * to allow receivers to propagate results or abort the broadcast, you must
2017 * send an ordered broadcast using
2018 * {@link #sendOrderedBroadcast(Intent, String)}.
2019 *
2020 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2021 *
2022 * @param intent The Intent to broadcast; all receivers matching this
2023 * Intent will receive the broadcast.
Brad Fitzpatrick26b71be2010-12-07 14:52:58 -08002024 * @param receiverPermission (optional) String naming a permission that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002025 * a receiver must hold in order to receive your broadcast.
2026 * If null, no permission is required.
2027 *
2028 * @see android.content.BroadcastReceiver
2029 * @see #registerReceiver
2030 * @see #sendBroadcast(Intent)
2031 * @see #sendOrderedBroadcast(Intent, String)
2032 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2033 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002034 public abstract void sendBroadcast(@RequiresPermission Intent intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07002035 @Nullable String receiverPermission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002036
Fyodor Kupolovd4fd8c72015-07-13 19:19:25 -07002037
2038 /**
2039 * Broadcast the given intent to all interested BroadcastReceivers, allowing
2040 * an array of required permissions to be enforced. This call is asynchronous; it returns
2041 * immediately, and you will continue executing while the receivers are run. No results are
2042 * propagated from receivers and receivers can not abort the broadcast. If you want to allow
2043 * receivers to propagate results or abort the broadcast, you must send an ordered broadcast
2044 * using {@link #sendOrderedBroadcast(Intent, String)}.
2045 *
2046 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2047 *
2048 * @param intent The Intent to broadcast; all receivers matching this
2049 * Intent will receive the broadcast.
2050 * @param receiverPermissions Array of names of permissions that a receiver must hold
2051 * in order to receive your broadcast.
2052 * If null or empty, no permissions are required.
2053 *
2054 * @see android.content.BroadcastReceiver
2055 * @see #registerReceiver
2056 * @see #sendBroadcast(Intent)
2057 * @see #sendOrderedBroadcast(Intent, String)
2058 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2059 * @hide
2060 */
2061 public abstract void sendBroadcastMultiplePermissions(Intent intent,
2062 String[] receiverPermissions);
2063
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002064 /**
Dianne Hackborna750a632015-06-16 17:18:23 -07002065 * Broadcast the given intent to all interested BroadcastReceivers, allowing
Tyler Gunnf955e562018-04-26 14:43:31 -07002066 * an array of required permissions to be enforced. This call is asynchronous; it returns
2067 * immediately, and you will continue executing while the receivers are run. No results are
2068 * propagated from receivers and receivers can not abort the broadcast. If you want to allow
2069 * receivers to propagate results or abort the broadcast, you must send an ordered broadcast
2070 * using {@link #sendOrderedBroadcast(Intent, String)}.
2071 *
2072 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2073 *
2074 * @param intent The Intent to broadcast; all receivers matching this
2075 * Intent will receive the broadcast.
2076 * @param user The user to send the broadcast to.
2077 * @param receiverPermissions Array of names of permissions that a receiver must hold
2078 * in order to receive your broadcast.
2079 * If null or empty, no permissions are required.
2080 *
2081 * @see android.content.BroadcastReceiver
2082 * @see #registerReceiver
2083 * @see #sendBroadcast(Intent)
2084 * @see #sendOrderedBroadcast(Intent, String)
2085 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2086 * @hide
2087 */
2088 public abstract void sendBroadcastAsUserMultiplePermissions(Intent intent, UserHandle user,
2089 String[] receiverPermissions);
2090
2091 /**
2092 * Broadcast the given intent to all interested BroadcastReceivers, allowing
Dianne Hackborna750a632015-06-16 17:18:23 -07002093 * an optional required permission to be enforced. This
2094 * call is asynchronous; it returns immediately, and you will continue
2095 * executing while the receivers are run. No results are propagated from
2096 * receivers and receivers can not abort the broadcast. If you want
2097 * to allow receivers to propagate results or abort the broadcast, you must
2098 * send an ordered broadcast using
2099 * {@link #sendOrderedBroadcast(Intent, String)}.
2100 *
2101 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2102 *
2103 * @param intent The Intent to broadcast; all receivers matching this
2104 * Intent will receive the broadcast.
2105 * @param receiverPermission (optional) String naming a permission that
2106 * a receiver must hold in order to receive your broadcast.
2107 * If null, no permission is required.
2108 * @param options (optional) Additional sending options, generated from a
2109 * {@link android.app.BroadcastOptions}.
2110 *
2111 * @see android.content.BroadcastReceiver
2112 * @see #registerReceiver
2113 * @see #sendBroadcast(Intent)
2114 * @see #sendOrderedBroadcast(Intent, String)
2115 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2116 * @hide
2117 */
2118 @SystemApi
2119 public abstract void sendBroadcast(Intent intent,
2120 @Nullable String receiverPermission,
2121 @Nullable Bundle options);
2122
2123 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002124 * Like {@link #sendBroadcast(Intent, String)}, but also allows specification
Tor Norbyed9273d62013-05-30 15:59:53 -07002125 * of an associated app op as per {@link android.app.AppOpsManager}.
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002126 * @hide
2127 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002128 @UnsupportedAppUsage
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002129 public abstract void sendBroadcast(Intent intent,
2130 String receiverPermission, int appOp);
2131
2132 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 * Broadcast the given intent to all interested BroadcastReceivers, delivering
2134 * them one at a time to allow more preferred receivers to consume the
2135 * broadcast before it is delivered to less preferred receivers. This
2136 * call is asynchronous; it returns immediately, and you will continue
2137 * executing while the receivers are run.
2138 *
2139 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2140 *
2141 * @param intent The Intent to broadcast; all receivers matching this
2142 * Intent will receive the broadcast.
2143 * @param receiverPermission (optional) String naming a permissions that
2144 * a receiver must hold in order to receive your broadcast.
2145 * If null, no permission is required.
2146 *
2147 * @see android.content.BroadcastReceiver
2148 * @see #registerReceiver
2149 * @see #sendBroadcast(Intent)
2150 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2151 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002152 public abstract void sendOrderedBroadcast(@RequiresPermission Intent intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07002153 @Nullable String receiverPermission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002154
2155 /**
2156 * Version of {@link #sendBroadcast(Intent)} that allows you to
2157 * receive data back from the broadcast. This is accomplished by
2158 * supplying your own BroadcastReceiver when calling, which will be
2159 * treated as a final receiver at the end of the broadcast -- its
2160 * {@link BroadcastReceiver#onReceive} method will be called with
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002161 * the result values collected from the other receivers. The broadcast will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002162 * be serialized in the same way as calling
2163 * {@link #sendOrderedBroadcast(Intent, String)}.
2164 *
2165 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2166 * asynchronous; it will return before
2167 * resultReceiver.onReceive() is called.
2168 *
2169 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2170 *
2171 * @param intent The Intent to broadcast; all receivers matching this
2172 * Intent will receive the broadcast.
2173 * @param receiverPermission String naming a permissions that
2174 * a receiver must hold in order to receive your broadcast.
2175 * If null, no permission is required.
2176 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2177 * receiver of the broadcast.
2178 * @param scheduler A custom Handler with which to schedule the
2179 * resultReceiver callback; if null it will be
2180 * scheduled in the Context's main thread.
2181 * @param initialCode An initial value for the result code. Often
2182 * Activity.RESULT_OK.
2183 * @param initialData An initial value for the result data. Often
2184 * null.
2185 * @param initialExtras An initial value for the result extras. Often
2186 * null.
2187 *
2188 * @see #sendBroadcast(Intent)
2189 * @see #sendBroadcast(Intent, String)
2190 * @see #sendOrderedBroadcast(Intent, String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002191 * @see android.content.BroadcastReceiver
2192 * @see #registerReceiver
2193 * @see android.app.Activity#RESULT_OK
2194 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002195 public abstract void sendOrderedBroadcast(@RequiresPermission @NonNull Intent intent,
Dianne Hackborna750a632015-06-16 17:18:23 -07002196 @Nullable String receiverPermission, @Nullable BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002197 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2198 @Nullable Bundle initialExtras);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002199
2200 /**
Dianne Hackborna750a632015-06-16 17:18:23 -07002201 * Version of {@link #sendBroadcast(Intent)} that allows you to
2202 * receive data back from the broadcast. This is accomplished by
2203 * supplying your own BroadcastReceiver when calling, which will be
2204 * treated as a final receiver at the end of the broadcast -- its
2205 * {@link BroadcastReceiver#onReceive} method will be called with
2206 * the result values collected from the other receivers. The broadcast will
2207 * be serialized in the same way as calling
2208 * {@link #sendOrderedBroadcast(Intent, String)}.
2209 *
2210 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2211 * asynchronous; it will return before
2212 * resultReceiver.onReceive() is called.
2213 *
2214 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2215 *
2216 *
2217 * @param intent The Intent to broadcast; all receivers matching this
2218 * Intent will receive the broadcast.
2219 * @param receiverPermission String naming a permissions that
2220 * a receiver must hold in order to receive your broadcast.
2221 * If null, no permission is required.
2222 * @param options (optional) Additional sending options, generated from a
2223 * {@link android.app.BroadcastOptions}.
2224 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2225 * receiver of the broadcast.
2226 * @param scheduler A custom Handler with which to schedule the
2227 * resultReceiver callback; if null it will be
2228 * scheduled in the Context's main thread.
2229 * @param initialCode An initial value for the result code. Often
2230 * Activity.RESULT_OK.
2231 * @param initialData An initial value for the result data. Often
2232 * null.
2233 * @param initialExtras An initial value for the result extras. Often
2234 * null.
2235 * @see #sendBroadcast(Intent)
2236 * @see #sendBroadcast(Intent, String)
2237 * @see #sendOrderedBroadcast(Intent, String)
2238 * @see android.content.BroadcastReceiver
2239 * @see #registerReceiver
2240 * @see android.app.Activity#RESULT_OK
2241 * @hide
2242 */
2243 @SystemApi
2244 public abstract void sendOrderedBroadcast(@NonNull Intent intent,
2245 @Nullable String receiverPermission, @Nullable Bundle options,
2246 @Nullable BroadcastReceiver resultReceiver, @Nullable Handler scheduler,
2247 int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
2248
2249 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002250 * Like {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler,
2251 * int, String, android.os.Bundle)}, but also allows specification
Tor Norbyed9273d62013-05-30 15:59:53 -07002252 * of an associated app op as per {@link android.app.AppOpsManager}.
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002253 * @hide
2254 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002255 @UnsupportedAppUsage
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002256 public abstract void sendOrderedBroadcast(Intent intent,
2257 String receiverPermission, int appOp, BroadcastReceiver resultReceiver,
2258 Handler scheduler, int initialCode, String initialData,
2259 Bundle initialExtras);
2260
2261 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002262 * Version of {@link #sendBroadcast(Intent)} that allows you to specify the
2263 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002264 * that are not pre-installed on the system image.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002265 * @param intent The intent to broadcast
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07002266 * @param user UserHandle to send the intent to.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002267 * @see #sendBroadcast(Intent)
2268 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002269 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002270 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2271 UserHandle user);
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002272
2273 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002274 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the
2275 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002276 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002277 *
2278 * @param intent The Intent to broadcast; all receivers matching this
2279 * Intent will receive the broadcast.
2280 * @param user UserHandle to send the intent to.
2281 * @param receiverPermission (optional) String naming a permission that
2282 * a receiver must hold in order to receive your broadcast.
2283 * If null, no permission is required.
2284 *
2285 * @see #sendBroadcast(Intent, String)
2286 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002287 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002288 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2289 UserHandle user, @Nullable String receiverPermission);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002290
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002291 /**
2292 * Version of {@link #sendBroadcast(Intent, String, Bundle)} that allows you to specify the
2293 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002294 * that are not pre-installed on the system image.
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002295 *
2296 * @param intent The Intent to broadcast; all receivers matching this
2297 * Intent will receive the broadcast.
2298 * @param user UserHandle to send the intent to.
2299 * @param receiverPermission (optional) String naming a permission that
2300 * a receiver must hold in order to receive your broadcast.
2301 * If null, no permission is required.
2302 * @param options (optional) Additional sending options, generated from a
2303 * {@link android.app.BroadcastOptions}.
2304 *
2305 * @see #sendBroadcast(Intent, String, Bundle)
2306 * @hide
2307 */
2308 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002309 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002310 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2311 UserHandle user, @Nullable String receiverPermission, @Nullable Bundle options);
Svet Ganov16a16892015-04-16 10:32:04 -07002312
2313 /**
2314 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the
2315 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002316 * that are not pre-installed on the system image.
Svet Ganov16a16892015-04-16 10:32:04 -07002317 *
2318 * @param intent The Intent to broadcast; all receivers matching this
2319 * Intent will receive the broadcast.
2320 * @param user UserHandle to send the intent to.
2321 * @param receiverPermission (optional) String naming a permission that
2322 * a receiver must hold in order to receive your broadcast.
2323 * If null, no permission is required.
2324 * @param appOp The app op associated with the broadcast.
2325 *
2326 * @see #sendBroadcast(Intent, String)
2327 *
2328 * @hide
2329 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002330 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002331 @UnsupportedAppUsage
Tor Norbye788fc2b2015-07-05 16:10:42 -07002332 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2333 UserHandle user, @Nullable String receiverPermission, int appOp);
Svet Ganov16a16892015-04-16 10:32:04 -07002334
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002335 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002336 * Version of
2337 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)}
2338 * that allows you to specify the
2339 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002340 * that are not pre-installed on the system image.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002341 *
2342 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2343 *
2344 * @param intent The Intent to broadcast; all receivers matching this
2345 * Intent will receive the broadcast.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07002346 * @param user UserHandle to send the intent to.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002347 * @param receiverPermission String naming a permissions that
2348 * a receiver must hold in order to receive your broadcast.
2349 * If null, no permission is required.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002350 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2351 * receiver of the broadcast.
2352 * @param scheduler A custom Handler with which to schedule the
2353 * resultReceiver callback; if null it will be
2354 * scheduled in the Context's main thread.
2355 * @param initialCode An initial value for the result code. Often
2356 * Activity.RESULT_OK.
2357 * @param initialData An initial value for the result data. Often
2358 * null.
2359 * @param initialExtras An initial value for the result extras. Often
2360 * null.
2361 *
2362 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2363 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002364 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002365 public abstract void sendOrderedBroadcastAsUser(@RequiresPermission Intent intent,
2366 UserHandle user, @Nullable String receiverPermission, BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002367 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2368 @Nullable Bundle initialExtras);
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002369
2370 /**
Amith Yamasani3cf75722014-05-16 12:37:29 -07002371 * Similar to above but takes an appOp as well, to enforce restrictions.
2372 * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String,
2373 * BroadcastReceiver, Handler, int, String, Bundle)
2374 * @hide
2375 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002376 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002377 @UnsupportedAppUsage
Amith Yamasani3cf75722014-05-16 12:37:29 -07002378 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user,
2379 @Nullable String receiverPermission, int appOp, BroadcastReceiver resultReceiver,
2380 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2381 @Nullable Bundle initialExtras);
2382
2383 /**
Dianne Hackbornfd854ee2015-07-13 18:00:37 -07002384 * Similar to above but takes an appOp as well, to enforce restrictions, and an options Bundle.
2385 * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String,
2386 * BroadcastReceiver, Handler, int, String, Bundle)
2387 * @hide
2388 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002389 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002390 @UnsupportedAppUsage
Dianne Hackbornfd854ee2015-07-13 18:00:37 -07002391 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user,
2392 @Nullable String receiverPermission, int appOp, @Nullable Bundle options,
2393 BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode,
2394 @Nullable String initialData, @Nullable Bundle initialExtras);
2395
2396 /**
Jordan Liua32e6fc2019-10-29 10:33:55 -07002397 * Version of
2398 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String,
2399 * Bundle)} that allows you to specify the App Op to enforce restrictions on which receivers
2400 * the broadcast will be sent to.
2401 *
2402 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2403 *
2404 * @param intent The Intent to broadcast; all receivers matching this
2405 * Intent will receive the broadcast.
2406 * @param receiverPermission String naming a permissions that
2407 * a receiver must hold in order to receive your broadcast.
2408 * If null, no permission is required.
2409 * @param receiverAppOp The app op associated with the broadcast. If null, no appOp is
2410 * required. If both receiverAppOp and receiverPermission are non-null,
2411 * a receiver must have both of them to
2412 * receive the broadcast
2413 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2414 * receiver of the broadcast.
2415 * @param scheduler A custom Handler with which to schedule the
2416 * resultReceiver callback; if null it will be
2417 * scheduled in the Context's main thread.
2418 * @param initialCode An initial value for the result code. Often
2419 * Activity.RESULT_OK.
2420 * @param initialData An initial value for the result data. Often
2421 * null.
2422 * @param initialExtras An initial value for the result extras. Often
2423 * null.
2424 *
2425 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2426 */
Jordan Liu31a4da62019-11-19 11:36:34 -08002427 public void sendOrderedBroadcast(@NonNull Intent intent, @Nullable String receiverPermission,
2428 @Nullable String receiverAppOp, @Nullable BroadcastReceiver resultReceiver,
2429 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2430 @Nullable Bundle initialExtras) {
Jordan Liua32e6fc2019-10-29 10:33:55 -07002431 throw new RuntimeException("Not implemented. Must override in a subclass.");
2432 }
2433
2434 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002435 * <p>Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002436 * Intent you are sending stays around after the broadcast is complete,
2437 * so that others can quickly retrieve that data through the return
2438 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In
2439 * all other ways, this behaves the same as
2440 * {@link #sendBroadcast(Intent)}.
2441 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002442 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2443 * can access them), no protection (anyone can modify them), and many other problems.
2444 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2445 * has changed, with another mechanism for apps to retrieve the current value whenever
2446 * desired.
2447 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002448 * @param intent The Intent to broadcast; all receivers matching this
2449 * Intent will receive the broadcast, and the Intent will be held to
2450 * be re-broadcast to future receivers.
2451 *
2452 * @see #sendBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002453 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002454 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002455 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002456 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002457 public abstract void sendStickyBroadcast(@RequiresPermission Intent intent);
Scott Main4b5da682010-10-21 11:49:12 -07002458
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002459 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002460 * <p>Version of {@link #sendStickyBroadcast} that allows you to
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002461 * receive data back from the broadcast. This is accomplished by
2462 * supplying your own BroadcastReceiver when calling, which will be
2463 * treated as a final receiver at the end of the broadcast -- its
2464 * {@link BroadcastReceiver#onReceive} method will be called with
2465 * the result values collected from the other receivers. The broadcast will
2466 * be serialized in the same way as calling
2467 * {@link #sendOrderedBroadcast(Intent, String)}.
2468 *
2469 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2470 * asynchronous; it will return before
2471 * resultReceiver.onReceive() is called. Note that the sticky data
2472 * stored is only the data you initially supply to the broadcast, not
2473 * the result of any changes made by the receivers.
2474 *
2475 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2476 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002477 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2478 * can access them), no protection (anyone can modify them), and many other problems.
2479 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2480 * has changed, with another mechanism for apps to retrieve the current value whenever
2481 * desired.
2482 *
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002483 * @param intent The Intent to broadcast; all receivers matching this
2484 * Intent will receive the broadcast.
2485 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2486 * receiver of the broadcast.
2487 * @param scheduler A custom Handler with which to schedule the
2488 * resultReceiver callback; if null it will be
2489 * scheduled in the Context's main thread.
2490 * @param initialCode An initial value for the result code. Often
2491 * Activity.RESULT_OK.
2492 * @param initialData An initial value for the result data. Often
2493 * null.
2494 * @param initialExtras An initial value for the result extras. Often
2495 * null.
2496 *
2497 * @see #sendBroadcast(Intent)
2498 * @see #sendBroadcast(Intent, String)
2499 * @see #sendOrderedBroadcast(Intent, String)
2500 * @see #sendStickyBroadcast(Intent)
2501 * @see android.content.BroadcastReceiver
2502 * @see #registerReceiver
2503 * @see android.app.Activity#RESULT_OK
2504 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002505 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002506 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002507 public abstract void sendStickyOrderedBroadcast(@RequiresPermission Intent intent,
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002508 BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002509 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2510 @Nullable Bundle initialExtras);
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002511
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002512 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002513 * <p>Remove the data previously sent with {@link #sendStickyBroadcast},
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002514 * so that it is as if the sticky broadcast had never happened.
2515 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002516 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2517 * can access them), no protection (anyone can modify them), and many other problems.
2518 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2519 * has changed, with another mechanism for apps to retrieve the current value whenever
2520 * desired.
2521 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002522 * @param intent The Intent that was previously broadcast.
2523 *
2524 * @see #sendStickyBroadcast
2525 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002526 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002527 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002528 public abstract void removeStickyBroadcast(@RequiresPermission Intent intent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002529
2530 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002531 * <p>Version of {@link #sendStickyBroadcast(Intent)} that allows you to specify the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002532 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002533 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002534 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002535 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2536 * can access them), no protection (anyone can modify them), and many other problems.
2537 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2538 * has changed, with another mechanism for apps to retrieve the current value whenever
2539 * desired.
2540 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002541 * @param intent The Intent to broadcast; all receivers matching this
2542 * Intent will receive the broadcast, and the Intent will be held to
2543 * be re-broadcast to future receivers.
2544 * @param user UserHandle to send the intent to.
2545 *
2546 * @see #sendBroadcast(Intent)
2547 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002548 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002549 @RequiresPermission(allOf = {
2550 android.Manifest.permission.INTERACT_ACROSS_USERS,
2551 android.Manifest.permission.BROADCAST_STICKY
2552 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002553 public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent,
2554 UserHandle user);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002555
2556 /**
Dianne Hackborne0e413e2015-12-09 17:22:26 -08002557 * @hide
2558 * This is just here for sending CONNECTIVITY_ACTION.
2559 */
2560 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002561 @RequiresPermission(allOf = {
2562 android.Manifest.permission.INTERACT_ACROSS_USERS,
2563 android.Manifest.permission.BROADCAST_STICKY
2564 })
Dianne Hackborne0e413e2015-12-09 17:22:26 -08002565 public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent,
2566 UserHandle user, Bundle options);
2567
2568 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002569 * <p>Version of
Dianne Hackborn8832c182012-09-17 17:20:24 -07002570 * {@link #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)}
2571 * that allows you to specify the
2572 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002573 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002574 *
2575 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2576 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002577 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2578 * can access them), no protection (anyone can modify them), and many other problems.
2579 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2580 * has changed, with another mechanism for apps to retrieve the current value whenever
2581 * desired.
2582 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002583 * @param intent The Intent to broadcast; all receivers matching this
2584 * Intent will receive the broadcast.
2585 * @param user UserHandle to send the intent to.
2586 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2587 * receiver of the broadcast.
2588 * @param scheduler A custom Handler with which to schedule the
2589 * resultReceiver callback; if null it will be
2590 * scheduled in the Context's main thread.
2591 * @param initialCode An initial value for the result code. Often
2592 * Activity.RESULT_OK.
2593 * @param initialData An initial value for the result data. Often
2594 * null.
2595 * @param initialExtras An initial value for the result extras. Often
2596 * null.
2597 *
2598 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
2599 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002600 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002601 @RequiresPermission(allOf = {
2602 android.Manifest.permission.INTERACT_ACROSS_USERS,
2603 android.Manifest.permission.BROADCAST_STICKY
2604 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002605 public abstract void sendStickyOrderedBroadcastAsUser(@RequiresPermission Intent intent,
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002606 UserHandle user, BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002607 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2608 @Nullable Bundle initialExtras);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002609
2610 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002611 * <p>Version of {@link #removeStickyBroadcast(Intent)} that allows you to specify the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002612 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002613 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002614 *
2615 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
2616 * permission in order to use this API. If you do not hold that
2617 * permission, {@link SecurityException} will be thrown.
2618 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002619 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2620 * can access them), no protection (anyone can modify them), and many other problems.
2621 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2622 * has changed, with another mechanism for apps to retrieve the current value whenever
2623 * desired.
2624 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002625 * @param intent The Intent that was previously broadcast.
2626 * @param user UserHandle to remove the sticky broadcast from.
2627 *
2628 * @see #sendStickyBroadcastAsUser
2629 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002630 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002631 @RequiresPermission(allOf = {
2632 android.Manifest.permission.INTERACT_ACROSS_USERS,
2633 android.Manifest.permission.BROADCAST_STICKY
2634 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002635 public abstract void removeStickyBroadcastAsUser(@RequiresPermission Intent intent,
2636 UserHandle user);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002637
2638 /**
Chris Tatea34df8a22009-04-02 23:15:58 -07002639 * Register a BroadcastReceiver to be run in the main activity thread. The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002640 * <var>receiver</var> will be called with any broadcast Intent that
2641 * matches <var>filter</var>, in the main application thread.
2642 *
2643 * <p>The system may broadcast Intents that are "sticky" -- these stay
Kweku Adams86f39a42016-11-16 12:50:38 -08002644 * around after the broadcast has finished, to be sent to any later
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002645 * registrations. If your IntentFilter matches one of these sticky
2646 * Intents, that Intent will be returned by this function
2647 * <strong>and</strong> sent to your <var>receiver</var> as if it had just
2648 * been broadcast.
2649 *
2650 * <p>There may be multiple sticky Intents that match <var>filter</var>,
2651 * in which case each of these will be sent to <var>receiver</var>. In
2652 * this case, only one of these can be returned directly by the function;
2653 * which of these that is returned is arbitrarily decided by the system.
2654 *
2655 * <p>If you know the Intent your are registering for is sticky, you can
2656 * supply null for your <var>receiver</var>. In this case, no receiver is
2657 * registered -- the function simply returns the sticky Intent that
2658 * matches <var>filter</var>. In the case of multiple matches, the same
2659 * rules as described above apply.
2660 *
2661 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2662 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07002663 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2664 * registered with this method will correctly respect the
2665 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2666 * Prior to that, it would be ignored and delivered to all matching registered
2667 * receivers. Be careful if using this for security.</p>
2668 *
Chris Tatea34df8a22009-04-02 23:15:58 -07002669 * <p class="note">Note: this method <em>cannot be called from a
2670 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver
2671 * that is declared in an application's manifest. It is okay, however, to call
2672 * this method from another BroadcastReceiver that has itself been registered
2673 * at run time with {@link #registerReceiver}, since the lifetime of such a
2674 * registered BroadcastReceiver is tied to the object that registered it.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002675 *
2676 * @param receiver The BroadcastReceiver to handle the broadcast.
2677 * @param filter Selects the Intent broadcasts to be received.
2678 *
2679 * @return The first sticky intent found that matches <var>filter</var>,
2680 * or null if there are none.
2681 *
2682 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2683 * @see #sendBroadcast
2684 * @see #unregisterReceiver
2685 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002686 @Nullable
2687 public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002688 IntentFilter filter);
2689
2690 /**
Chad Brubaker816c83b2017-03-02 10:27:59 -08002691 * Register to receive intent broadcasts, with the receiver optionally being
2692 * exposed to Instant Apps. See
2693 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
2694 * information. By default Instant Apps cannot interact with receivers in other
2695 * applications, this allows you to expose a receiver that Instant Apps can
2696 * interact with.
2697 *
2698 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2699 *
2700 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2701 * registered with this method will correctly respect the
2702 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2703 * Prior to that, it would be ignored and delivered to all matching registered
2704 * receivers. Be careful if using this for security.</p>
2705 *
2706 * @param receiver The BroadcastReceiver to handle the broadcast.
2707 * @param filter Selects the Intent broadcasts to be received.
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002708 * @param flags Additional options for the receiver. May be 0 or
2709 * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}.
Chad Brubaker816c83b2017-03-02 10:27:59 -08002710 *
2711 * @return The first sticky intent found that matches <var>filter</var>,
2712 * or null if there are none.
2713 *
2714 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
2715 * @see #sendBroadcast
2716 * @see #unregisterReceiver
2717 */
2718 @Nullable
2719 public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver,
2720 IntentFilter filter,
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002721 @RegisterReceiverFlags int flags);
Chad Brubaker816c83b2017-03-02 10:27:59 -08002722
2723 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002724 * Register to receive intent broadcasts, to run in the context of
2725 * <var>scheduler</var>. See
2726 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
2727 * information. This allows you to enforce permissions on who can
2728 * broadcast intents to your receiver, or have the receiver run in
2729 * a different thread than the main application thread.
2730 *
2731 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2732 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07002733 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2734 * registered with this method will correctly respect the
2735 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2736 * Prior to that, it would be ignored and delivered to all matching registered
2737 * receivers. Be careful if using this for security.</p>
2738 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002739 * @param receiver The BroadcastReceiver to handle the broadcast.
2740 * @param filter Selects the Intent broadcasts to be received.
2741 * @param broadcastPermission String naming a permissions that a
2742 * broadcaster must hold in order to send an Intent to you. If null,
2743 * no permission is required.
2744 * @param scheduler Handler identifying the thread that will receive
2745 * the Intent. If null, the main thread of the process will be used.
2746 *
2747 * @return The first sticky intent found that matches <var>filter</var>,
2748 * or null if there are none.
2749 *
2750 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
2751 * @see #sendBroadcast
2752 * @see #unregisterReceiver
2753 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002754 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002755 public abstract Intent registerReceiver(BroadcastReceiver receiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002756 IntentFilter filter, @Nullable String broadcastPermission,
2757 @Nullable Handler scheduler);
Dianne Hackborn20e80982012-08-31 19:00:44 -07002758
2759 /**
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002760 * Register to receive intent broadcasts, to run in the context of
2761 * <var>scheduler</var>. See
2762 * {@link #registerReceiver(BroadcastReceiver, IntentFilter, int)} and
Chad Brubaker816c83b2017-03-02 10:27:59 -08002763 * {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)}
2764 * for more information.
2765 *
2766 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2767 *
2768 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2769 * registered with this method will correctly respect the
2770 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2771 * Prior to that, it would be ignored and delivered to all matching registered
2772 * receivers. Be careful if using this for security.</p>
2773 *
2774 * @param receiver The BroadcastReceiver to handle the broadcast.
2775 * @param filter Selects the Intent broadcasts to be received.
2776 * @param broadcastPermission String naming a permissions that a
2777 * broadcaster must hold in order to send an Intent to you. If null,
2778 * no permission is required.
2779 * @param scheduler Handler identifying the thread that will receive
2780 * the Intent. If null, the main thread of the process will be used.
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002781 * @param flags Additional options for the receiver. May be 0 or
2782 * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}.
Chad Brubaker816c83b2017-03-02 10:27:59 -08002783 *
2784 * @return The first sticky intent found that matches <var>filter</var>,
2785 * or null if there are none.
2786 *
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002787 * @see #registerReceiver(BroadcastReceiver, IntentFilter, int)
Chad Brubaker816c83b2017-03-02 10:27:59 -08002788 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2789 * @see #sendBroadcast
2790 * @see #unregisterReceiver
2791 */
2792 @Nullable
2793 public abstract Intent registerReceiver(BroadcastReceiver receiver,
2794 IntentFilter filter, @Nullable String broadcastPermission,
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002795 @Nullable Handler scheduler, @RegisterReceiverFlags int flags);
Chad Brubaker816c83b2017-03-02 10:27:59 -08002796
2797 /**
Meng Wange3bd3ba2019-11-05 10:43:45 -08002798 * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)}
2799 * but this receiver will receive broadcasts that are sent to all users. The receiver can
2800 * use {@link BroadcastReceiver#getSendingUser} to determine on which user the broadcast
2801 * was sent.
2802 *
2803 * @param receiver The BroadcastReceiver to handle the broadcast.
2804 * @param filter Selects the Intent broadcasts to be received.
2805 * @param broadcastPermission String naming a permissions that a
2806 * broadcaster must hold in order to send an Intent to you. If {@code null},
2807 * no permission is required.
2808 * @param scheduler Handler identifying the thread that will receive
2809 * the Intent. If {@code null}, the main thread of the process will be used.
2810 *
2811 * @return The first sticky intent found that matches <var>filter</var>,
2812 * or {@code null} if there are none.
2813 *
2814 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2815 * @see #sendBroadcast
2816 * @see #unregisterReceiver
2817 * @hide
2818 */
2819 @Nullable
2820 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
2821 @SystemApi
2822 public Intent registerReceiverForAllUsers(@Nullable BroadcastReceiver receiver,
2823 @NonNull IntentFilter filter, @Nullable String broadcastPermission,
2824 @Nullable Handler scheduler) {
2825 throw new RuntimeException("Not implemented. Must override in a subclass.");
2826 }
2827
2828 /**
Dianne Hackborn20e80982012-08-31 19:00:44 -07002829 * @hide
2830 * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2831 * but for a specific user. This receiver will receiver broadcasts that
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002832 * are sent to the requested user.
Dianne Hackborn20e80982012-08-31 19:00:44 -07002833 *
2834 * @param receiver The BroadcastReceiver to handle the broadcast.
2835 * @param user UserHandle to send the intent to.
2836 * @param filter Selects the Intent broadcasts to be received.
2837 * @param broadcastPermission String naming a permissions that a
2838 * broadcaster must hold in order to send an Intent to you. If null,
2839 * no permission is required.
2840 * @param scheduler Handler identifying the thread that will receive
2841 * the Intent. If null, the main thread of the process will be used.
2842 *
2843 * @return The first sticky intent found that matches <var>filter</var>,
2844 * or null if there are none.
2845 *
Jeff Brown6e539312015-02-24 18:53:21 -08002846 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
Dianne Hackborn20e80982012-08-31 19:00:44 -07002847 * @see #sendBroadcast
2848 * @see #unregisterReceiver
2849 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002850 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002851 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002852 @UnsupportedAppUsage
Dianne Hackborn20e80982012-08-31 19:00:44 -07002853 public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002854 UserHandle user, IntentFilter filter, @Nullable String broadcastPermission,
2855 @Nullable Handler scheduler);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002856
2857 /**
2858 * Unregister a previously registered BroadcastReceiver. <em>All</em>
2859 * filters that have been registered for this BroadcastReceiver will be
2860 * removed.
2861 *
2862 * @param receiver The BroadcastReceiver to unregister.
2863 *
2864 * @see #registerReceiver
2865 */
2866 public abstract void unregisterReceiver(BroadcastReceiver receiver);
2867
2868 /**
2869 * Request that a given application service be started. The Intent
Hans Boehmfb9f6ac2016-05-05 13:09:28 -07002870 * should either contain the complete class name of a specific service
2871 * implementation to start, or a specific package name to target. If the
2872 * Intent is less specified, it logs a warning about this. In this case any of the
2873 * multiple matching services may be used. If this service
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874 * is not already running, it will be instantiated and started (creating a
2875 * process for it if needed); if it is running then it remains running.
2876 *
2877 * <p>Every call to this method will result in a corresponding call to
Scott Main4b5da682010-10-21 11:49:12 -07002878 * the target service's {@link android.app.Service#onStartCommand} method,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002879 * with the <var>intent</var> given here. This provides a convenient way
2880 * to submit jobs to a service without having to bind and call on to its
2881 * interface.
2882 *
2883 * <p>Using startService() overrides the default service lifetime that is
2884 * managed by {@link #bindService}: it requires the service to remain
2885 * running until {@link #stopService} is called, regardless of whether
2886 * any clients are connected to it. Note that calls to startService()
Hans Boehmfb9f6ac2016-05-05 13:09:28 -07002887 * do not nest: no matter how many times you call startService(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002888 * a single call to {@link #stopService} will stop it.
2889 *
2890 * <p>The system attempts to keep running services around as much as
2891 * possible. The only time they should be stopped is if the current
2892 * foreground application is using so many resources that the service needs
2893 * to be killed. If any errors happen in the service's process, it will
2894 * automatically be restarted.
2895 *
2896 * <p>This function will throw {@link SecurityException} if you do not
2897 * have permission to start the given service.
2898 *
Chris Craik1e353522016-04-18 10:20:50 -07002899 * <p class="note"><strong>Note:</strong> Each call to startService()
2900 * results in significant work done by the system to manage service
2901 * lifecycle surrounding the processing of the intent, which can take
2902 * multiple milliseconds of CPU time. Due to this cost, startService()
2903 * should not be used for frequent intent delivery to a service, and only
2904 * for scheduling significant work. Use {@link #bindService bound services}
2905 * for high frequency calls.
2906 * </p>
2907 *
Mark Lu94ebbe02016-12-13 16:29:51 -08002908 * @param service Identifies the service to be started. The Intent must be
2909 * fully explicit (supplying a component name). Additional values
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002910 * may be included in the Intent extras to supply arguments along with
2911 * this specific start call.
2912 *
2913 * @return If the service is being started or is already running, the
2914 * {@link ComponentName} of the actual service that was started is
2915 * returned; else if the service does not exist null is returned.
2916 *
Christopher Tate08992ac2017-03-21 11:37:06 -07002917 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08002918 * or the service can not be found.
2919 * @throws IllegalStateException If the application is in a state where the service
2920 * can not be started (such as not in the foreground in a state when services are allowed).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002921 *
2922 * @see #stopService
2923 * @see #bindService
2924 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002925 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002926 public abstract ComponentName startService(Intent service);
2927
2928 /**
Christopher Tate08992ac2017-03-21 11:37:06 -07002929 * Similar to {@link #startService(Intent)}, but with an implicit promise that the
Neil Fullerfe6ec562017-03-16 18:29:36 +00002930 * Service will call {@link android.app.Service#startForeground(int, android.app.Notification)
2931 * startForeground(int, android.app.Notification)} once it begins running. The service is given
Christopher Tate08992ac2017-03-21 11:37:06 -07002932 * an amount of time comparable to the ANR interval to do this, otherwise the system
2933 * will automatically stop the service and declare the app ANR.
2934 *
2935 * <p>Unlike the ordinary {@link #startService(Intent)}, this method can be used
2936 * at any time, regardless of whether the app hosting the service is in a foreground
2937 * state.
2938 *
2939 * @param service Identifies the service to be started. The Intent must be
2940 * fully explicit (supplying a component name). Additional values
2941 * may be included in the Intent extras to supply arguments along with
2942 * this specific start call.
2943 *
2944 * @return If the service is being started or is already running, the
2945 * {@link ComponentName} of the actual service that was started is
2946 * returned; else if the service does not exist null is returned.
2947 *
2948 * @throws SecurityException If the caller does not have permission to access the service
2949 * or the service can not be found.
2950 *
2951 * @see #stopService
Neil Fullerfe6ec562017-03-16 18:29:36 +00002952 * @see android.app.Service#startForeground(int, android.app.Notification)
Christopher Tate08992ac2017-03-21 11:37:06 -07002953 */
2954 @Nullable
2955 public abstract ComponentName startForegroundService(Intent service);
2956
2957 /**
2958 * @hide like {@link #startForegroundService(Intent)} but for a specific user.
2959 */
2960 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002961 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Christopher Tate08992ac2017-03-21 11:37:06 -07002962 public abstract ComponentName startForegroundServiceAsUser(Intent service, UserHandle user);
2963
2964 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002965 * Request that a given application service be stopped. If the service is
2966 * not running, nothing happens. Otherwise it is stopped. Note that calls
2967 * to startService() are not counted -- this stops the service no matter
2968 * how many times it was started.
2969 *
2970 * <p>Note that if a stopped service still has {@link ServiceConnection}
2971 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will
2972 * not be destroyed until all of these bindings are removed. See
2973 * the {@link android.app.Service} documentation for more details on a
2974 * service's lifecycle.
2975 *
2976 * <p>This function will throw {@link SecurityException} if you do not
2977 * have permission to stop the given service.
2978 *
Dianne Hackborn221ea892013-08-04 16:50:16 -07002979 * @param service Description of the service to be stopped. The Intent must be either
2980 * fully explicit (supplying a component name) or specify a specific package
kopriva219f7dc2018-10-09 13:42:28 -07002981 * name it is targeted to.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002982 *
2983 * @return If there is a service matching the given Intent that is already
John Spurlock6098c5d2013-06-17 10:32:46 -04002984 * running, then it is stopped and {@code true} is returned; else {@code false} is returned.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002985 *
Christopher Tate08992ac2017-03-21 11:37:06 -07002986 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08002987 * or the service can not be found.
2988 * @throws IllegalStateException If the application is in a state where the service
2989 * can not be started (such as not in the foreground in a state when services are allowed).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002990 *
2991 * @see #startService
2992 */
2993 public abstract boolean stopService(Intent service);
2994
2995 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002996 * @hide like {@link #startService(Intent)} but for a specific user.
2997 */
Christopher Tate42a386b2016-11-07 12:21:21 -08002998 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002999 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003000 @UnsupportedAppUsage
Dianne Hackborn7767eac2012-08-23 18:25:40 -07003001 public abstract ComponentName startServiceAsUser(Intent service, UserHandle user);
3002
3003 /**
3004 * @hide like {@link #stopService(Intent)} but for a specific user.
3005 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06003006 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Dianne Hackborn7767eac2012-08-23 18:25:40 -07003007 public abstract boolean stopServiceAsUser(Intent service, UserHandle user);
RoboErik01fe6612014-02-13 14:19:04 -08003008
Dianne Hackborn7767eac2012-08-23 18:25:40 -07003009 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003010 * Connect to an application service, creating it if needed. This defines
3011 * a dependency between your application and the service. The given
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003012 * <var>conn</var> will receive the service object when it is created and be
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003013 * told if it dies and restarts. The service will be considered required
3014 * by the system only for as long as the calling context exists. For
3015 * example, if this Context is an Activity that is stopped, the service will
3016 * not be required to continue running until the Activity is resumed.
3017 *
Christopher Tate5d73b6d2017-10-06 16:15:34 -07003018 * <p>If the service does not support binding, it may return {@code null} from
3019 * its {@link android.app.Service#onBind(Intent) onBind()} method. If it does, then
3020 * the ServiceConnection's
3021 * {@link ServiceConnection#onNullBinding(ComponentName) onNullBinding()} method
3022 * will be invoked instead of
3023 * {@link ServiceConnection#onServiceConnected(ComponentName, IBinder) onServiceConnected()}.
3024 *
3025 * <p>This method will throw {@link SecurityException} if the calling app does not
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003026 * have permission to bind to the given service.
3027 *
Christopher Tate5d73b6d2017-10-06 16:15:34 -07003028 * <p class="note">Note: this method <em>cannot be called from a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003029 * {@link BroadcastReceiver} component</em>. A pattern you can use to
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003030 * communicate from a BroadcastReceiver to a Service is to call
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003031 * {@link #startService} with the arguments containing the command to be
3032 * sent, with the service calling its
3033 * {@link android.app.Service#stopSelf(int)} method when done executing
3034 * that command. See the API demo App/Service/Service Start Arguments
3035 * Controller for an illustration of this. It is okay, however, to use
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003036 * this method from a BroadcastReceiver that has been registered with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003037 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver
3038 * is tied to another object (the one that registered it).</p>
3039 *
Mark Lu94ebbe02016-12-13 16:29:51 -08003040 * @param service Identifies the service to connect to. The Intent must
3041 * specify an explicit component name.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003042 * @param conn Receives information as the service is started and stopped.
Christopher Tate79b33172012-06-18 14:54:21 -07003043 * This must be a valid ServiceConnection object; it must not be null.
Scott Main4b5da682010-10-21 11:49:12 -07003044 * @param flags Operation options for the binding. May be 0,
Dianne Hackbornc68c9132011-07-29 01:25:18 -07003045 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND},
3046 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT},
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003047 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, {@link #BIND_WAIVE_PRIORITY}.
3048 * {@link #BIND_IMPORTANT}, or
3049 * {@link #BIND_ADJUST_WITH_ACTIVITY}.
Kevin Hufnagle34acbc9b2017-06-29 15:58:48 -07003050 * @return {@code true} if the system is in the process of bringing up a
3051 * service that your client has permission to bind to; {@code false}
3052 * if the system couldn't find the service or if your client doesn't
3053 * have permission to bind to it. If this value is {@code true}, you
3054 * should later call {@link #unbindService} to release the
3055 * connection.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003056 *
Christopher Tate08992ac2017-03-21 11:37:06 -07003057 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08003058 * or the service can not be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003059 *
3060 * @see #unbindService
3061 * @see #startService
3062 * @see #BIND_AUTO_CREATE
Scott Main4b5da682010-10-21 11:49:12 -07003063 * @see #BIND_DEBUG_UNBIND
3064 * @see #BIND_NOT_FOREGROUND
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003065 * @see #BIND_ABOVE_CLIENT
3066 * @see #BIND_ALLOW_OOM_MANAGEMENT
3067 * @see #BIND_WAIVE_PRIORITY
3068 * @see #BIND_IMPORTANT
3069 * @see #BIND_ADJUST_WITH_ACTIVITY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003070 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07003071 public abstract boolean bindService(@RequiresPermission Intent service,
3072 @NonNull ServiceConnection conn, @BindServiceFlags int flags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003073
3074 /**
Bo Liu58a57662019-03-06 20:21:45 +00003075 * Same as {@link #bindService(Intent, ServiceConnection, int)} with executor to control
3076 * ServiceConnection callbacks.
3077 * @param executor Callbacks on ServiceConnection will be called on executor. Must use same
3078 * instance for the same instance of ServiceConnection.
3079 */
3080 public boolean bindService(@RequiresPermission @NonNull Intent service,
3081 @BindServiceFlags int flags, @NonNull @CallbackExecutor Executor executor,
3082 @NonNull ServiceConnection conn) {
3083 throw new RuntimeException("Not implemented. Must override in a subclass.");
3084 }
3085
3086 /**
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003087 * Variation of {@link #bindService} that, in the specific case of isolated
3088 * services, allows the caller to generate multiple instances of a service
Dianne Hackborncc67f962019-04-29 16:32:44 -07003089 * from a single component declaration. In other words, you can use this to bind
3090 * to a service that has specified {@link android.R.attr#isolatedProcess} and, in
3091 * addition to the existing behavior of running in an isolated process, you can
3092 * also through the arguments here have the system bring up multiple concurrent
3093 * processes hosting their own instances of that service. The <var>instanceName</var>
3094 * you provide here identifies the different instances, and you can use
3095 * {@link #updateServiceGroup(ServiceConnection, int, int)} to tell the system how it
3096 * should manage each of these instances.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003097 *
3098 * @param service Identifies the service to connect to. The Intent must
3099 * specify an explicit component name.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003100 * @param flags Operation options for the binding as per {@link #bindService}.
3101 * @param instanceName Unique identifier for the service instance. Each unique
Robert Seseke3a5bc62019-04-22 17:43:03 -04003102 * name here will result in a different service instance being created. Identifiers
3103 * must only contain ASCII letters, digits, underscores, and periods.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003104 * @return Returns success of binding as per {@link #bindService}.
Bo Liu58a57662019-03-06 20:21:45 +00003105 * @param executor Callbacks on ServiceConnection will be called on executor.
3106 * Must use same instance for the same instance of ServiceConnection.
3107 * @param conn Receives information as the service is started and stopped.
3108 * This must be a valid ServiceConnection object; it must not be null.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003109 *
3110 * @throws SecurityException If the caller does not have permission to access the service
Robert Seseke3a5bc62019-04-22 17:43:03 -04003111 * @throws IllegalArgumentException If the instanceName is invalid.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003112 *
3113 * @see #bindService
Dianne Hackborncc67f962019-04-29 16:32:44 -07003114 * @see #updateServiceGroup
3115 * @see android.R.attr#isolatedProcess
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003116 */
Adrian Roosebc927c2019-02-28 16:21:18 +01003117 public boolean bindIsolatedService(@RequiresPermission @NonNull Intent service,
Bo Liu58a57662019-03-06 20:21:45 +00003118 @BindServiceFlags int flags, @NonNull String instanceName,
3119 @NonNull @CallbackExecutor Executor executor, @NonNull ServiceConnection conn) {
Adrian Roosfe6aeaf2019-01-22 16:58:56 +01003120 throw new RuntimeException("Not implemented. Must override in a subclass.");
3121 }
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003122
3123 /**
Dianne Hackborn7d19e022012-08-07 19:12:33 -07003124 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle
Amith Yamasani37ce3a82012-02-06 12:04:42 -08003125 * argument for use by system server and other multi-user aware code.
3126 * @hide
3127 */
Amith Yamasanic85029f2014-09-11 16:47:17 -07003128 @SystemApi
Jeff Brown6e539312015-02-24 18:53:21 -08003129 @SuppressWarnings("unused")
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06003130 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07003131 public boolean bindServiceAsUser(@RequiresPermission Intent service, ServiceConnection conn,
Jeff Brown6e539312015-02-24 18:53:21 -08003132 int flags, UserHandle user) {
Amith Yamasani37ce3a82012-02-06 12:04:42 -08003133 throw new RuntimeException("Not implemented. Must override in a subclass.");
3134 }
3135
3136 /**
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003137 * Same as {@link #bindServiceAsUser(Intent, ServiceConnection, int, UserHandle)}, but with an
Adrian Roos691546e2016-02-09 10:13:41 -08003138 * explicit non-null Handler to run the ServiceConnection callbacks on.
3139 *
3140 * @hide
3141 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06003142 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood7bcc1742019-07-04 11:39:42 +01003143 @UnsupportedAppUsage(trackingBug = 136728678)
Adrian Roos691546e2016-02-09 10:13:41 -08003144 public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags,
3145 Handler handler, UserHandle user) {
3146 throw new RuntimeException("Not implemented. Must override in a subclass.");
3147 }
3148
3149 /**
Dianne Hackborna631d562018-11-20 15:58:15 -08003150 * For a service previously bound with {@link #bindService} or a related method, change
3151 * how the system manages that service's process in relation to other processes. This
3152 * doesn't modify the original bind flags that were passed in when binding, but adjusts
3153 * how the process will be managed in some cases based on those flags. Currently only
3154 * works on isolated processes (will be ignored for non-isolated processes).
3155 *
Dianne Hackborn2f55e5a2018-11-30 16:31:31 -08003156 * <p>Note that this call does not take immediate effect, but will be applied the next
3157 * time the impacted process is adjusted for some other reason. Typically you would
3158 * call this before then calling a new {@link #bindIsolatedService} on the service
3159 * of interest, with that binding causing the process to be shuffled accordingly.</p>
3160 *
Dianne Hackborna631d562018-11-20 15:58:15 -08003161 * @param conn The connection interface previously supplied to bindService(). This
3162 * parameter must not be null.
3163 * @param group A group to put this connection's process in. Upon calling here, this
3164 * will override any previous group that was set for that process. The group
3165 * tells the system about processes that are logically grouped together, so
3166 * should be managed as one unit of importance (such as when being considered
3167 * a recently used app). All processes in the same app with the same group
3168 * are considered to be related. Supplying 0 reverts to the default behavior
3169 * of not grouping.
3170 * @param importance Additional importance of the processes within a group. Upon calling
Dianne Hackborncc67f962019-04-29 16:32:44 -07003171 * here, this will override any previous importance that was set for that
3172 * process. The most important process is 0, and higher values are
3173 * successively less important. You can view this as describing how
3174 * to order the processes in an array, with the processes at the end of
3175 * the array being the least important. This value has no meaning besides
3176 * indicating how processes should be ordered in that array one after the
3177 * other. This provides a way to fine-tune the system's process killing,
3178 * guiding it to kill processes at the end of the array first.
3179 *
3180 * @see #bindIsolatedService
Dianne Hackborna631d562018-11-20 15:58:15 -08003181 */
Adrian Roosfe6aeaf2019-01-22 16:58:56 +01003182 public void updateServiceGroup(@NonNull ServiceConnection conn, int group,
3183 int importance) {
3184 throw new RuntimeException("Not implemented. Must override in a subclass.");
3185 }
Dianne Hackborna631d562018-11-20 15:58:15 -08003186
3187 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003188 * Disconnect from an application service. You will no longer receive
3189 * calls as the service is restarted, and the service is now allowed to
3190 * stop at any time.
3191 *
3192 * @param conn The connection interface previously supplied to
Christopher Tate79b33172012-06-18 14:54:21 -07003193 * bindService(). This parameter must not be null.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003194 *
3195 * @see #bindService
3196 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003197 public abstract void unbindService(@NonNull ServiceConnection conn);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003198
3199 /**
3200 * Start executing an {@link android.app.Instrumentation} class. The given
3201 * Instrumentation component will be run by killing its target application
3202 * (if currently running), starting the target process, instantiating the
3203 * instrumentation component, and then letting it drive the application.
3204 *
3205 * <p>This function is not synchronous -- it returns as soon as the
3206 * instrumentation has started and while it is running.
3207 *
3208 * <p>Instrumentation is normally only allowed to run against a package
3209 * that is either unsigned or signed with a signature that the
3210 * the instrumentation package is also signed with (ensuring the target
3211 * trusts the instrumentation).
3212 *
3213 * @param className Name of the Instrumentation component to be run.
3214 * @param profileFile Optional path to write profiling data as the
3215 * instrumentation runs, or null for no profiling.
3216 * @param arguments Additional optional arguments to pass to the
3217 * instrumentation, or null.
3218 *
John Spurlock6098c5d2013-06-17 10:32:46 -04003219 * @return {@code true} if the instrumentation was successfully started,
3220 * else {@code false} if it could not be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003221 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003222 public abstract boolean startInstrumentation(@NonNull ComponentName className,
3223 @Nullable String profileFile, @Nullable Bundle arguments);
3224
3225 /** @hide */
Jeff Sharkey5db9a912017-12-08 17:32:32 -07003226 @StringDef(suffix = { "_SERVICE" }, value = {
Tor Norbyed9273d62013-05-30 15:59:53 -07003227 POWER_SERVICE,
3228 WINDOW_SERVICE,
3229 LAYOUT_INFLATER_SERVICE,
3230 ACCOUNT_SERVICE,
3231 ACTIVITY_SERVICE,
3232 ALARM_SERVICE,
3233 NOTIFICATION_SERVICE,
3234 ACCESSIBILITY_SERVICE,
3235 CAPTIONING_SERVICE,
3236 KEYGUARD_SERVICE,
3237 LOCATION_SERVICE,
3238 //@hide: COUNTRY_DETECTOR,
3239 SEARCH_SERVICE,
3240 SENSOR_SERVICE,
Chad Brubaker90f391f2018-10-19 10:26:19 -07003241 SENSOR_PRIVACY_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003242 STORAGE_SERVICE,
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003243 STORAGE_STATS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003244 WALLPAPER_SERVICE,
Neil Fullerfe6ec562017-03-16 18:29:36 +00003245 TIME_ZONE_RULES_MANAGER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003246 VIBRATOR_SERVICE,
3247 //@hide: STATUS_BAR_SERVICE,
3248 CONNECTIVITY_SERVICE,
Chalard Jean8c141bd2018-12-04 20:20:56 +09003249 //@hide: IP_MEMORY_STORE_SERVICE,
Nathan Harold330e1082017-01-12 18:38:57 -08003250 IPSEC_SERVICE,
Benedict Wong99a48412018-11-09 14:45:34 -08003251 TEST_NETWORK_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003252 //@hide: UPDATE_LOCK_SERVICE,
3253 //@hide: NETWORKMANAGEMENT_SERVICE,
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003254 NETWORK_STATS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003255 //@hide: NETWORK_POLICY_SERVICE,
3256 WIFI_SERVICE,
Etan Cohen04133272016-10-26 11:22:06 -07003257 WIFI_AWARE_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003258 WIFI_P2P_SERVICE,
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003259 WIFI_SCANNING_SERVICE,
Robert Quattlebaum87a71042017-05-15 15:45:20 -07003260 //@hide: LOWPAN_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003261 //@hide: WIFI_RTT_SERVICE,
Lorenzo Colittibd8a3742014-05-22 11:51:27 -07003262 //@hide: ETHERNET_SERVICE,
Etan Cohen46efb482017-12-07 13:50:57 -08003263 WIFI_RTT_RANGING_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003264 NSD_SERVICE,
3265 AUDIO_SERVICE,
Jim Millerce7eb6d2015-04-03 19:29:13 -07003266 FINGERPRINT_SERVICE,
Gilad Brettercb51b8b2018-03-22 17:04:51 +02003267 //@hide: FACE_SERVICE,
Kevin Chyn05c21502018-09-18 13:07:19 -07003268 BIOMETRIC_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003269 MEDIA_ROUTER_SERVICE,
3270 TELEPHONY_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003271 TELEPHONY_SUBSCRIPTION_SERVICE,
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08003272 CARRIER_CONFIG_SERVICE,
hyunhae.lee75fdafa2019-07-19 22:08:41 +09003273 EUICC_SERVICE,
Tyler Gunnef9f6f92014-09-12 22:16:17 -07003274 TELECOM_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003275 CLIPBOARD_SERVICE,
3276 INPUT_METHOD_SERVICE,
3277 TEXT_SERVICES_MANAGER_SERVICE,
Abodunrinwa Toki3de110b2017-05-04 16:29:04 +01003278 TEXT_CLASSIFICATION_SERVICE,
Svetoslav976e8bd2014-07-16 15:12:03 -07003279 APPWIDGET_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003280 //@hide: VOICE_INTERACTION_MANAGER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003281 //@hide: BACKUP_SERVICE,
Richard Uhlerb29f1452018-09-12 16:38:15 +01003282 ROLLBACK_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003283 DROPBOX_SERVICE,
Dianne Hackborn1958e5e2015-06-12 18:11:41 -07003284 //@hide: DEVICE_IDLE_CONTROLLER,
Tor Norbyed9273d62013-05-30 15:59:53 -07003285 DEVICE_POLICY_SERVICE,
3286 UI_MODE_SERVICE,
3287 DOWNLOAD_SERVICE,
3288 NFC_SERVICE,
3289 BLUETOOTH_SERVICE,
3290 //@hide: SIP_SERVICE,
3291 USB_SERVICE,
Amith Yamasani4f582632014-02-19 14:31:52 -08003292 LAUNCHER_APPS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003293 //@hide: SERIAL_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003294 //@hide: HDMI_CONTROL_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003295 INPUT_SERVICE,
3296 DISPLAY_SERVICE,
Christine Franks39b03112018-07-03 14:46:07 -07003297 //@hide COLOR_DISPLAY_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003298 USER_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003299 RESTRICTIONS_SERVICE,
3300 APP_OPS_SERVICE,
Hai Zhangb7776682018-09-25 15:10:57 -07003301 ROLE_SERVICE,
Hai Zhanga4959e52019-03-06 12:21:07 -08003302 //@hide ROLE_CONTROLLER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003303 CAMERA_SERVICE,
atrost8266ae32019-08-15 16:53:01 +01003304 //@hide: PLATFORM_COMPAT_SERVICE,
atrostff948d82019-10-10 19:27:31 +01003305 //@hide: PLATFORM_COMPAT_NATIVE_SERVICE,
RoboErik01fe6612014-02-13 14:19:04 -08003306 PRINT_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003307 CONSUMER_IR_SERVICE,
3308 //@hide: TRUST_SERVICE,
3309 TV_INPUT_SERVICE,
3310 //@hide: NETWORK_SCORE_SERVICE,
3311 USAGE_STATS_SERVICE,
RoboErik01fe6612014-02-13 14:19:04 -08003312 MEDIA_SESSION_SERVICE,
Todd Poynore35872d2013-12-10 11:57:21 -08003313 BATTERY_SERVICE,
Christopher Tate7060b042014-06-09 19:50:00 -07003314 JOB_SCHEDULER_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003315 //@hide: PERSISTENT_DATA_BLOCK_SERVICE,
Andrew Scull3b8b46f2017-02-13 18:12:15 +00003316 //@hide: OEM_LOCK_SERVICE,
Michael Wright446e0192014-12-22 09:38:43 -08003317 MEDIA_PROJECTION_SERVICE,
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08003318 MIDI_SERVICE,
Eric Laurent2035ac82015-03-05 15:18:44 -08003319 RADIO_SERVICE,
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003320 HARDWARE_PROPERTIES_SERVICE,
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08003321 //@hide: SOUND_TRIGGER_SERVICE,
Makoto Onuki6f7362d92016-03-04 13:39:41 -08003322 SHORTCUT_SERVICE,
Peng Xu9ff7d222016-02-11 13:02:05 -08003323 //@hide: CONTEXTHUB_SERVICE,
Joe Onorato1754d742016-11-21 17:51:35 -08003324 SYSTEM_HEALTH_SERVICE,
Tor Norbye8246c072017-07-07 10:21:09 -07003325 //@hide: INCIDENT_SERVICE,
Joe Onoratoe21ab7e2018-12-18 15:00:25 -08003326 //@hide: INCIDENT_COMPANION_SERVICE,
Bookatz94726412017-08-31 09:26:15 -07003327 //@hide: STATS_COMPANION_SERVICE,
Tony Mak9240c7f2017-12-29 11:02:02 +00003328 COMPANION_DEVICE_SERVICE,
Tao Bao07342dc2017-01-24 15:08:21 -08003329 CROSS_PROFILE_APPS_SERVICE,
3330 //@hide: SYSTEM_UPDATE_SERVICE,
Neil Fullerfeeee682018-05-30 14:35:24 +01003331 //@hide: TIME_DETECTOR_SERVICE,
Philip P. Moltmann039678e2018-09-18 13:04:38 -07003332 PERMISSION_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003333 })
3334 @Retention(RetentionPolicy.SOURCE)
3335 public @interface ServiceName {}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003336
3337 /**
3338 * Return the handle to a system-level service by name. The class of the
3339 * returned object varies by the requested name. Currently available names
3340 * are:
Scott Main4b5da682010-10-21 11:49:12 -07003341 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003342 * <dl>
3343 * <dt> {@link #WINDOW_SERVICE} ("window")
3344 * <dd> The top-level window manager in which you can place custom
3345 * windows. The returned object is a {@link android.view.WindowManager}.
3346 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater")
3347 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources
3348 * in this context.
3349 * <dt> {@link #ACTIVITY_SERVICE} ("activity")
3350 * <dd> A {@link android.app.ActivityManager} for interacting with the
3351 * global activity state of the system.
3352 * <dt> {@link #POWER_SERVICE} ("power")
3353 * <dd> A {@link android.os.PowerManager} for controlling power
3354 * management.
3355 * <dt> {@link #ALARM_SERVICE} ("alarm")
3356 * <dd> A {@link android.app.AlarmManager} for receiving intents at the
3357 * time of your choosing.
3358 * <dt> {@link #NOTIFICATION_SERVICE} ("notification")
3359 * <dd> A {@link android.app.NotificationManager} for informing the user
3360 * of background events.
3361 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard")
3362 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard.
3363 * <dt> {@link #LOCATION_SERVICE} ("location")
3364 * <dd> A {@link android.location.LocationManager} for controlling location
3365 * (e.g., GPS) updates.
3366 * <dt> {@link #SEARCH_SERVICE} ("search")
3367 * <dd> A {@link android.app.SearchManager} for handling search.
3368 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator")
3369 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator
3370 * hardware.
3371 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection")
3372 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for
3373 * handling management of network connections.
Nathan Haroldd999d222017-09-11 19:53:33 -07003374 * <dt> {@link #IPSEC_SERVICE} ("ipsec")
3375 * <dd> A {@link android.net.IpSecManager IpSecManager} for managing IPSec on
3376 * sockets and networks.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003377 * <dt> {@link #WIFI_SERVICE} ("wifi")
Paul Stewart0e164b12016-08-08 10:20:13 -07003378 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of Wi-Fi
3379 * connectivity. On releases before NYC, it should only be obtained from an application
3380 * context, and not from any other derived context to avoid memory leaks within the calling
3381 * process.
Etan Cohen6a4b3232017-01-09 21:47:32 -08003382 * <dt> {@link #WIFI_AWARE_SERVICE} ("wifiaware")
3383 * <dd> A {@link android.net.wifi.aware.WifiAwareManager WifiAwareManager} for management of
3384 * Wi-Fi Aware discovery and connectivity.
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003385 * <dt> {@link #WIFI_P2P_SERVICE} ("wifip2p")
3386 * <dd> A {@link android.net.wifi.p2p.WifiP2pManager WifiP2pManager} for management of
3387 * Wi-Fi Direct connectivity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003388 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method")
3389 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager}
3390 * for management of input methods.
Tobias Haamel53332882010-02-18 16:15:43 -08003391 * <dt> {@link #UI_MODE_SERVICE} ("uimode")
3392 * <dd> An {@link android.app.UiModeManager} for controlling UI modes.
Steve Howard7083c422010-07-28 16:01:23 -07003393 * <dt> {@link #DOWNLOAD_SERVICE} ("download")
Steve Howardd58429f2010-09-27 16:32:39 -07003394 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads
Todd Poynore35872d2013-12-10 11:57:21 -08003395 * <dt> {@link #BATTERY_SERVICE} ("batterymanager")
Todd Poynor99f7e122014-04-15 16:03:42 -07003396 * <dd> A {@link android.os.BatteryManager} for managing battery state
Christopher Tate7060b042014-06-09 19:50:00 -07003397 * <dt> {@link #JOB_SCHEDULER_SERVICE} ("taskmanager")
3398 * <dd> A {@link android.app.job.JobScheduler} for managing scheduled tasks
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003399 * <dt> {@link #NETWORK_STATS_SERVICE} ("netstats")
3400 * <dd> A {@link android.app.usage.NetworkStatsManager NetworkStatsManager} for querying network
3401 * usage statistics.
Polina Bondarenko8333c732016-03-09 18:08:42 +01003402 * <dt> {@link #HARDWARE_PROPERTIES_SERVICE} ("hardware_properties")
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003403 * <dd> A {@link android.os.HardwarePropertiesManager} for accessing hardware properties.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003404 * </dl>
Scott Main4b5da682010-10-21 11:49:12 -07003405 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003406 * <p>Note: System services obtained via this API may be closely associated with
3407 * the Context in which they are obtained from. In general, do not share the
3408 * service objects between various different contexts (Activities, Applications,
3409 * Services, Providers, etc.)
3410 *
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003411 * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true,
3412 * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE},
Donald Chaiee4c91c2018-09-19 14:42:41 -07003413 * {@link #FINGERPRINT_SERVICE}, {@link #KEYGUARD_SERVICE}, {@link #SHORTCUT_SERVICE},
3414 * {@link #USB_SERVICE}, {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE},
3415 * {@link #WIFI_SERVICE}, {@link #WIFI_AWARE_SERVICE}. For these services this method will
3416 * return <code>null</code>. Generally, if you are running as an instant app you should always
Felipe Leme4685b862019-03-06 10:32:33 -08003417 * check whether the result of this method is {@code null}.
3418 *
3419 * <p>Note: When implementing this method, keep in mind that new services can be added on newer
3420 * Android releases, so if you're looking for just the explicit names mentioned above, make sure
3421 * to return {@code null} when you don't recognize the name &mdash; if you throw a
3422 * {@link RuntimeException} exception instead, you're app might break on new Android releases.
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003423 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003424 * @param name The name of the desired service.
Scott Main4b5da682010-10-21 11:49:12 -07003425 *
Felipe Leme4685b862019-03-06 10:32:33 -08003426 * @return The service or {@code null} if the name does not exist.
Scott Main4b5da682010-10-21 11:49:12 -07003427 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003428 * @see #WINDOW_SERVICE
3429 * @see android.view.WindowManager
3430 * @see #LAYOUT_INFLATER_SERVICE
3431 * @see android.view.LayoutInflater
3432 * @see #ACTIVITY_SERVICE
3433 * @see android.app.ActivityManager
3434 * @see #POWER_SERVICE
3435 * @see android.os.PowerManager
3436 * @see #ALARM_SERVICE
3437 * @see android.app.AlarmManager
3438 * @see #NOTIFICATION_SERVICE
3439 * @see android.app.NotificationManager
3440 * @see #KEYGUARD_SERVICE
3441 * @see android.app.KeyguardManager
3442 * @see #LOCATION_SERVICE
3443 * @see android.location.LocationManager
3444 * @see #SEARCH_SERVICE
3445 * @see android.app.SearchManager
3446 * @see #SENSOR_SERVICE
3447 * @see android.hardware.SensorManager
San Mehatc9d81752010-02-01 10:23:27 -08003448 * @see #STORAGE_SERVICE
San Mehatb1043402010-02-05 08:26:50 -08003449 * @see android.os.storage.StorageManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003450 * @see #VIBRATOR_SERVICE
3451 * @see android.os.Vibrator
3452 * @see #CONNECTIVITY_SERVICE
3453 * @see android.net.ConnectivityManager
3454 * @see #WIFI_SERVICE
3455 * @see android.net.wifi.WifiManager
3456 * @see #AUDIO_SERVICE
3457 * @see android.media.AudioManager
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07003458 * @see #MEDIA_ROUTER_SERVICE
3459 * @see android.media.MediaRouter
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003460 * @see #TELEPHONY_SERVICE
3461 * @see android.telephony.TelephonyManager
Wink Savilled09c4ca2014-11-22 10:08:16 -08003462 * @see #TELEPHONY_SUBSCRIPTION_SERVICE
3463 * @see android.telephony.SubscriptionManager
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08003464 * @see #CARRIER_CONFIG_SERVICE
3465 * @see android.telephony.CarrierConfigManager
hyunhae.lee75fdafa2019-07-19 22:08:41 +09003466 * @see #EUICC_SERVICE
3467 * @see android.telephony.euicc.EuiccManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003468 * @see #INPUT_METHOD_SERVICE
3469 * @see android.view.inputmethod.InputMethodManager
Tobias Haamel53332882010-02-18 16:15:43 -08003470 * @see #UI_MODE_SERVICE
3471 * @see android.app.UiModeManager
Steve Howard7083c422010-07-28 16:01:23 -07003472 * @see #DOWNLOAD_SERVICE
Steve Howardd58429f2010-09-27 16:32:39 -07003473 * @see android.app.DownloadManager
Todd Poynore35872d2013-12-10 11:57:21 -08003474 * @see #BATTERY_SERVICE
3475 * @see android.os.BatteryManager
Christopher Tate7060b042014-06-09 19:50:00 -07003476 * @see #JOB_SCHEDULER_SERVICE
3477 * @see android.app.job.JobScheduler
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003478 * @see #NETWORK_STATS_SERVICE
3479 * @see android.app.usage.NetworkStatsManager
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003480 * @see android.os.HardwarePropertiesManager
3481 * @see #HARDWARE_PROPERTIES_SERVICE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003482 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003483 public abstract @Nullable Object getSystemService(@ServiceName @NonNull String name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003484
3485 /**
Jeff Brown6e539312015-02-24 18:53:21 -08003486 * Return the handle to a system-level service by class.
3487 * <p>
3488 * Currently available classes are:
3489 * {@link android.view.WindowManager}, {@link android.view.LayoutInflater},
3490 * {@link android.app.ActivityManager}, {@link android.os.PowerManager},
3491 * {@link android.app.AlarmManager}, {@link android.app.NotificationManager},
3492 * {@link android.app.KeyguardManager}, {@link android.location.LocationManager},
3493 * {@link android.app.SearchManager}, {@link android.os.Vibrator},
3494 * {@link android.net.ConnectivityManager},
3495 * {@link android.net.wifi.WifiManager},
3496 * {@link android.media.AudioManager}, {@link android.media.MediaRouter},
3497 * {@link android.telephony.TelephonyManager}, {@link android.telephony.SubscriptionManager},
3498 * {@link android.view.inputmethod.InputMethodManager},
3499 * {@link android.app.UiModeManager}, {@link android.app.DownloadManager},
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003500 * {@link android.os.BatteryManager}, {@link android.app.job.JobScheduler},
3501 * {@link android.app.usage.NetworkStatsManager}.
Felipe Leme4685b862019-03-06 10:32:33 -08003502 * </p>
3503 *
3504 * <p>
Jeff Brown6e539312015-02-24 18:53:21 -08003505 * Note: System services obtained via this API may be closely associated with
3506 * the Context in which they are obtained from. In general, do not share the
3507 * service objects between various different contexts (Activities, Applications,
3508 * Services, Providers, etc.)
3509 * </p>
3510 *
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003511 * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true,
3512 * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE},
Donald Chaiee4c91c2018-09-19 14:42:41 -07003513 * {@link #FINGERPRINT_SERVICE}, {@link #KEYGUARD_SERVICE}, {@link #SHORTCUT_SERVICE},
3514 * {@link #USB_SERVICE}, {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE},
3515 * {@link #WIFI_SERVICE}, {@link #WIFI_AWARE_SERVICE}. For these services this method will
Felipe Leme4685b862019-03-06 10:32:33 -08003516 * return {@code null}. Generally, if you are running as an instant app you should always
3517 * check whether the result of this method is {@code null}.
3518 * </p>
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003519 *
Jeff Brown6e539312015-02-24 18:53:21 -08003520 * @param serviceClass The class of the desired service.
Felipe Leme4685b862019-03-06 10:32:33 -08003521 * @return The service or {@code null} if the class is not a supported system service. Note:
3522 * <b>never</b> throw a {@link RuntimeException} if the name is not supported.
Jeff Brown6e539312015-02-24 18:53:21 -08003523 */
3524 @SuppressWarnings("unchecked")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003525 public final @Nullable <T> T getSystemService(@NonNull Class<T> serviceClass) {
Jeff Brown6e539312015-02-24 18:53:21 -08003526 // Because subclasses may override getSystemService(String) we cannot
3527 // perform a lookup by class alone. We must first map the class to its
3528 // service name then invoke the string-based method.
3529 String serviceName = getSystemServiceName(serviceClass);
3530 return serviceName != null ? (T)getSystemService(serviceName) : null;
3531 }
3532
3533 /**
3534 * Gets the name of the system-level service that is represented by the specified class.
3535 *
3536 * @param serviceClass The class of the desired service.
3537 * @return The service name or null if the class is not a supported system service.
Jeff Brown6e539312015-02-24 18:53:21 -08003538 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003539 public abstract @Nullable String getSystemServiceName(@NonNull Class<?> serviceClass);
Jeff Brown6e539312015-02-24 18:53:21 -08003540
3541 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003542 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003543 * {@link android.os.PowerManager} for controlling power management,
3544 * including "wake locks," which let you keep the device on while
3545 * you're running long tasks.
3546 */
3547 public static final String POWER_SERVICE = "power";
Scott Main4b5da682010-10-21 11:49:12 -07003548
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003549 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003550 * Use with {@link #getSystemService(String)} to retrieve a
Tao Baoe8a403d2015-12-31 07:44:55 -08003551 * {@link android.os.RecoverySystem} for accessing the recovery system
3552 * service.
3553 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003554 * @see #getSystemService(String)
Tao Baoe8a403d2015-12-31 07:44:55 -08003555 * @hide
3556 */
3557 public static final String RECOVERY_SERVICE = "recovery";
3558
3559 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003560 * Use with {@link #getSystemService(String)} to retrieve a
Tao Bao07342dc2017-01-24 15:08:21 -08003561 * {@link android.os.SystemUpdateManager} for accessing the system update
3562 * manager service.
3563 *
3564 * @see #getSystemService(String)
3565 * @hide
3566 */
3567 @SystemApi
3568 public static final String SYSTEM_UPDATE_SERVICE = "system_update";
3569
3570 /**
3571 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003572 * {@link android.view.WindowManager} for accessing the system's window
3573 * manager.
3574 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003575 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003576 * @see android.view.WindowManager
3577 */
3578 public static final String WINDOW_SERVICE = "window";
Scott Main4b5da682010-10-21 11:49:12 -07003579
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003580 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003581 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003582 * {@link android.view.LayoutInflater} for inflating layout resources in this
3583 * context.
3584 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003585 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003586 * @see android.view.LayoutInflater
3587 */
3588 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
Scott Main4b5da682010-10-21 11:49:12 -07003589
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003590 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003591 * Use with {@link #getSystemService(String)} to retrieve a
Fred Quintana60307342009-03-24 22:48:12 -07003592 * {@link android.accounts.AccountManager} for receiving intents at a
3593 * time of your choosing.
Fred Quintana60307342009-03-24 22:48:12 -07003594 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003595 * @see #getSystemService(String)
Fred Quintana60307342009-03-24 22:48:12 -07003596 * @see android.accounts.AccountManager
3597 */
3598 public static final String ACCOUNT_SERVICE = "account";
Scott Main4b5da682010-10-21 11:49:12 -07003599
Fred Quintana60307342009-03-24 22:48:12 -07003600 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003601 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003602 * {@link android.app.ActivityManager} for interacting with the global
3603 * system state.
3604 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003605 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003606 * @see android.app.ActivityManager
3607 */
3608 public static final String ACTIVITY_SERVICE = "activity";
Scott Main4b5da682010-10-21 11:49:12 -07003609
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003610 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003611 * Use with {@link #getSystemService(String)} to retrieve a
Wale Ogunwale65ebd952018-04-25 15:41:44 -07003612 * {@link android.app.ActivityTaskManager} for interacting with the global system state.
3613 *
3614 * @see #getSystemService(String)
3615 * @see android.app.ActivityTaskManager
3616 * @hide
3617 */
3618 public static final String ACTIVITY_TASK_SERVICE = "activity_task";
3619
3620 /**
3621 * Use with {@link #getSystemService(String)} to retrieve a
Wale Ogunwale6d50dcc2018-07-21 23:00:40 -07003622 * {@link android.app.UriGrantsManager} for interacting with the global system state.
3623 *
3624 * @see #getSystemService(String)
3625 * @see android.app.UriGrantsManager
3626 * @hide
3627 */
3628 public static final String URI_GRANTS_SERVICE = "uri_grants";
3629
3630 /**
3631 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003632 * {@link android.app.AlarmManager} for receiving intents at a
3633 * time of your choosing.
3634 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003635 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003636 * @see android.app.AlarmManager
3637 */
3638 public static final String ALARM_SERVICE = "alarm";
Scott Main4b5da682010-10-21 11:49:12 -07003639
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003640 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003641 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003642 * {@link android.app.NotificationManager} for informing the user of
3643 * background events.
3644 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003645 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003646 * @see android.app.NotificationManager
3647 */
3648 public static final String NOTIFICATION_SERVICE = "notification";
Scott Main4b5da682010-10-21 11:49:12 -07003649
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003650 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003651 * Use with {@link #getSystemService(String)} to retrieve a
svetoslavganov75986cf2009-05-14 22:28:01 -07003652 * {@link android.view.accessibility.AccessibilityManager} for giving the user
3653 * feedback for UI events through the registered event listeners.
3654 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003655 * @see #getSystemService(String)
svetoslavganov75986cf2009-05-14 22:28:01 -07003656 * @see android.view.accessibility.AccessibilityManager
3657 */
3658 public static final String ACCESSIBILITY_SERVICE = "accessibility";
Scott Main4b5da682010-10-21 11:49:12 -07003659
svetoslavganov75986cf2009-05-14 22:28:01 -07003660 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003661 * Use with {@link #getSystemService(String)} to retrieve a
Alan Viverette69ce69b2013-08-29 12:23:48 -07003662 * {@link android.view.accessibility.CaptioningManager} for obtaining
3663 * captioning properties and listening for changes in captioning
3664 * preferences.
3665 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003666 * @see #getSystemService(String)
Alan Viverette69ce69b2013-08-29 12:23:48 -07003667 * @see android.view.accessibility.CaptioningManager
3668 */
3669 public static final String CAPTIONING_SERVICE = "captioning";
3670
3671 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003672 * Use with {@link #getSystemService(String)} to retrieve a
kopriva5495dbb2018-09-13 14:18:34 -07003673 * {@link android.app.KeyguardManager} for controlling keyguard.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003674 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003675 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003676 * @see android.app.KeyguardManager
3677 */
3678 public static final String KEYGUARD_SERVICE = "keyguard";
Scott Main4b5da682010-10-21 11:49:12 -07003679
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003680 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003681 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003682 * android.location.LocationManager} for controlling location
3683 * updates.
3684 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003685 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003686 * @see android.location.LocationManager
3687 */
3688 public static final String LOCATION_SERVICE = "location";
Bai Taoa58a8752010-07-13 15:32:16 +08003689
3690 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003691 * Use with {@link #getSystemService(String)} to retrieve a
Bai Taoa58a8752010-07-13 15:32:16 +08003692 * {@link android.location.CountryDetector} for detecting the country that
3693 * the user is in.
3694 *
3695 * @hide
3696 */
Mathew Inwood8c854f82018-09-14 12:35:36 +01003697 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
Bai Taoa58a8752010-07-13 15:32:16 +08003698 public static final String COUNTRY_DETECTOR = "country_detector";
3699
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003700 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003701 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003702 * android.app.SearchManager} for handling searches.
3703 *
Erik Wolsheimerac5cecd2017-12-05 13:11:50 -08003704 * <p>
3705 * {@link Configuration#UI_MODE_TYPE_WATCH} does not support
3706 * {@link android.app.SearchManager}.
3707 *
3708 * @see #getSystemService
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003709 * @see android.app.SearchManager
3710 */
3711 public static final String SEARCH_SERVICE = "search";
Scott Main4b5da682010-10-21 11:49:12 -07003712
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003713 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003714 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003715 * android.hardware.SensorManager} for accessing sensors.
3716 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003717 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003718 * @see android.hardware.SensorManager
3719 */
3720 public static final String SENSOR_SERVICE = "sensor";
Scott Main4b5da682010-10-21 11:49:12 -07003721
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003722 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003723 * Use with {@link #getSystemService(String)} to retrieve a {@link
Chad Brubaker90f391f2018-10-19 10:26:19 -07003724 * android.hardware.SensorPrivacyManager} for accessing sensor privacy
3725 * functions.
3726 *
3727 * @see #getSystemService(String)
3728 * @see android.hardware.SensorPrivacyManager
3729 *
3730 * @hide
3731 */
3732 public static final String SENSOR_PRIVACY_SERVICE = "sensor_privacy";
3733
3734 /**
3735 * Use with {@link #getSystemService(String)} to retrieve a {@link
Kenny Root02c87302010-07-01 08:10:18 -07003736 * android.os.storage.StorageManager} for accessing system storage
San Mehatc9d81752010-02-01 10:23:27 -08003737 * functions.
3738 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003739 * @see #getSystemService(String)
San Mehatb1043402010-02-05 08:26:50 -08003740 * @see android.os.storage.StorageManager
San Mehatc9d81752010-02-01 10:23:27 -08003741 */
3742 public static final String STORAGE_SERVICE = "storage";
3743
3744 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003745 * Use with {@link #getSystemService(String)} to retrieve a {@link
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003746 * android.app.usage.StorageStatsManager} for accessing system storage
3747 * statistics.
3748 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003749 * @see #getSystemService(String)
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003750 * @see android.app.usage.StorageStatsManager
3751 */
3752 public static final String STORAGE_STATS_SERVICE = "storagestats";
3753
3754 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003755 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003756 * com.android.server.WallpaperService for accessing wallpapers.
3757 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003758 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003759 */
3760 public static final String WALLPAPER_SERVICE = "wallpaper";
Scott Main4b5da682010-10-21 11:49:12 -07003761
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003762 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003763 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003764 * android.os.Vibrator} for interacting with the vibration hardware.
3765 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003766 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003767 * @see android.os.Vibrator
3768 */
3769 public static final String VIBRATOR_SERVICE = "vibrator";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003770
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003771 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003772 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003773 * android.app.StatusBarManager} for interacting with the status bar.
3774 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003775 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003776 * @see android.app.StatusBarManager
Evan Lairdedd016f2019-01-23 18:36:29 -05003777 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003778 * @hide
3779 */
Evan Lairdedd016f2019-01-23 18:36:29 -05003780 @SystemApi
Evan Laird418ba8f2019-04-17 15:55:21 -04003781 @TestApi
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003782 public static final String STATUS_BAR_SERVICE = "statusbar";
3783
3784 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003785 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003786 * android.net.ConnectivityManager} for handling management of
3787 * network connections.
3788 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003789 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003790 * @see android.net.ConnectivityManager
3791 */
3792 public static final String CONNECTIVITY_SERVICE = "connectivity";
3793
3794 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003795 * Use with {@link #getSystemService(String)} to retrieve a
Remi NGUYEN VAN31935982019-01-28 11:40:08 +09003796 * {@link android.net.INetd} for communicating with the network stack
3797 * @hide
3798 * @see #getSystemService(String)
3799 * @hide
3800 */
3801 @SystemApi
3802 public static final String NETD_SERVICE = "netd";
3803
3804 /**
Remi NGUYEN VAN310da6f2019-02-14 18:04:20 +09003805 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
3806 * {@link NetworkStackClient} IBinder for communicating with the network stack
Remi NGUYEN VANc094a542018-12-07 16:52:24 +09003807 * @hide
Remi NGUYEN VAN310da6f2019-02-14 18:04:20 +09003808 * @see NetworkStackClient
Remi NGUYEN VANc094a542018-12-07 16:52:24 +09003809 */
3810 public static final String NETWORK_STACK_SERVICE = "network_stack";
3811
3812 /**
3813 * Use with {@link #getSystemService(String)} to retrieve a
Nathan Harold330e1082017-01-12 18:38:57 -08003814 * {@link android.net.IpSecManager} for encrypting Sockets or Networks with
3815 * IPSec.
3816 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003817 * @see #getSystemService(String)
Nathan Harold330e1082017-01-12 18:38:57 -08003818 */
3819 public static final String IPSEC_SERVICE = "ipsec";
3820
3821 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003822 * Use with {@link #getSystemService(String)} to retrieve a {@link
Benedict Wong99a48412018-11-09 14:45:34 -08003823 * android.net.TestNetworkManager} for building TUNs and limited-use Networks
3824 *
3825 * @see #getSystemService(String)
3826 * @hide
3827 */
3828 @TestApi public static final String TEST_NETWORK_SERVICE = "test_network";
3829
3830 /**
3831 * Use with {@link #getSystemService(String)} to retrieve a {@link
Christopher Tate8662cab52012-02-23 14:59:36 -08003832 * android.os.IUpdateLock} for managing runtime sequences that
3833 * must not be interrupted by headless OTA application or similar.
3834 *
3835 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003836 * @see #getSystemService(String)
Christopher Tate8662cab52012-02-23 14:59:36 -08003837 * @see android.os.UpdateLock
3838 */
3839 public static final String UPDATE_LOCK_SERVICE = "updatelock";
3840
3841 /**
Dianne Hackborn35f72be2013-09-16 10:57:39 -07003842 * Constant for the internal network management service, not really a Context service.
Dianne Hackborn0a6a80f2013-09-16 15:20:27 -07003843 * @hide
San Mehatd1df8ac2010-01-26 06:17:26 -08003844 */
3845 public static final String NETWORKMANAGEMENT_SERVICE = "network_management";
3846
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003847 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003848 * Use with {@link #getSystemService(String)} to retrieve a
Jason Monk8f5f7ff2017-10-17 14:12:42 -04003849 * {@link com.android.server.slice.SliceManagerService} for managing slices.
3850 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003851 * @see #getSystemService(String)
Jason Monk8f5f7ff2017-10-17 14:12:42 -04003852 */
3853 public static final String SLICE_SERVICE = "slice";
3854
3855 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003856 * Use with {@link #getSystemService(String)} to retrieve a {@link
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003857 * android.app.usage.NetworkStatsManager} for querying network usage stats.
3858 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003859 * @see #getSystemService(String)
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003860 * @see android.app.usage.NetworkStatsManager
3861 */
Jeff Sharkey75279902011-05-24 18:39:45 -07003862 public static final String NETWORK_STATS_SERVICE = "netstats";
3863 /** {@hide} */
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07003864 public static final String NETWORK_POLICY_SERVICE = "netpolicy";
Ricky Wai1a6e6672017-10-27 14:46:01 +01003865 /** {@hide} */
3866 public static final String NETWORK_WATCHLIST_SERVICE = "network_watchlist";
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07003867
San Mehatd1df8ac2010-01-26 06:17:26 -08003868 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003869 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003870 * android.net.wifi.WifiManager} for handling management of
3871 * Wi-Fi access.
3872 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003873 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003874 * @see android.net.wifi.WifiManager
3875 */
3876 public static final String WIFI_SERVICE = "wifi";
Scott Main4b5da682010-10-21 11:49:12 -07003877
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003878 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003879 * Use with {@link #getSystemService(String)} to retrieve a {@link
repo sync55bc5f32011-06-24 14:23:07 -07003880 * android.net.wifi.p2p.WifiP2pManager} for handling management of
Irfan Sheriff651cdfc2011-09-07 00:31:20 -07003881 * Wi-Fi peer-to-peer connections.
repo sync55bc5f32011-06-24 14:23:07 -07003882 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003883 * @see #getSystemService(String)
repo sync55bc5f32011-06-24 14:23:07 -07003884 * @see android.net.wifi.p2p.WifiP2pManager
repo sync55bc5f32011-06-24 14:23:07 -07003885 */
3886 public static final String WIFI_P2P_SERVICE = "wifip2p";
3887
3888 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003889 * Use with {@link #getSystemService(String)} to retrieve a
Etan Cohen04133272016-10-26 11:22:06 -07003890 * {@link android.net.wifi.aware.WifiAwareManager} for handling management of
3891 * Wi-Fi Aware.
Etan Cohen20d329b2015-09-29 13:49:02 -07003892 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003893 * @see #getSystemService(String)
Etan Cohen04133272016-10-26 11:22:06 -07003894 * @see android.net.wifi.aware.WifiAwareManager
Etan Cohen20d329b2015-09-29 13:49:02 -07003895 */
Etan Cohen04133272016-10-26 11:22:06 -07003896 public static final String WIFI_AWARE_SERVICE = "wifiaware";
Etan Cohen20d329b2015-09-29 13:49:02 -07003897
3898 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003899 * Use with {@link #getSystemService(String)} to retrieve a {@link
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003900 * android.net.wifi.WifiScanner} for scanning the wifi universe
3901 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003902 * @see #getSystemService(String)
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003903 * @see android.net.wifi.WifiScanner
3904 * @hide
3905 */
Wei Wang35d552f2014-07-08 21:37:01 -07003906 @SystemApi
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003907 public static final String WIFI_SCANNING_SERVICE = "wifiscanner";
3908
3909 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003910 * Use with {@link #getSystemService(String)} to retrieve a {@link
Vinit Deshpande7686c062014-06-30 15:25:01 -07003911 * android.net.wifi.RttManager} for ranging devices with wifi
3912 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003913 * @see #getSystemService(String)
Vinit Deshpande7686c062014-06-30 15:25:01 -07003914 * @see android.net.wifi.RttManager
3915 * @hide
3916 */
3917 @SystemApi
Etan Cohend0acccd2018-01-31 08:36:33 -08003918 @Deprecated
Vinit Deshpande7686c062014-06-30 15:25:01 -07003919 public static final String WIFI_RTT_SERVICE = "rttmanager";
3920
3921 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003922 * Use with {@link #getSystemService(String)} to retrieve a {@link
Etan Cohenf4062a92019-04-11 07:00:42 -07003923 * android.net.wifi.rtt.WifiRttManager} for ranging devices with wifi.
Etan Cohen17ba4722017-08-21 10:52:17 -07003924 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003925 * @see #getSystemService(String)
Etan Cohen17ba4722017-08-21 10:52:17 -07003926 * @see android.net.wifi.rtt.WifiRttManager
Etan Cohen17ba4722017-08-21 10:52:17 -07003927 */
Etan Cohen091d7772018-01-04 17:47:37 -08003928 public static final String WIFI_RTT_RANGING_SERVICE = "wifirtt";
Etan Cohen17ba4722017-08-21 10:52:17 -07003929
3930 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003931 * Use with {@link #getSystemService(String)} to retrieve a {@link
Robert Quattlebaum87a71042017-05-15 15:45:20 -07003932 * android.net.lowpan.LowpanManager} for handling management of
3933 * LoWPAN access.
3934 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003935 * @see #getSystemService(String)
Robert Quattlebaum87a71042017-05-15 15:45:20 -07003936 * @see android.net.lowpan.LowpanManager
3937 *
3938 * @hide
3939 */
3940 public static final String LOWPAN_SERVICE = "lowpan";
3941
3942 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003943 * Use with {@link #getSystemService(String)} to retrieve a {@link
Dianne Hackbornfee756f2014-07-16 17:31:10 -07003944 * android.net.EthernetManager} for handling management of
Lorenzo Colittif9ff2c92014-05-21 16:32:11 -07003945 * Ethernet access.
3946 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003947 * @see #getSystemService(String)
Dianne Hackbornfee756f2014-07-16 17:31:10 -07003948 * @see android.net.EthernetManager
Lorenzo Colittif9ff2c92014-05-21 16:32:11 -07003949 *
3950 * @hide
3951 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01003952 @UnsupportedAppUsage
Lorenzo Colittif9ff2c92014-05-21 16:32:11 -07003953 public static final String ETHERNET_SERVICE = "ethernet";
3954
3955 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003956 * Use with {@link #getSystemService(String)} to retrieve a {@link
Irfan Sheriff60309fc2012-04-24 14:52:37 -07003957 * android.net.nsd.NsdManager} for handling management of network service
Irfan Sheriff7d024d32012-03-22 17:01:39 -07003958 * discovery
3959 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003960 * @see #getSystemService(String)
Irfan Sheriff60309fc2012-04-24 14:52:37 -07003961 * @see android.net.nsd.NsdManager
Irfan Sheriff7d024d32012-03-22 17:01:39 -07003962 */
3963 public static final String NSD_SERVICE = "servicediscovery";
3964
Irfan Sheriff7d024d32012-03-22 17:01:39 -07003965 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003966 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003967 * {@link android.media.AudioManager} for handling management of volume,
3968 * ringer modes and audio routing.
Scott Main4b5da682010-10-21 11:49:12 -07003969 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003970 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003971 * @see android.media.AudioManager
3972 */
3973 public static final String AUDIO_SERVICE = "audio";
Scott Main4b5da682010-10-21 11:49:12 -07003974
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003975 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003976 * Use with {@link #getSystemService(String)} to retrieve a
Jim Millerce7eb6d2015-04-03 19:29:13 -07003977 * {@link android.hardware.fingerprint.FingerprintManager} for handling management
Jim Miller08fa40c2014-04-29 18:18:47 -07003978 * of fingerprints.
3979 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003980 * @see #getSystemService(String)
Jim Millerce7eb6d2015-04-03 19:29:13 -07003981 * @see android.hardware.fingerprint.FingerprintManager
Jim Miller08fa40c2014-04-29 18:18:47 -07003982 */
3983 public static final String FINGERPRINT_SERVICE = "fingerprint";
3984
3985 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003986 * Use with {@link #getSystemService(String)} to retrieve a
Gilad Brettercb51b8b2018-03-22 17:04:51 +02003987 * {@link android.hardware.face.FaceManager} for handling management
3988 * of face authentication.
3989 *
3990 * @hide
3991 * @see #getSystemService
3992 * @see android.hardware.face.FaceManager
3993 */
3994 public static final String FACE_SERVICE = "face";
3995
3996 /**
Kevin Chyn05c21502018-09-18 13:07:19 -07003997 * Use with {@link #getSystemService(String)} to retrieve a
Kevin Chyn51676d22018-11-05 18:00:43 -08003998 * {@link android.hardware.iris.IrisManager} for handling management
3999 * of iris authentication.
4000 *
4001 * @hide
4002 * @see #getSystemService
4003 * @see android.hardware.iris.IrisManager
4004 */
4005 public static final String IRIS_SERVICE = "iris";
4006
4007 /**
4008 * Use with {@link #getSystemService(String)} to retrieve a
Kevin Chyn05c21502018-09-18 13:07:19 -07004009 * {@link android.hardware.biometrics.BiometricManager} for handling management
4010 * of face authentication.
4011 *
4012 * @see #getSystemService
4013 * @see android.hardware.biometrics.BiometricManager
4014 */
4015 public static final String BIOMETRIC_SERVICE = "biometric";
4016
4017 /**
Gilad Brettercb51b8b2018-03-22 17:04:51 +02004018 * Use with {@link #getSystemService} to retrieve a
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07004019 * {@link android.media.MediaRouter} for controlling and managing
4020 * routing of media.
4021 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004022 * @see #getSystemService(String)
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07004023 * @see android.media.MediaRouter
4024 */
4025 public static final String MEDIA_ROUTER_SERVICE = "media_router";
4026
4027 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004028 * Use with {@link #getSystemService(String)} to retrieve a
RoboErik42ea7ee2014-05-16 16:27:35 -07004029 * {@link android.media.session.MediaSessionManager} for managing media Sessions.
RoboErik01fe6612014-02-13 14:19:04 -08004030 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004031 * @see #getSystemService(String)
RoboErik42ea7ee2014-05-16 16:27:35 -07004032 * @see android.media.session.MediaSessionManager
RoboErik01fe6612014-02-13 14:19:04 -08004033 */
4034 public static final String MEDIA_SESSION_SERVICE = "media_session";
4035
4036 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004037 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004038 * {@link android.telephony.TelephonyManager} for handling management the
4039 * telephony features of the device.
Scott Main4b5da682010-10-21 11:49:12 -07004040 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004041 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004042 * @see android.telephony.TelephonyManager
4043 */
4044 public static final String TELEPHONY_SERVICE = "phone";
4045
4046 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004047 * Use with {@link #getSystemService(String)} to retrieve a
Wink Savilled09c4ca2014-11-22 10:08:16 -08004048 * {@link android.telephony.SubscriptionManager} for handling management the
4049 * telephony subscriptions of the device.
4050 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004051 * @see #getSystemService(String)
Wink Savilled09c4ca2014-11-22 10:08:16 -08004052 * @see android.telephony.SubscriptionManager
4053 */
4054 public static final String TELEPHONY_SUBSCRIPTION_SERVICE = "telephony_subscription_service";
4055
4056 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004057 * Use with {@link #getSystemService(String)} to retrieve a
Tyler Gunnef9f6f92014-09-12 22:16:17 -07004058 * {@link android.telecom.TelecomManager} to manage telecom-related features
Yorke Leeb4ce1432014-06-09 13:53:23 -07004059 * of the device.
4060 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004061 * @see #getSystemService(String)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07004062 * @see android.telecom.TelecomManager
Yorke Leeb4ce1432014-06-09 13:53:23 -07004063 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07004064 public static final String TELECOM_SERVICE = "telecom";
Yorke Leeb4ce1432014-06-09 13:53:23 -07004065
4066 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004067 * Use with {@link #getSystemService(String)} to retrieve a
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08004068 * {@link android.telephony.CarrierConfigManager} for reading carrier configuration values.
4069 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004070 * @see #getSystemService(String)
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08004071 * @see android.telephony.CarrierConfigManager
4072 */
4073 public static final String CARRIER_CONFIG_SERVICE = "carrier_config";
4074
4075 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004076 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Davidson35cda392017-02-27 09:46:00 -08004077 * {@link android.telephony.euicc.EuiccManager} to manage the device eUICC (embedded SIM).
4078 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004079 * @see #getSystemService(String)
Jeff Davidson35cda392017-02-27 09:46:00 -08004080 * @see android.telephony.euicc.EuiccManager
Jeff Davidson35cda392017-02-27 09:46:00 -08004081 */
Holly Jiuyu Sun4f73b9c2017-12-12 20:17:09 -08004082 public static final String EUICC_SERVICE = "euicc";
Jeff Davidson35cda392017-02-27 09:46:00 -08004083
4084 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004085 * Use with {@link #getSystemService(String)} to retrieve a
Holly Jiuyu Sun5c110242017-12-21 18:44:59 -08004086 * {@link android.telephony.euicc.EuiccCardManager} to access the device eUICC (embedded SIM).
4087 *
4088 * @see #getSystemService(String)
4089 * @see android.telephony.euicc.EuiccCardManager
Holly Jiuyu Sun5c110242017-12-21 18:44:59 -08004090 * @hide
4091 */
Holly Jiuyu Sun4f73b9c2017-12-12 20:17:09 -08004092 @SystemApi
4093 public static final String EUICC_CARD_SERVICE = "euicc_card";
Holly Jiuyu Sun5c110242017-12-21 18:44:59 -08004094
4095 /**
4096 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Brown6e539312015-02-24 18:53:21 -08004097 * {@link android.content.ClipboardManager} for accessing and modifying
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 * the contents of the global clipboard.
Scott Main4b5da682010-10-21 11:49:12 -07004099 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004100 * @see #getSystemService(String)
Jeff Brown6e539312015-02-24 18:53:21 -08004101 * @see android.content.ClipboardManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004102 */
4103 public static final String CLIPBOARD_SERVICE = "clipboard";
4104
4105 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004106 * Use with {@link #getSystemService(String)} to retrieve a
Abodunrinwa Tokif001fef2017-01-04 23:51:42 +00004107 * {@link TextClassificationManager} for text classification services.
Abodunrinwa Toki8158af52016-11-23 20:41:09 +00004108 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004109 * @see #getSystemService(String)
Abodunrinwa Tokif001fef2017-01-04 23:51:42 +00004110 * @see TextClassificationManager
Abodunrinwa Toki8158af52016-11-23 20:41:09 +00004111 */
4112 public static final String TEXT_CLASSIFICATION_SERVICE = "textclassification";
4113
4114 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004115 * Use with {@link #getSystemService(String)} to retrieve a
Alex Salo5f5b5f42019-02-27 10:49:00 -08004116 * {@link com.android.server.attention.AttentionManagerService} for attention services.
4117 *
4118 * @see #getSystemService(String)
4119 * @see android.server.attention.AttentionManagerService
4120 * @hide
4121 */
4122 public static final String ATTENTION_SERVICE = "attention";
4123
4124 /**
4125 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004126 * {@link android.view.inputmethod.InputMethodManager} for accessing input
4127 * methods.
4128 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004129 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004130 */
4131 public static final String INPUT_METHOD_SERVICE = "input_method";
4132
4133 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004134 * Use with {@link #getSystemService(String)} to retrieve a
satok988323c2011-06-22 16:38:13 +09004135 * {@link android.view.textservice.TextServicesManager} for accessing
4136 * text services.
4137 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004138 * @see #getSystemService(String)
satok988323c2011-06-22 16:38:13 +09004139 */
4140 public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices";
4141
4142 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004143 * Use with {@link #getSystemService(String)} to retrieve a
Dan Egnore38d58b2009-12-30 19:29:03 -08004144 * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004145 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004146 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004147 */
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004148 public static final String APPWIDGET_SERVICE = "appwidget";
Dan Egnor95240272009-10-27 18:23:39 -07004149
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004150 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07004151 * Official published name of the (internal) voice interaction manager service.
4152 *
4153 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004154 * @see #getSystemService(String)
Dianne Hackborn91097de2014-04-04 18:02:06 -07004155 */
4156 public static final String VOICE_INTERACTION_MANAGER_SERVICE = "voiceinteraction";
4157
4158 /**
Felipe Leme640f30a2017-03-06 15:44:06 -08004159 * Official published name of the (internal) autofill service.
Felipe Leme5381aa42016-10-13 09:02:32 -07004160 *
4161 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004162 * @see #getSystemService(String)
Felipe Leme5381aa42016-10-13 09:02:32 -07004163 */
Felipe Leme640f30a2017-03-06 15:44:06 -08004164 public static final String AUTOFILL_MANAGER_SERVICE = "autofill";
Felipe Leme5381aa42016-10-13 09:02:32 -07004165
4166 /**
Felipe Leme749b8892018-12-03 16:30:30 -08004167 * Official published name of the content capture service.
Felipe Lemee348dc32018-11-05 12:35:29 -08004168 *
4169 * @hide
4170 * @see #getSystemService(String)
4171 */
Felipe Lemea7e4ca62019-05-23 13:32:40 -07004172 @TestApi
Felipe Leme749b8892018-12-03 16:30:30 -08004173 public static final String CONTENT_CAPTURE_MANAGER_SERVICE = "content_capture";
Felipe Lemee348dc32018-11-05 12:35:29 -08004174
4175 /**
Winson Chung3fb0f252019-01-08 17:41:55 -08004176 * Used for getting content selections and classifications for task snapshots.
4177 *
4178 * @hide
4179 * @see #getSystemService(String)
4180 */
4181 @SystemApi
4182 public static final String CONTENT_SUGGESTIONS_SERVICE = "content_suggestions";
4183
4184 /**
Sunny Goyal54e91342018-11-14 11:59:02 -08004185 * Official published name of the app prediction service.
4186 *
4187 * @hide
4188 * @see #getSystemService(String)
4189 */
4190 @SystemApi
4191 public static final String APP_PREDICTION_SERVICE = "app_prediction";
4192
4193 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004194 * Use with {@link #getSystemService(String)} to access the
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004195 * {@link com.android.server.voiceinteraction.SoundTriggerService}.
4196 *
4197 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004198 * @see #getSystemService(String)
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004199 */
4200 public static final String SOUND_TRIGGER_SERVICE = "soundtrigger";
4201
Philip P. Moltmann039678e2018-09-18 13:04:38 -07004202 /**
4203 * Official published name of the (internal) permission service.
4204 *
4205 * @see #getSystemService(String)
4206 * @hide
4207 */
Winsonf27394e2019-06-07 14:44:40 -07004208 @TestApi
Philip P. Moltmann039678e2018-09-18 13:04:38 -07004209 @SystemApi
4210 public static final String PERMISSION_SERVICE = "permission";
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004211
4212 /**
Philip P. Moltmannbc054d82018-12-21 09:41:58 -08004213 * Official published name of the (internal) permission controller service.
4214 *
4215 * @see #getSystemService(String)
4216 * @hide
4217 */
4218 public static final String PERMISSION_CONTROLLER_SERVICE = "permission_controller";
4219
4220 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004221 * Use with {@link #getSystemService(String)} to retrieve an
Christopher Tate45281862010-03-05 15:46:30 -08004222 * {@link android.app.backup.IBackupManager IBackupManager} for communicating
Christopher Tate487529a2009-04-29 14:03:25 -07004223 * with the backup mechanism.
Dianne Hackborn7f205432009-07-28 00:13:47 -07004224 * @hide
Scott Main4b5da682010-10-21 11:49:12 -07004225 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004226 * @see #getSystemService(String)
Christopher Tate487529a2009-04-29 14:03:25 -07004227 */
Christopher Tated5cf7222014-07-29 16:53:09 -07004228 @SystemApi
Christopher Tate487529a2009-04-29 14:03:25 -07004229 public static final String BACKUP_SERVICE = "backup";
Dan Egnor95240272009-10-27 18:23:39 -07004230
4231 /**
Richard Uhlerb29f1452018-09-12 16:38:15 +01004232 * Use with {@link #getSystemService(String)} to retrieve an
4233 * {@link android.content.rollback.RollbackManager} for communicating
4234 * with the rollback manager
4235 *
4236 * @see #getSystemService(String)
Richard Uhlerc739c8c2018-12-12 11:03:34 +00004237 * @hide
Richard Uhlerb29f1452018-09-12 16:38:15 +01004238 */
Richard Uhler8a977452019-03-08 13:27:17 +00004239 @SystemApi @TestApi
Richard Uhlerb29f1452018-09-12 16:38:15 +01004240 public static final String ROLLBACK_SERVICE = "rollback";
4241
4242 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004243 * Use with {@link #getSystemService(String)} to retrieve a
Dan Egnor1337b012010-01-04 11:01:44 -08004244 * {@link android.os.DropBoxManager} instance for recording
Dan Egnor95240272009-10-27 18:23:39 -07004245 * diagnostic logs.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004246 * @see #getSystemService(String)
Dan Egnor95240272009-10-27 18:23:39 -07004247 */
4248 public static final String DROPBOX_SERVICE = "dropbox";
4249
Christopher Tate487529a2009-04-29 14:03:25 -07004250 /**
Philip P. Moltmannf80809f2018-04-04 11:20:44 -07004251 * System service name for the DeviceIdleManager.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004252 * @see #getSystemService(String)
Dianne Hackborn1958e5e2015-06-12 18:11:41 -07004253 * @hide
4254 */
4255 public static final String DEVICE_IDLE_CONTROLLER = "deviceidle";
4256
4257 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004258 * Use with {@link #getSystemService(String)} to retrieve a
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08004259 * {@link android.app.admin.DevicePolicyManager} for working with global
Dianne Hackbornd6847842010-01-12 18:14:19 -08004260 * device policy management.
4261 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004262 * @see #getSystemService(String)
Dianne Hackbornd6847842010-01-12 18:14:19 -08004263 */
4264 public static final String DEVICE_POLICY_SERVICE = "device_policy";
4265
4266 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004267 * Use with {@link #getSystemService(String)} to retrieve a
Tobias Haamel53332882010-02-18 16:15:43 -08004268 * {@link android.app.UiModeManager} for controlling UI modes.
4269 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004270 * @see #getSystemService(String)
Tobias Haamel53332882010-02-18 16:15:43 -08004271 */
4272 public static final String UI_MODE_SERVICE = "uimode";
4273
4274 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004275 * Use with {@link #getSystemService(String)} to retrieve a
Steve Howardd58429f2010-09-27 16:32:39 -07004276 * {@link android.app.DownloadManager} for requesting HTTP downloads.
Steve Howarda2709362010-07-02 17:12:48 -07004277 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004278 * @see #getSystemService(String)
Steve Howarda2709362010-07-02 17:12:48 -07004279 */
4280 public static final String DOWNLOAD_SERVICE = "download";
4281
4282 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004283 * Use with {@link #getSystemService(String)} to retrieve a
Todd Poynore35872d2013-12-10 11:57:21 -08004284 * {@link android.os.BatteryManager} for managing battery state.
4285 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004286 * @see #getSystemService(String)
Todd Poynore35872d2013-12-10 11:57:21 -08004287 */
4288 public static final String BATTERY_SERVICE = "batterymanager";
4289
4290 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004291 * Use with {@link #getSystemService(String)} to retrieve a
Nick Pelly50b4d8f2010-12-07 22:40:28 -08004292 * {@link android.nfc.NfcManager} for using NFC.
4293 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004294 * @see #getSystemService(String)
Nick Pelly50b4d8f2010-12-07 22:40:28 -08004295 */
4296 public static final String NFC_SERVICE = "nfc";
4297
4298 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004299 * Use with {@link #getSystemService(String)} to retrieve a
Florian Salbrechter084da9b2015-03-25 11:00:55 +00004300 * {@link android.bluetooth.BluetoothManager} for using Bluetooth.
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08004301 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004302 * @see #getSystemService(String)
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08004303 */
4304 public static final String BLUETOOTH_SERVICE = "bluetooth";
4305
4306 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004307 * Use with {@link #getSystemService(String)} to retrieve a
Chung-yih Wang2d942312010-08-05 12:17:37 +08004308 * {@link android.net.sip.SipManager} for accessing the SIP related service.
4309 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004310 * @see #getSystemService(String)
Chung-yih Wang2d942312010-08-05 12:17:37 +08004311 */
4312 /** @hide */
4313 public static final String SIP_SERVICE = "sip";
4314
4315 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004316 * Use with {@link #getSystemService(String)} to retrieve a {@link
Mike Lockwoodc4308f02011-03-01 08:04:54 -08004317 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host)
Mike Lockwoode7d511e2010-12-30 13:39:37 -05004318 * and for controlling this device's behavior as a USB device.
4319 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004320 * @see #getSystemService(String)
John Spurlock6098c5d2013-06-17 10:32:46 -04004321 * @see android.hardware.usb.UsbManager
Mike Lockwoode7d511e2010-12-30 13:39:37 -05004322 */
4323 public static final String USB_SERVICE = "usb";
4324
4325 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004326 * Use with {@link #getSystemService(String)} to retrieve a {@link
Kenny Rootf74bfde2018-01-18 15:42:48 -08004327 * Use with {@link #getSystemService} to retrieve a {@link
4328 * android.debug.AdbManager} for access to ADB debug functions.
4329 *
4330 * @see #getSystemService(String)
4331 * @see android.debug.AdbManager
4332 *
4333 * @hide
4334 */
4335 public static final String ADB_SERVICE = "adb";
4336
4337 /**
4338 * Use with {@link #getSystemService(String)} to retrieve a {@link
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04004339 * android.hardware.SerialManager} for access to serial ports.
4340 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004341 * @see #getSystemService(String)
Dianne Hackborn35f72be2013-09-16 10:57:39 -07004342 * @see android.hardware.SerialManager
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04004343 *
4344 * @hide
4345 */
4346 public static final String SERIAL_SERVICE = "serial";
4347
4348 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004349 * Use with {@link #getSystemService(String)} to retrieve a
Jinsuk Kim91120c52014-05-08 17:12:51 +09004350 * {@link android.hardware.hdmi.HdmiControlManager} for controlling and managing
4351 * HDMI-CEC protocol.
4352 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004353 * @see #getSystemService(String)
Jinsuk Kim91120c52014-05-08 17:12:51 +09004354 * @see android.hardware.hdmi.HdmiControlManager
Jinsuk Kim66d1eb22014-06-06 16:12:18 +09004355 * @hide
Jinsuk Kim91120c52014-05-08 17:12:51 +09004356 */
Jinsuk Kim66d1eb22014-06-06 16:12:18 +09004357 @SystemApi
Jinsuk Kim91120c52014-05-08 17:12:51 +09004358 public static final String HDMI_CONTROL_SERVICE = "hdmi_control";
Jinsuk Kimfbcd5032014-03-21 16:25:13 +09004359
4360 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004361 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Brown9df6e7a2012-04-05 11:49:26 -07004362 * {@link android.hardware.input.InputManager} for interacting with input devices.
4363 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004364 * @see #getSystemService(String)
Jeff Brown9df6e7a2012-04-05 11:49:26 -07004365 * @see android.hardware.input.InputManager
4366 */
4367 public static final String INPUT_SERVICE = "input";
4368
4369 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004370 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Brownfa25bf52012-07-23 19:26:30 -07004371 * {@link android.hardware.display.DisplayManager} for interacting with display devices.
4372 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004373 * @see #getSystemService(String)
Jeff Brownfa25bf52012-07-23 19:26:30 -07004374 * @see android.hardware.display.DisplayManager
4375 */
4376 public static final String DISPLAY_SERVICE = "display";
4377
4378 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004379 * Use with {@link #getSystemService(String)} to retrieve a
Christine Franks39b03112018-07-03 14:46:07 -07004380 * {@link android.hardware.display.ColorDisplayManager} for controlling color transforms.
4381 *
4382 * @see #getSystemService(String)
4383 * @see android.hardware.display.ColorDisplayManager
4384 * @hide
4385 */
4386 public static final String COLOR_DISPLAY_SERVICE = "color_display";
4387
4388 /**
4389 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasani258848d2012-08-10 17:06:33 -07004390 * {@link android.os.UserManager} for managing users on devices that support multiple users.
4391 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004392 * @see #getSystemService(String)
Amith Yamasani258848d2012-08-10 17:06:33 -07004393 * @see android.os.UserManager
4394 */
4395 public static final String USER_SERVICE = "user";
4396
4397 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004398 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasani4f582632014-02-19 14:31:52 -08004399 * {@link android.content.pm.LauncherApps} for querying and monitoring launchable apps across
4400 * profiles of a user.
4401 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004402 * @see #getSystemService(String)
Amith Yamasani4f582632014-02-19 14:31:52 -08004403 * @see android.content.pm.LauncherApps
4404 */
4405 public static final String LAUNCHER_APPS_SERVICE = "launcherapps";
4406
4407 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004408 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasanif20d6402014-05-24 15:34:37 -07004409 * {@link android.content.RestrictionsManager} for retrieving application restrictions
4410 * and requesting permissions for restricted operations.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004411 * @see #getSystemService(String)
Amith Yamasanif20d6402014-05-24 15:34:37 -07004412 * @see android.content.RestrictionsManager
4413 */
4414 public static final String RESTRICTIONS_SERVICE = "restrictions";
4415
4416 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004417 * Use with {@link #getSystemService(String)} to retrieve a
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004418 * {@link android.app.AppOpsManager} for tracking application operations
4419 * on the device.
4420 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004421 * @see #getSystemService(String)
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004422 * @see android.app.AppOpsManager
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004423 */
4424 public static final String APP_OPS_SERVICE = "appops";
4425
4426 /**
Hai Zhangb7776682018-09-25 15:10:57 -07004427 * Use with {@link #getSystemService(String)} to retrieve a {@link android.app.role.RoleManager}
4428 * for managing roles.
4429 *
4430 * @see #getSystemService(String)
4431 * @see android.app.role.RoleManager
4432 */
4433 public static final String ROLE_SERVICE = "role";
4434
4435 /**
Hai Zhanga4959e52019-03-06 12:21:07 -08004436 * Official published name of the (internal) role controller service.
4437 *
4438 * @see #getSystemService(String)
4439 * @see android.app.role.RoleControllerService
4440 *
4441 * @hide
4442 */
4443 public static final String ROLE_CONTROLLER_SERVICE = "role_controller";
4444
4445 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004446 * Use with {@link #getSystemService(String)} to retrieve a
Eino-Ville Talvala2f1a2e42013-07-25 17:12:05 -07004447 * {@link android.hardware.camera2.CameraManager} for interacting with
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08004448 * camera devices.
4449 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004450 * @see #getSystemService(String)
Dianne Hackborn221ea892013-08-04 16:50:16 -07004451 * @see android.hardware.camera2.CameraManager
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08004452 */
4453 public static final String CAMERA_SERVICE = "camera";
4454
4455 /**
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004456 * {@link android.print.PrintManager} for printing and managing
Jeff Brown511cd352013-08-23 17:43:37 -07004457 * printers and print tasks.
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004458 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004459 * @see #getSystemService(String)
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004460 * @see android.print.PrintManager
4461 */
4462 public static final String PRINT_SERVICE = "print";
4463
4464 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004465 * Use with {@link #getSystemService(String)} to retrieve a
Eugene Susla6ed45d82017-01-22 13:52:51 -08004466 * {@link android.companion.CompanionDeviceManager} for managing companion devices
4467 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004468 * @see #getSystemService(String)
Eugene Susla6ed45d82017-01-22 13:52:51 -08004469 * @see android.companion.CompanionDeviceManager
4470 */
Eugene Suslad7355cc2017-04-20 11:14:45 -07004471 public static final String COMPANION_DEVICE_SERVICE = "companiondevice";
Eugene Susla6ed45d82017-01-22 13:52:51 -08004472
4473 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004474 * Use with {@link #getSystemService(String)} to retrieve a
Erik Gilling51e95df2013-06-26 11:06:51 -07004475 * {@link android.hardware.ConsumerIrManager} for transmitting infrared
4476 * signals from the device.
4477 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004478 * @see #getSystemService(String)
Erik Gilling51e95df2013-06-26 11:06:51 -07004479 * @see android.hardware.ConsumerIrManager
4480 */
4481 public static final String CONSUMER_IR_SERVICE = "consumer_ir";
4482
4483 /**
Adrian Roos82142c22014-03-27 14:56:59 +01004484 * {@link android.app.trust.TrustManager} for managing trust agents.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004485 * @see #getSystemService(String)
Adrian Roos82142c22014-03-27 14:56:59 +01004486 * @see android.app.trust.TrustManager
4487 * @hide
4488 */
4489 public static final String TRUST_SERVICE = "trust";
4490
4491 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004492 * Use with {@link #getSystemService(String)} to retrieve a
Jae Seod5cc4a22014-05-30 16:57:43 -07004493 * {@link android.media.tv.TvInputManager} for interacting with TV inputs
4494 * on the device.
Jae Seo39570912014-02-20 18:23:25 -08004495 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004496 * @see #getSystemService(String)
Jae Seod5cc4a22014-05-30 16:57:43 -07004497 * @see android.media.tv.TvInputManager
Jae Seo39570912014-02-20 18:23:25 -08004498 */
4499 public static final String TV_INPUT_SERVICE = "tv_input";
4500
4501 /**
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004502 * {@link android.net.NetworkScoreManager} for managing network scoring.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004503 * @see #getSystemService(String)
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004504 * @see android.net.NetworkScoreManager
4505 * @hide
4506 */
Jeff Davidson5ad20792014-07-21 13:55:42 -07004507 @SystemApi
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004508 public static final String NETWORK_SCORE_SERVICE = "network_score";
4509
4510 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004511 * Use with {@link #getSystemService(String)} to retrieve a {@link
Adam Lesinskiaa607672014-11-24 11:27:50 -08004512 * android.app.usage.UsageStatsManager} for querying device usage stats.
Dianne Hackborne22b3b12014-05-07 18:06:44 -07004513 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004514 * @see #getSystemService(String)
Dianne Hackbornff170242014-11-19 10:59:01 -08004515 * @see android.app.usage.UsageStatsManager
Dianne Hackborne22b3b12014-05-07 18:06:44 -07004516 */
4517 public static final String USAGE_STATS_SERVICE = "usagestats";
4518
4519 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004520 * Use with {@link #getSystemService(String)} to retrieve a {@link
Christopher Tate7060b042014-06-09 19:50:00 -07004521 * android.app.job.JobScheduler} instance for managing occasional
Christopher Tatefa380e92014-05-19 13:46:29 -07004522 * background tasks.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004523 * @see #getSystemService(String)
Christopher Tate7060b042014-06-09 19:50:00 -07004524 * @see android.app.job.JobScheduler
Christopher Tatefa380e92014-05-19 13:46:29 -07004525 */
Christopher Tate7060b042014-06-09 19:50:00 -07004526 public static final String JOB_SCHEDULER_SERVICE = "jobscheduler";
Christopher Tatefa380e92014-05-19 13:46:29 -07004527
4528 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004529 * Use with {@link #getSystemService(String)} to retrieve a {@link
Andres Morales33df9372014-09-26 17:08:59 -07004530 * android.service.persistentdata.PersistentDataBlockManager} instance
4531 * for interacting with a storage device that lives across factory resets.
4532 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004533 * @see #getSystemService(String)
Andres Morales68d4acd2014-07-01 19:40:41 -07004534 * @see android.service.persistentdata.PersistentDataBlockManager
4535 * @hide
4536 */
Andres Morales33df9372014-09-26 17:08:59 -07004537 @SystemApi
Andres Morales68d4acd2014-07-01 19:40:41 -07004538 public static final String PERSISTENT_DATA_BLOCK_SERVICE = "persistent_data_block";
4539
4540 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004541 * Use with {@link #getSystemService(String)} to retrieve a {@link
Andrew Scull3b8b46f2017-02-13 18:12:15 +00004542 * android.service.oemlock.OemLockManager} instance for managing the OEM lock.
4543 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004544 * @see #getSystemService(String)
Andrew Scull3b8b46f2017-02-13 18:12:15 +00004545 * @see android.service.oemlock.OemLockManager
4546 * @hide
4547 */
4548 @SystemApi
4549 public static final String OEM_LOCK_SERVICE = "oem_lock";
4550
4551 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004552 * Use with {@link #getSystemService(String)} to retrieve a {@link
Michael Wrightc39d47a2014-07-08 18:07:36 -07004553 * android.media.projection.MediaProjectionManager} instance for managing
4554 * media projection sessions.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004555 * @see #getSystemService(String)
Jeff Brown6e539312015-02-24 18:53:21 -08004556 * @see android.media.projection.MediaProjectionManager
Michael Wrightc39d47a2014-07-08 18:07:36 -07004557 */
4558 public static final String MEDIA_PROJECTION_SERVICE = "media_projection";
4559
4560 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004561 * Use with {@link #getSystemService(String)} to retrieve a
Mike Lockwoodb6737702015-02-20 08:28:47 -08004562 * {@link android.media.midi.MidiManager} for accessing the MIDI service.
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08004563 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004564 * @see #getSystemService(String)
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08004565 */
4566 public static final String MIDI_SERVICE = "midi";
4567
Eric Laurent2035ac82015-03-05 15:18:44 -08004568
4569 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004570 * Use with {@link #getSystemService(String)} to retrieve a
Eric Laurent2035ac82015-03-05 15:18:44 -08004571 * {@link android.hardware.radio.RadioManager} for accessing the broadcast radio service.
4572 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004573 * @see #getSystemService(String)
Eric Laurent2035ac82015-03-05 15:18:44 -08004574 * @hide
4575 */
Tomasz Wasilczyk9110df72017-06-22 07:57:20 -07004576 public static final String RADIO_SERVICE = "broadcastradio";
Eric Laurent2035ac82015-03-05 15:18:44 -08004577
Paul McLeana33be212015-02-20 07:52:45 -08004578 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004579 * Use with {@link #getSystemService(String)} to retrieve a
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004580 * {@link android.os.HardwarePropertiesManager} for accessing the hardware properties service.
4581 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004582 * @see #getSystemService(String)
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004583 */
Polina Bondarenko8333c732016-03-09 18:08:42 +01004584 public static final String HARDWARE_PROPERTIES_SERVICE = "hardware_properties";
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004585
4586 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004587 * Use with {@link #getSystemService(String)} to retrieve a
Wei Wangbad7c202018-11-01 11:57:39 -07004588 * {@link android.os.ThermalService} for accessing the thermal service.
4589 *
4590 * @see #getSystemService(String)
4591 * @hide
4592 */
4593 public static final String THERMAL_SERVICE = "thermalservice";
4594
4595 /**
4596 * Use with {@link #getSystemService(String)} to retrieve a
Makoto Onukib5a012f2016-06-21 11:13:53 -07004597 * {@link android.content.pm.ShortcutManager} for accessing the launcher shortcut service.
Makoto Onuki6f7362d92016-03-04 13:39:41 -08004598 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004599 * @see #getSystemService(String)
Makoto Onuki6f7362d92016-03-04 13:39:41 -08004600 * @see android.content.pm.ShortcutManager
4601 */
4602 public static final String SHORTCUT_SERVICE = "shortcut";
4603
4604 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004605 * Use with {@link #getSystemService(String)} to retrieve a {@link
Peng Xu9ff7d222016-02-11 13:02:05 -08004606 * android.hardware.location.ContextHubManager} for accessing context hubs.
4607 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004608 * @see #getSystemService(String)
Peng Xu9ff7d222016-02-11 13:02:05 -08004609 * @see android.hardware.location.ContextHubManager
4610 *
4611 * @hide
4612 */
4613 @SystemApi
4614 public static final String CONTEXTHUB_SERVICE = "contexthub";
4615
4616 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004617 * Use with {@link #getSystemService(String)} to retrieve a
Joe Onorato713fec82016-03-04 10:34:02 -08004618 * {@link android.os.health.SystemHealthManager} for accessing system health (battery, power,
4619 * memory, etc) metrics.
4620 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004621 * @see #getSystemService(String)
Joe Onorato713fec82016-03-04 10:34:02 -08004622 */
4623 public static final String SYSTEM_HEALTH_SERVICE = "systemhealth";
4624
4625 /**
Amith Yamasanid04aaa32016-06-13 12:09:36 -07004626 * Gatekeeper Service.
4627 * @hide
4628 */
4629 public static final String GATEKEEPER_SERVICE = "android.service.gatekeeper.IGateKeeperService";
4630
4631 /**
Svet Ganov37e43272016-09-09 16:01:32 -07004632 * Service defining the policy for access to device identifiers.
4633 * @hide
4634 */
4635 public static final String DEVICE_IDENTIFIERS_SERVICE = "device_identifiers";
4636
4637 /**
Joe Onorato1754d742016-11-21 17:51:35 -08004638 * Service to report a system health "incident"
4639 * @hide
4640 */
4641 public static final String INCIDENT_SERVICE = "incident";
4642
4643 /**
Joe Onoratoe21ab7e2018-12-18 15:00:25 -08004644 * Service to assist incidentd and dumpstated in reporting status to the user
4645 * and in confirming authorization to take an incident report or bugreport
4646 * @hide
4647 */
4648 public static final String INCIDENT_COMPANION_SERVICE = "incidentcompanion";
4649
4650 /**
Bookatz94726412017-08-31 09:26:15 -07004651 * Service to assist statsd in obtaining general stats.
4652 * @hide
4653 */
4654 public static final String STATS_COMPANION_SERVICE = "statscompanion";
4655
4656 /**
Bookatzc6977972018-01-16 16:55:05 -08004657 * Use with {@link #getSystemService(String)} to retrieve an {@link android.app.StatsManager}.
David Chenadaf8b32017-11-03 15:42:08 -07004658 * @hide
4659 */
4660 @SystemApi
4661 public static final String STATS_MANAGER = "stats";
4662
4663 /**
atrost8266ae32019-08-15 16:53:01 +01004664 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
4665 * {@link IPlatformCompat} IBinder for communicating with the platform compat service.
4666 * @hide
4667 */
4668 public static final String PLATFORM_COMPAT_SERVICE = "platform_compat";
4669
4670 /**
atrostff948d82019-10-10 19:27:31 +01004671 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
4672 * {@link IPlatformCompatNative} IBinder for native code communicating with the platform compat
4673 * service.
4674 * @hide
4675 */
4676 public static final String PLATFORM_COMPAT_NATIVE_SERVICE = "platform_compat_native";
4677
4678 /**
Nandana Duttd11850c2018-12-12 17:26:57 +00004679 * Service to capture a bugreport.
4680 * @see #getSystemService(String)
4681 * @see android.os.BugreportManager
4682 * @hide
4683 */
Nandana Duttd7e8d5a2019-04-11 17:27:45 +01004684 @SystemApi @TestApi
Nandana Duttd11850c2018-12-12 17:26:57 +00004685 public static final String BUGREPORT_SERVICE = "bugreport";
4686
4687 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004688 * Use with {@link #getSystemService(String)} to retrieve a {@link
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01004689 * android.content.om.OverlayManager} for managing overlay packages.
4690 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004691 * @see #getSystemService(String)
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01004692 * @see android.content.om.OverlayManager
4693 * @hide
4694 */
4695 public static final String OVERLAY_SERVICE = "overlay";
4696
4697 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004698 * Use with {@link #getSystemService(String)} to retrieve a
MÃ¥rten Kongstad06a1ac82018-09-20 13:09:47 +02004699 * {android.os.IIdmap2} for managing idmap files (used by overlay
4700 * packages).
4701 *
4702 * @see #getSystemService(String)
4703 * @hide
4704 */
4705 public static final String IDMAP_SERVICE = "idmap";
4706
4707 /**
4708 * Use with {@link #getSystemService(String)} to retrieve a
Zak Cohen56345f42017-01-26 13:54:28 -08004709 * {@link VrManager} for accessing the VR service.
4710 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004711 * @see #getSystemService(String)
Zak Cohen56345f42017-01-26 13:54:28 -08004712 * @hide
4713 */
4714 @SystemApi
4715 public static final String VR_SERVICE = "vrmanager";
4716
4717 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004718 * Use with {@link #getSystemService(String)} to retrieve an
Neil Fullerfe6ec562017-03-16 18:29:36 +00004719 * {@link android.app.timezone.ITimeZoneRulesManager}.
4720 * @hide
4721 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004722 * @see #getSystemService(String)
Neil Fullerfe6ec562017-03-16 18:29:36 +00004723 */
4724 public static final String TIME_ZONE_RULES_MANAGER_SERVICE = "timezone";
4725
4726 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004727 * Use with {@link #getSystemService(String)} to retrieve a
Tony Makb0d22622018-01-18 12:49:49 +00004728 * {@link android.content.pm.CrossProfileApps} for cross profile operations.
Tony Mak1b708e62017-10-12 10:59:11 +01004729 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004730 * @see #getSystemService(String)
Tony Mak1b708e62017-10-12 10:59:11 +01004731 */
4732 public static final String CROSS_PROFILE_APPS_SERVICE = "crossprofileapps";
4733
4734 /**
Ruchi Kandoi6149b0f2018-01-03 16:14:57 -08004735 * Use with {@link #getSystemService} to retrieve a
4736 * {@link android.se.omapi.ISecureElementService}
4737 * for accessing the SecureElementService.
4738 *
4739 * @hide
4740 */
4741 @SystemApi
4742 public static final String SECURE_ELEMENT_SERVICE = "secure_element";
4743
4744 /**
Neil Fullerfeeee682018-05-30 14:35:24 +01004745 * Use with {@link #getSystemService(String)} to retrieve an
4746 * {@link android.app.timedetector.ITimeDetectorService}.
4747 * @hide
4748 *
4749 * @see #getSystemService(String)
4750 */
4751 public static final String TIME_DETECTOR_SERVICE = "time_detector";
4752
4753 /**
Makoto Onukidf7e4812018-09-24 14:31:25 -07004754 * Binder service name for {@link AppBindingService}.
4755 * @hide
4756 */
4757 public static final String APP_BINDING_SERVICE = "app_binding";
4758
4759 /**
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004760 * Use with {@link #getSystemService(String)} to retrieve an
James.cf Lin2bc9cd42019-11-04 20:23:36 +08004761 * {@link android.telephony.ims.ImsManager}.
4762 * @hide
4763 */
4764 public static final String TELEPHONY_IMS_SERVICE = "telephony_ims";
4765
4766 /**
4767 * Use with {@link #getSystemService(String)} to retrieve an
Brad Ebingerd1cb3462019-06-20 14:20:01 -07004768 * {@link android.telephony.ims.RcsMessageManager}.
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004769 * @hide
4770 */
Brad Ebingerd1cb3462019-06-20 14:20:01 -07004771 public static final String TELEPHONY_RCS_MESSAGE_SERVICE = "ircsmessage";
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004772
Howard Chen0a947642019-01-07 14:10:44 +08004773 /**
4774 * Use with {@link #getSystemService(String)} to retrieve an
Po-Chien Hsueh4e908c22019-03-07 11:57:17 +08004775 * {@link android.os.image.DynamicSystemManager}.
Howard Chen0a947642019-01-07 14:10:44 +08004776 * @hide
4777 */
Po-Chien Hsueh4e908c22019-03-07 11:57:17 +08004778 public static final String DYNAMIC_SYSTEM_SERVICE = "dynamic_system";
Howard Chen0a947642019-01-07 14:10:44 +08004779
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004780 /**
Chen Xu1f1c25e2019-09-15 18:28:21 -07004781 * Use with {@link #getSystemService(String)} to retrieve an
Chen Xu8eb62f92019-10-13 17:30:32 -07004782 * {@link TelephonyRegistryManager}.
Chen Xu1f1c25e2019-09-15 18:28:21 -07004783 * @hide
4784 */
4785 @SystemApi
4786 public static final String TELEPHONY_REGISTRY_SERVICE = "telephony_registry";
4787
4788 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004789 * Determine whether the given permission is allowed for a particular
4790 * process and user ID running in the system.
4791 *
4792 * @param permission The name of the permission being checked.
4793 * @param pid The process ID being checked against. Must be > 0.
4794 * @param uid The user ID being checked against. A uid of 0 is the root
4795 * user, which will pass every permission check.
4796 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004797 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004798 * pid/uid is allowed that permission, or
4799 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4800 *
4801 * @see PackageManager#checkPermission(String, String)
4802 * @see #checkCallingPermission
4803 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004804 @CheckResult(suggest="#enforcePermission(String,int,int,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004805 @PackageManager.PermissionResult
4806 public abstract int checkPermission(@NonNull String permission, int pid, int uid);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004807
Dianne Hackbornff170242014-11-19 10:59:01 -08004808 /** @hide */
4809 @PackageManager.PermissionResult
Mathew Inwood5c0d3542018-08-14 13:54:31 +01004810 @UnsupportedAppUsage
Dianne Hackbornff170242014-11-19 10:59:01 -08004811 public abstract int checkPermission(@NonNull String permission, int pid, int uid,
4812 IBinder callerToken);
4813
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004814 /**
4815 * Determine whether the calling process of an IPC you are handling has been
4816 * granted a particular permission. This is basically the same as calling
4817 * {@link #checkPermission(String, int, int)} with the pid and uid returned
4818 * by {@link android.os.Binder#getCallingPid} and
4819 * {@link android.os.Binder#getCallingUid}. One important difference
4820 * is that if you are not currently processing an IPC, this function
4821 * will always fail. This is done to protect against accidentally
4822 * leaking permissions; you can use {@link #checkCallingOrSelfPermission}
4823 * to avoid this protection.
4824 *
4825 * @param permission The name of the permission being checked.
4826 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004827 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004828 * pid/uid is allowed that permission, or
4829 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4830 *
4831 * @see PackageManager#checkPermission(String, String)
4832 * @see #checkPermission
4833 * @see #checkCallingOrSelfPermission
4834 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004835 @CheckResult(suggest="#enforceCallingPermission(String,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004836 @PackageManager.PermissionResult
4837 public abstract int checkCallingPermission(@NonNull String permission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004838
4839 /**
4840 * Determine whether the calling process of an IPC <em>or you</em> have been
4841 * granted a particular permission. This is the same as
4842 * {@link #checkCallingPermission}, except it grants your own permissions
4843 * if you are not currently processing an IPC. Use with care!
4844 *
4845 * @param permission The name of the permission being checked.
4846 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004847 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004848 * pid/uid is allowed that permission, or
4849 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4850 *
4851 * @see PackageManager#checkPermission(String, String)
4852 * @see #checkPermission
4853 * @see #checkCallingPermission
4854 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004855 @CheckResult(suggest="#enforceCallingOrSelfPermission(String,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004856 @PackageManager.PermissionResult
4857 public abstract int checkCallingOrSelfPermission(@NonNull String permission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004858
4859 /**
Svetoslavc6d1c342015-02-26 14:44:43 -08004860 * Determine whether <em>you</em> have been granted a particular permission.
4861 *
4862 * @param permission The name of the permission being checked.
4863 *
4864 * @return {@link PackageManager#PERMISSION_GRANTED} if you have the
4865 * permission, or {@link PackageManager#PERMISSION_DENIED} if not.
4866 *
4867 * @see PackageManager#checkPermission(String, String)
4868 * @see #checkCallingPermission(String)
4869 */
4870 @PackageManager.PermissionResult
4871 public abstract int checkSelfPermission(@NonNull String permission);
4872
4873 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004874 * If the given permission is not allowed for a particular process
4875 * and user ID running in the system, throw a {@link SecurityException}.
4876 *
4877 * @param permission The name of the permission being checked.
4878 * @param pid The process ID being checked against. Must be &gt; 0.
4879 * @param uid The user ID being checked against. A uid of 0 is the root
4880 * user, which will pass every permission check.
4881 * @param message A message to include in the exception if it is thrown.
4882 *
4883 * @see #checkPermission(String, int, int)
4884 */
4885 public abstract void enforcePermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004886 @NonNull String permission, int pid, int uid, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004887
4888 /**
4889 * If the calling process of an IPC you are handling has not been
4890 * granted a particular permission, throw a {@link
4891 * SecurityException}. This is basically the same as calling
4892 * {@link #enforcePermission(String, int, int, String)} with the
4893 * pid and uid returned by {@link android.os.Binder#getCallingPid}
4894 * and {@link android.os.Binder#getCallingUid}. One important
4895 * difference is that if you are not currently processing an IPC,
4896 * this function will always throw the SecurityException. This is
4897 * done to protect against accidentally leaking permissions; you
4898 * can use {@link #enforceCallingOrSelfPermission} to avoid this
4899 * protection.
4900 *
4901 * @param permission The name of the permission being checked.
4902 * @param message A message to include in the exception if it is thrown.
4903 *
4904 * @see #checkCallingPermission(String)
4905 */
4906 public abstract void enforceCallingPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004907 @NonNull String permission, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004908
4909 /**
4910 * If neither you nor the calling process of an IPC you are
4911 * handling has been granted a particular permission, throw a
4912 * {@link SecurityException}. This is the same as {@link
4913 * #enforceCallingPermission}, except it grants your own
4914 * permissions if you are not currently processing an IPC. Use
4915 * with care!
4916 *
4917 * @param permission The name of the permission being checked.
4918 * @param message A message to include in the exception if it is thrown.
4919 *
4920 * @see #checkCallingOrSelfPermission(String)
4921 */
4922 public abstract void enforceCallingOrSelfPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004923 @NonNull String permission, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004924
4925 /**
4926 * Grant permission to access a specific Uri to another package, regardless
4927 * of whether that package has general permission to access the Uri's
4928 * content provider. This can be used to grant specific, temporary
4929 * permissions, typically in response to user interaction (such as the
4930 * user opening an attachment that you would like someone else to
4931 * display).
4932 *
4933 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
4934 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
4935 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
4936 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to
4937 * start an activity instead of this function directly. If you use this
4938 * function directly, you should be sure to call
4939 * {@link #revokeUriPermission} when the target should no longer be allowed
4940 * to access it.
4941 *
4942 * <p>To succeed, the content provider owning the Uri must have set the
4943 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions
4944 * grantUriPermissions} attribute in its manifest or included the
4945 * {@link android.R.styleable#AndroidManifestGrantUriPermission
4946 * &lt;grant-uri-permissions&gt;} tag.
4947 *
4948 * @param toPackage The package you would like to allow to access the Uri.
4949 * @param uri The Uri you would like to grant access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004950 * @param modeFlags The desired access modes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004951 *
4952 * @see #revokeUriPermission
4953 */
4954 public abstract void grantUriPermission(String toPackage, Uri uri,
Tor Norbyed9273d62013-05-30 15:59:53 -07004955 @Intent.GrantUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004956
4957 /**
4958 * Remove all permissions to access a particular content provider Uri
Dianne Hackborna47223f2017-03-30 13:49:13 -07004959 * that were previously added with {@link #grantUriPermission} or <em>any other</em> mechanism.
4960 * The given Uri will match all previously granted Uris that are the same or a
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004961 * sub-path of the given Uri. That is, revoking "content://foo/target" will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004962 * revoke both "content://foo/target" and "content://foo/target/sub", but not
Jeff Sharkey846318a2014-04-04 12:12:41 -07004963 * "content://foo". It will not remove any prefix grants that exist at a
4964 * higher level.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004965 *
Dianne Hackborn955d8d62014-10-07 20:17:19 -07004966 * <p>Prior to {@link android.os.Build.VERSION_CODES#LOLLIPOP}, if you did not have
Dianne Hackborn192679a2014-09-10 14:28:48 -07004967 * regular permission access to a Uri, but had received access to it through
4968 * a specific Uri permission grant, you could not revoke that grant with this
4969 * function and a {@link SecurityException} would be thrown. As of
Dianne Hackborna47223f2017-03-30 13:49:13 -07004970 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this function will not throw a security
4971 * exception, but will remove whatever permission grants to the Uri had been given to the app
Dianne Hackborn192679a2014-09-10 14:28:48 -07004972 * (or none).</p>
4973 *
Dianne Hackborna47223f2017-03-30 13:49:13 -07004974 * <p>Unlike {@link #revokeUriPermission(String, Uri, int)}, this method impacts all permission
4975 * grants matching the given Uri, for any package they had been granted to, through any
4976 * mechanism this had happened (such as indirectly through the clipboard, activity launch,
4977 * service start, etc). That means this can be potentially dangerous to use, as it can
4978 * revoke grants that another app could be strongly expecting to stick around.</p>
4979 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004980 * @param uri The Uri you would like to revoke access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004981 * @param modeFlags The access modes to revoke.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004982 *
4983 * @see #grantUriPermission
4984 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004985 public abstract void revokeUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004986
4987 /**
Dianne Hackborna47223f2017-03-30 13:49:13 -07004988 * Remove permissions to access a particular content provider Uri
4989 * that were previously added with {@link #grantUriPermission} for a specific target
4990 * package. The given Uri will match all previously granted Uris that are the same or a
4991 * sub-path of the given Uri. That is, revoking "content://foo/target" will
4992 * revoke both "content://foo/target" and "content://foo/target/sub", but not
4993 * "content://foo". It will not remove any prefix grants that exist at a
4994 * higher level.
4995 *
4996 * <p>Unlike {@link #revokeUriPermission(Uri, int)}, this method will <em>only</em>
4997 * revoke permissions that had been explicitly granted through {@link #grantUriPermission}
4998 * and only for the package specified. Any matching grants that have happened through
4999 * other mechanisms (clipboard, activity launching, service starting, etc) will not be
5000 * removed.</p>
5001 *
5002 * @param toPackage The package you had previously granted access to.
5003 * @param uri The Uri you would like to revoke access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005004 * @param modeFlags The access modes to revoke.
Dianne Hackborna47223f2017-03-30 13:49:13 -07005005 *
5006 * @see #grantUriPermission
5007 */
5008 public abstract void revokeUriPermission(String toPackage, Uri uri,
5009 @Intent.AccessUriMode int modeFlags);
5010
5011 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005012 * Determine whether a particular process and user ID has been granted
5013 * permission to access a specific URI. This only checks for permissions
5014 * that have been explicitly granted -- if the given process/uid has
5015 * more general access to the URI's content provider then this check will
5016 * always fail.
5017 *
5018 * @param uri The uri that is being checked.
5019 * @param pid The process ID being checked against. Must be &gt; 0.
5020 * @param uid The user ID being checked against. A uid of 0 is the root
5021 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005022 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005023 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005024 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005025 * pid/uid is allowed to access that uri, or
5026 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5027 *
5028 * @see #checkCallingUriPermission
5029 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005030 @CheckResult(suggest="#enforceUriPermission(Uri,int,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005031 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005032 public abstract int checkUriPermission(Uri uri, int pid, int uid,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005033 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005034
Dianne Hackbornff170242014-11-19 10:59:01 -08005035 /** @hide */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005036 @PackageManager.PermissionResult
Dianne Hackbornff170242014-11-19 10:59:01 -08005037 public abstract int checkUriPermission(Uri uri, int pid, int uid,
5038 @Intent.AccessUriMode int modeFlags, IBinder callerToken);
5039
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005040 /**
5041 * Determine whether the calling process and user ID has been
5042 * granted permission to access a specific URI. This is basically
5043 * the same as calling {@link #checkUriPermission(Uri, int, int,
5044 * int)} with the pid and uid returned by {@link
5045 * android.os.Binder#getCallingPid} and {@link
5046 * android.os.Binder#getCallingUid}. One important difference is
5047 * that if you are not currently processing an IPC, this function
5048 * will always fail.
5049 *
5050 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005051 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005052 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005053 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005054 * is allowed to access that uri, or
5055 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5056 *
5057 * @see #checkUriPermission(Uri, int, int, int)
5058 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005059 @CheckResult(suggest="#enforceCallingUriPermission(Uri,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005060 @PackageManager.PermissionResult
Jeff Sharkey846318a2014-04-04 12:12:41 -07005061 public abstract int checkCallingUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005062
5063 /**
5064 * Determine whether the calling process of an IPC <em>or you</em> has been granted
5065 * permission to access a specific URI. This is the same as
5066 * {@link #checkCallingUriPermission}, except it grants your own permissions
5067 * if you are not currently processing an IPC. Use with care!
5068 *
5069 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005070 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005071 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005072 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005073 * is allowed to access that uri, or
5074 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5075 *
5076 * @see #checkCallingUriPermission
5077 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005078 @CheckResult(suggest="#enforceCallingOrSelfUriPermission(Uri,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005079 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005080 public abstract int checkCallingOrSelfUriPermission(Uri uri,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005081 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005082
5083 /**
5084 * Check both a Uri and normal permission. This allows you to perform
5085 * both {@link #checkPermission} and {@link #checkUriPermission} in one
5086 * call.
5087 *
5088 * @param uri The Uri whose permission is to be checked, or null to not
5089 * do this check.
5090 * @param readPermission The permission that provides overall read access,
5091 * or null to not do this check.
5092 * @param writePermission The permission that provides overall write
Tor Norbyed9273d62013-05-30 15:59:53 -07005093 * access, or null to not do this check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005094 * @param pid The process ID being checked against. Must be &gt; 0.
5095 * @param uid The user ID being checked against. A uid of 0 is the root
5096 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005097 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005098 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005099 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005100 * is allowed to access that uri or holds one of the given permissions, or
5101 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5102 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005103 @CheckResult(suggest="#enforceUriPermission(Uri,String,String,int,int,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005104 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005105 public abstract int checkUriPermission(@Nullable Uri uri, @Nullable String readPermission,
5106 @Nullable String writePermission, int pid, int uid,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005107 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005108
5109 /**
5110 * If a particular process and user ID has not been granted
5111 * permission to access a specific URI, throw {@link
5112 * SecurityException}. This only checks for permissions that have
5113 * been explicitly granted -- if the given process/uid has more
5114 * general access to the URI's content provider then this check
5115 * will always fail.
5116 *
5117 * @param uri The uri that is being checked.
5118 * @param pid The process ID being checked against. Must be &gt; 0.
5119 * @param uid The user ID being checked against. A uid of 0 is the root
5120 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005121 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005122 * @param message A message to include in the exception if it is thrown.
5123 *
5124 * @see #checkUriPermission(Uri, int, int, int)
5125 */
5126 public abstract void enforceUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005127 Uri uri, int pid, int uid, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005128
5129 /**
5130 * If the calling process and user ID has not been granted
5131 * permission to access a specific URI, throw {@link
5132 * SecurityException}. This is basically the same as calling
5133 * {@link #enforceUriPermission(Uri, int, int, int, String)} with
5134 * the pid and uid returned by {@link
5135 * android.os.Binder#getCallingPid} and {@link
5136 * android.os.Binder#getCallingUid}. One important difference is
5137 * that if you are not currently processing an IPC, this function
5138 * will always throw a SecurityException.
5139 *
5140 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005141 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005142 * @param message A message to include in the exception if it is thrown.
5143 *
5144 * @see #checkCallingUriPermission(Uri, int)
5145 */
5146 public abstract void enforceCallingUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005147 Uri uri, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005148
5149 /**
5150 * If the calling process of an IPC <em>or you</em> has not been
5151 * granted permission to access a specific URI, throw {@link
5152 * SecurityException}. This is the same as {@link
5153 * #enforceCallingUriPermission}, except it grants your own
5154 * permissions if you are not currently processing an IPC. Use
5155 * with care!
Scott Main4b5da682010-10-21 11:49:12 -07005156 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005157 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005158 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005159 * @param message A message to include in the exception if it is thrown.
5160 *
5161 * @see #checkCallingOrSelfUriPermission(Uri, int)
5162 */
5163 public abstract void enforceCallingOrSelfUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005164 Uri uri, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005165
5166 /**
5167 * Enforce both a Uri and normal permission. This allows you to perform
5168 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one
5169 * call.
Scott Main4b5da682010-10-21 11:49:12 -07005170 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005171 * @param uri The Uri whose permission is to be checked, or null to not
5172 * do this check.
5173 * @param readPermission The permission that provides overall read access,
5174 * or null to not do this check.
5175 * @param writePermission The permission that provides overall write
Tor Norbyed9273d62013-05-30 15:59:53 -07005176 * access, or null to not do this check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005177 * @param pid The process ID being checked against. Must be &gt; 0.
5178 * @param uid The user ID being checked against. A uid of 0 is the root
5179 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005180 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005181 * @param message A message to include in the exception if it is thrown.
5182 *
5183 * @see #checkUriPermission(Uri, String, String, int, int, int)
5184 */
5185 public abstract void enforceUriPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07005186 @Nullable Uri uri, @Nullable String readPermission,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005187 @Nullable String writePermission, int pid, int uid, @Intent.AccessUriMode int modeFlags,
Tor Norbyed9273d62013-05-30 15:59:53 -07005188 @Nullable String message);
5189
5190 /** @hide */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005191 @IntDef(flag = true, prefix = { "CONTEXT_" }, value = {
5192 CONTEXT_INCLUDE_CODE,
5193 CONTEXT_IGNORE_SECURITY,
5194 CONTEXT_RESTRICTED,
5195 CONTEXT_DEVICE_PROTECTED_STORAGE,
5196 CONTEXT_CREDENTIAL_PROTECTED_STORAGE,
5197 CONTEXT_REGISTER_PACKAGE,
5198 })
Tor Norbyed9273d62013-05-30 15:59:53 -07005199 @Retention(RetentionPolicy.SOURCE)
5200 public @interface CreatePackageOptions {}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005201
5202 /**
5203 * Flag for use with {@link #createPackageContext}: include the application
5204 * code with the context. This means loading code into the caller's
5205 * process, so that {@link #getClassLoader()} can be used to instantiate
5206 * the application's classes. Setting this flags imposes security
5207 * restrictions on what application context you can access; if the
5208 * requested application can not be safely loaded into your process,
5209 * java.lang.SecurityException will be thrown. If this flag is not set,
5210 * there will be no restrictions on the packages that can be loaded,
5211 * but {@link #getClassLoader} will always return the default system
5212 * class loader.
5213 */
5214 public static final int CONTEXT_INCLUDE_CODE = 0x00000001;
5215
5216 /**
5217 * Flag for use with {@link #createPackageContext}: ignore any security
5218 * restrictions on the Context being requested, allowing it to always
5219 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code
5220 * to be loaded into a process even when it isn't safe to do so. Use
5221 * with extreme care!
5222 */
5223 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002;
Scott Main4b5da682010-10-21 11:49:12 -07005224
Romain Guy870e09f2009-07-06 16:35:25 -07005225 /**
5226 * Flag for use with {@link #createPackageContext}: a restricted context may
5227 * disable specific features. For instance, a View associated with a restricted
5228 * context would ignore particular XML attributes.
5229 */
5230 public static final int CONTEXT_RESTRICTED = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005231
5232 /**
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005233 * Flag for use with {@link #createPackageContext}: point all file APIs at
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005234 * device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005235 *
5236 * @hide
5237 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005238 public static final int CONTEXT_DEVICE_PROTECTED_STORAGE = 0x00000008;
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005239
5240 /**
5241 * Flag for use with {@link #createPackageContext}: point all file APIs at
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005242 * credential-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005243 *
5244 * @hide
5245 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005246 public static final int CONTEXT_CREDENTIAL_PROTECTED_STORAGE = 0x00000010;
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005247
5248 /**
Dianne Hackbornfee756f2014-07-16 17:31:10 -07005249 * @hide Used to indicate we should tell the activity manager about the process
5250 * loading this code.
5251 */
5252 public static final int CONTEXT_REGISTER_PACKAGE = 0x40000000;
5253
5254 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005255 * Return a new Context object for the given application name. This
5256 * Context is the same as what the named application gets when it is
5257 * launched, containing the same resources and class loader. Each call to
5258 * this method returns a new instance of a Context object; Context objects
5259 * are not shared, however they share common state (Resources, ClassLoader,
5260 * etc) so the Context instance itself is fairly lightweight.
5261 *
Jeff Brown6e539312015-02-24 18:53:21 -08005262 * <p>Throws {@link android.content.pm.PackageManager.NameNotFoundException} if there is no
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005263 * application with the given package name.
5264 *
5265 * <p>Throws {@link java.lang.SecurityException} if the Context requested
5266 * can not be loaded into the caller's process for security reasons (see
5267 * {@link #CONTEXT_INCLUDE_CODE} for more information}.
5268 *
5269 * @param packageName Name of the application's package.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005270 * @param flags Option flags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005271 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005272 * @return A {@link Context} for the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005273 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005274 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005275 * @throws PackageManager.NameNotFoundException if there is no application with
John Spurlock6098c5d2013-06-17 10:32:46 -04005276 * the given package name.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005277 */
5278 public abstract Context createPackageContext(String packageName,
Tor Norbyed9273d62013-05-30 15:59:53 -07005279 @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Romain Guy870e09f2009-07-06 16:35:25 -07005280
5281 /**
Jeff Sharkey6d515712012-09-20 16:06:08 -07005282 * Similar to {@link #createPackageContext(String, int)}, but with a
5283 * different {@link UserHandle}. For example, {@link #getContentResolver()}
5284 * will open any {@link Uri} as the given user.
5285 *
5286 * @hide
5287 */
Patrick Baumannef4c4072018-02-01 08:54:05 -08005288 @SystemApi
Jeff Sharkeyec5f7d12018-08-08 09:15:04 -06005289 @TestApi
Makoto Onuki9432f7d2019-10-09 15:33:11 -07005290 @NonNull
Patrick Baumannef4c4072018-02-01 08:54:05 -08005291 public Context createPackageContextAsUser(
Makoto Onuki9432f7d2019-10-09 15:33:11 -07005292 @NonNull String packageName, @CreatePackageOptions int flags, @NonNull UserHandle user)
Patrick Baumannef4c4072018-02-01 08:54:05 -08005293 throws PackageManager.NameNotFoundException {
5294 if (Build.IS_ENG) {
5295 throw new IllegalStateException("createPackageContextAsUser not overridden!");
5296 }
5297 return this;
5298 }
Jeff Sharkey6d515712012-09-20 16:06:08 -07005299
5300 /**
Makoto Onuki9432f7d2019-10-09 15:33:11 -07005301 * Similar to {@link #createPackageContext(String, int)}, but for the own package with a
5302 * different {@link UserHandle}. For example, {@link #getContentResolver()}
5303 * will open any {@link Uri} as the given user.
5304 *
5305 * @hide
5306 */
5307 @SystemApi
5308 @TestApi
5309 @NonNull
Makoto Onuki6b1e9d22019-10-11 20:19:58 -07005310 public Context createContextAsUser(@NonNull UserHandle user, @CreatePackageOptions int flags) {
Makoto Onuki9432f7d2019-10-09 15:33:11 -07005311 if (Build.IS_ENG) {
5312 throw new IllegalStateException("createContextAsUser not overridden!");
5313 }
5314 return this;
5315 }
5316
5317 /**
Svetoslav976e8bd2014-07-16 15:12:03 -07005318 * Creates a context given an {@link android.content.pm.ApplicationInfo}.
5319 *
5320 * @hide
5321 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005322 @UnsupportedAppUsage
Svetoslav976e8bd2014-07-16 15:12:03 -07005323 public abstract Context createApplicationContext(ApplicationInfo application,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005324 @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Svetoslav976e8bd2014-07-16 15:12:03 -07005325
5326 /**
Adam Lesinski4e862812016-11-21 16:02:24 -08005327 * Return a new Context object for the given split name. The new Context has a ClassLoader and
5328 * Resources object that can access the split's and all of its dependencies' code/resources.
5329 * Each call to this method returns a new instance of a Context object;
5330 * Context objects are not shared, however common state (ClassLoader, other Resources for
5331 * the same split) may be so the Context itself can be fairly lightweight.
5332 *
5333 * @param splitName The name of the split to include, as declared in the split's
5334 * <code>AndroidManifest.xml</code>.
5335 * @return A {@link Context} with the given split's code and/or resources loaded.
5336 */
5337 public abstract Context createContextForSplit(String splitName)
5338 throws PackageManager.NameNotFoundException;
5339
5340 /**
Jeff Sharkeyad357d12018-02-02 13:25:31 -07005341 * Get the user associated with this context
Jim Millera75a8832013-02-07 16:53:32 -08005342 * @hide
5343 */
Jeff Sharkeya73b8fd2016-01-06 17:02:08 -07005344 @TestApi
Jeff Sharkeyad357d12018-02-02 13:25:31 -07005345 public UserHandle getUser() {
5346 return android.os.Process.myUserHandle();
5347 }
5348
5349 /**
5350 * Get the user associated with this context
5351 * @hide
5352 */
Artur Satayev5a525852019-10-31 15:15:50 +00005353 @UnsupportedAppUsage
Jeff Sharkeyad357d12018-02-02 13:25:31 -07005354 @TestApi
5355 public @UserIdInt int getUserId() {
5356 return android.os.UserHandle.myUserId();
5357 }
Jim Millera75a8832013-02-07 16:53:32 -08005358
5359 /**
Dianne Hackborn756220b2012-08-14 16:45:30 -07005360 * Return a new Context object for the current Context but whose resources
5361 * are adjusted to match the given Configuration. Each call to this method
Jeff Browna492c3a2012-08-23 19:48:44 -07005362 * returns a new instance of a Context object; Context objects are not
Dianne Hackborn756220b2012-08-14 16:45:30 -07005363 * shared, however common state (ClassLoader, other Resources for the
5364 * same configuration) may be so the Context itself can be fairly lightweight.
5365 *
5366 * @param overrideConfiguration A {@link Configuration} specifying what
5367 * values to modify in the base Configuration of the original Context's
5368 * resources. If the base configuration changes (such as due to an
5369 * orientation change), the resources of this context will also change except
5370 * for those that have been explicitly overridden with a value here.
5371 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005372 * @return A {@link Context} with the given configuration override.
Dianne Hackborn756220b2012-08-14 16:45:30 -07005373 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005374 public abstract Context createConfigurationContext(
5375 @NonNull Configuration overrideConfiguration);
Dianne Hackborn756220b2012-08-14 16:45:30 -07005376
5377 /**
Jeff Browna492c3a2012-08-23 19:48:44 -07005378 * Return a new Context object for the current Context but whose resources
5379 * are adjusted to match the metrics of the given Display. Each call to this method
5380 * returns a new instance of a Context object; Context objects are not
5381 * shared, however common state (ClassLoader, other Resources for the
5382 * same configuration) may be so the Context itself can be fairly lightweight.
5383 *
5384 * The returned display Context provides a {@link WindowManager}
5385 * (see {@link #getSystemService(String)}) that is configured to show windows
5386 * on the given display. The WindowManager's {@link WindowManager#getDefaultDisplay}
5387 * method can be used to retrieve the Display from the returned Context.
5388 *
5389 * @param display A {@link Display} object specifying the display
5390 * for whose metrics the Context's resources should be tailored and upon which
5391 * new windows should be shown.
5392 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005393 * @return A {@link Context} for the display.
Jeff Browna492c3a2012-08-23 19:48:44 -07005394 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005395 public abstract Context createDisplayContext(@NonNull Display display);
Jeff Browna492c3a2012-08-23 19:48:44 -07005396
5397 /**
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005398 * Return a new Context object for the current Context but whose storage
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005399 * APIs are backed by device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005400 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06005401 * On devices with direct boot, data stored in this location is encrypted
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005402 * with a key tied to the physical device, and it can be accessed
5403 * immediately after the device has booted successfully, both
5404 * <em>before and after</em> the user has authenticated with their
5405 * credentials (such as a lock pattern or PIN).
5406 * <p>
5407 * Because device-protected data is available without user authentication,
5408 * you should carefully limit the data you store using this Context. For
5409 * example, storing sensitive authentication tokens or passwords in the
5410 * device-protected area is strongly discouraged.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005411 * <p>
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005412 * If the underlying device does not have the ability to store
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005413 * device-protected and credential-protected data using different keys, then
5414 * both storage areas will become available at the same time. They remain as
5415 * two distinct storage locations on disk, and only the window of
5416 * availability changes.
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005417 * <p>
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005418 * Each call to this method returns a new instance of a Context object;
5419 * Context objects are not shared, however common state (ClassLoader, other
5420 * Resources for the same configuration) may be so the Context itself can be
5421 * fairly lightweight.
5422 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005423 * @see #isDeviceProtectedStorage()
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005424 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005425 public abstract Context createDeviceProtectedStorageContext();
5426
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005427 /**
5428 * Return a new Context object for the current Context but whose storage
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005429 * APIs are backed by credential-protected storage. This is the default
5430 * storage area for apps unless
5431 * {@link android.R.attr#defaultToDeviceProtectedStorage} was requested.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005432 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06005433 * On devices with direct boot, data stored in this location is encrypted
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005434 * with a key tied to user credentials, which can be accessed
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005435 * <em>only after</em> the user has entered their credentials (such as a
5436 * lock pattern or PIN).
5437 * <p>
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005438 * If the underlying device does not have the ability to store
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005439 * device-protected and credential-protected data using different keys, then
5440 * both storage areas will become available at the same time. They remain as
5441 * two distinct storage locations on disk, and only the window of
5442 * availability changes.
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005443 * <p>
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005444 * Each call to this method returns a new instance of a Context object;
5445 * Context objects are not shared, however common state (ClassLoader, other
5446 * Resources for the same configuration) may be so the Context itself can be
5447 * fairly lightweight.
5448 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005449 * @see #isCredentialProtectedStorage()
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005450 * @hide
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005451 */
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005452 @SystemApi
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005453 public abstract Context createCredentialProtectedStorageContext();
5454
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005455 /**
Craig Mautner48d0d182013-06-11 07:53:06 -07005456 * Gets the display adjustments holder for this context. This information
5457 * is provided on a per-application or activity basis and is used to simulate lower density
5458 * display metrics for legacy applications and restricted screen sizes.
Jeff Brown98365d72012-08-19 20:30:52 -07005459 *
Jeff Browna492c3a2012-08-23 19:48:44 -07005460 * @param displayId The display id for which to get compatibility info.
Jeff Brown98365d72012-08-19 20:30:52 -07005461 * @return The compatibility info holder, or null if not required by the application.
5462 * @hide
5463 */
Craig Mautner48d0d182013-06-11 07:53:06 -07005464 public abstract DisplayAdjustments getDisplayAdjustments(int displayId);
Jeff Brown98365d72012-08-19 20:30:52 -07005465
5466 /**
Wale Ogunwale691af682019-02-11 03:09:10 -08005467 * @return Returns the {@link Display} object this context is associated with.
Adam Lesinski4ece3d62016-06-16 18:05:41 -07005468 * @hide
5469 */
Artur Satayev5a525852019-10-31 15:15:50 +00005470 @UnsupportedAppUsage
Wale Ogunwale691af682019-02-11 03:09:10 -08005471 @TestApi
Adam Lesinski4ece3d62016-06-16 18:05:41 -07005472 public abstract Display getDisplay();
5473
5474 /**
Yohei Yukawa5281b6b2018-10-15 07:38:25 +08005475 * Gets the display ID.
5476 *
5477 * @return display ID associated with this {@link Context}.
5478 * @hide
5479 */
wilsonshih5db7b392019-02-20 23:08:45 +08005480 @TestApi
Yohei Yukawa5281b6b2018-10-15 07:38:25 +08005481 public abstract int getDisplayId();
5482
5483 /**
Andrii Kulianb047b8b2017-02-08 18:38:26 -08005484 * @hide
5485 */
5486 public abstract void updateDisplay(int displayId);
5487
5488 /**
Romain Guy870e09f2009-07-06 16:35:25 -07005489 * Indicates whether this Context is restricted.
Scott Main4b5da682010-10-21 11:49:12 -07005490 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005491 * @return {@code true} if this Context is restricted, {@code false} otherwise.
Scott Main4b5da682010-10-21 11:49:12 -07005492 *
Romain Guy870e09f2009-07-06 16:35:25 -07005493 * @see #CONTEXT_RESTRICTED
5494 */
5495 public boolean isRestricted() {
5496 return false;
5497 }
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005498
5499 /**
5500 * Indicates if the storage APIs of this Context are backed by
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005501 * device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005502 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005503 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005504 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005505 public abstract boolean isDeviceProtectedStorage();
5506
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005507 /**
5508 * Indicates if the storage APIs of this Context are backed by
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005509 * credential-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005510 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005511 * @see #createCredentialProtectedStorageContext()
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005512 * @hide
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005513 */
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005514 @SystemApi
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005515 public abstract boolean isCredentialProtectedStorage();
5516
Tony Mak46aabe52016-11-14 12:53:06 +00005517 /**
Seigo Nonaka6d6cd682017-06-22 08:22:18 -07005518 * Returns true if the context can load unsafe resources, e.g. fonts.
5519 * @hide
5520 */
5521 public abstract boolean canLoadUnsafeResources();
5522
5523 /**
Tony Mak46aabe52016-11-14 12:53:06 +00005524 * @hide
5525 */
5526 public IBinder getActivityToken() {
5527 throw new RuntimeException("Not implemented. Must override in a subclass.");
5528 }
5529
5530 /**
5531 * @hide
5532 */
5533 @Nullable
5534 public IServiceConnection getServiceDispatcher(ServiceConnection conn, Handler handler,
5535 int flags) {
5536 throw new RuntimeException("Not implemented. Must override in a subclass.");
5537 }
5538
5539 /**
5540 * @hide
5541 */
5542 public IApplicationThread getIApplicationThread() {
5543 throw new RuntimeException("Not implemented. Must override in a subclass.");
5544 }
Tony Makbf9928d2016-12-22 11:02:45 +00005545
5546 /**
5547 * @hide
5548 */
5549 public Handler getMainThreadHandler() {
5550 throw new RuntimeException("Not implemented. Must override in a subclass.");
5551 }
Adam Lesinskia82b6262017-03-21 16:56:17 -07005552
5553 /**
Felipe Lemebb567ae2017-10-04 09:56:21 -07005554 * @hide
5555 */
5556 public AutofillClient getAutofillClient() {
5557 return null;
5558 }
5559
5560 /**
5561 * @hide
5562 */
Svet Ganov47b37aa2018-02-16 00:11:39 -08005563 public void setAutofillClient(@SuppressWarnings("unused") AutofillClient client) {
Felipe Lemebb567ae2017-10-04 09:56:21 -07005564 }
5565
5566 /**
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005567 * @hide
5568 */
Felipe Lemecbf7f262019-04-17 13:57:59 -07005569 @Nullable
5570 public ContentCaptureClient getContentCaptureClient() {
5571 return null;
5572 }
5573
5574 /**
5575 * @hide
5576 */
Felipe Lemea4f39cd2019-02-19 15:08:59 -08005577 public final boolean isAutofillCompatibilityEnabled() {
5578 final AutofillOptions options = getAutofillOptions();
5579 return options != null && options.compatModeEnabled;
5580 }
5581
5582 /**
5583 * @hide
5584 */
5585 @Nullable
5586 public AutofillOptions getAutofillOptions() {
5587 return null;
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005588 }
5589
5590 /**
5591 * @hide
5592 */
Svet Ganov47b37aa2018-02-16 00:11:39 -08005593 @TestApi
Felipe Lemea4f39cd2019-02-19 15:08:59 -08005594 public void setAutofillOptions(@SuppressWarnings("unused") @Nullable AutofillOptions options) {
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005595 }
5596
5597 /**
Felipe Leme326f15a2019-02-19 09:42:24 -08005598 * Gets the Content Capture options for this context, or {@code null} if it's not whitelisted.
Felipe Lemeecb08be2018-11-27 15:48:47 -08005599 *
5600 * @hide
5601 */
Felipe Leme326f15a2019-02-19 09:42:24 -08005602 @Nullable
5603 public ContentCaptureOptions getContentCaptureOptions() {
5604 return null;
Felipe Lemeecb08be2018-11-27 15:48:47 -08005605 }
5606
5607 /**
5608 * @hide
5609 */
Felipe Leme326f15a2019-02-19 09:42:24 -08005610 @TestApi
5611 public void setContentCaptureOptions(
5612 @SuppressWarnings("unused") @Nullable ContentCaptureOptions options) {
Felipe Lemeecb08be2018-11-27 15:48:47 -08005613 }
5614
5615 /**
Adam Lesinskia82b6262017-03-21 16:56:17 -07005616 * Throws an exception if the Context is using system resources,
5617 * which are non-runtime-overlay-themable and may show inconsistent UI.
5618 * @hide
5619 */
5620 public void assertRuntimeOverlayThemable() {
5621 // Resources.getSystem() is a singleton and the only Resources not managed by
5622 // ResourcesManager; therefore Resources.getSystem() is not themable.
5623 if (getResources() == Resources.getSystem()) {
5624 throw new IllegalArgumentException("Non-UI context used to display UI; "
5625 + "get a UI context from ActivityThread#getSystemUiContext()");
5626 }
5627 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005628}