blob: 862ec5098d9adeb4463e1895c998bb52e531a67c [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 Xu1f6cfa52019-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;
atrost87488352019-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
Philip P. Moltmann59076d82019-08-19 15:00:40 -0700815 /**
816 * <p>Features are used in complex apps to logically separate parts of the app. E.g. a
817 * blogging app might also have a instant messaging app built in.
818 *
819 * @return the feature id this context is for or {@code null} if this is the default
820 * feature.
821 */
822 public @Nullable String getFeatureId() {
823 return null;
824 }
825
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -0700826 /** Return the full application info for this context's package. */
827 public abstract ApplicationInfo getApplicationInfo();
Scott Main4b5da682010-10-21 11:49:12 -0700828
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800829 /**
Kenny Root32148392010-01-21 15:40:47 -0800830 * Return the full path to this context's primary Android package.
831 * The Android package is a ZIP file which contains the application's
832 * primary resources.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800833 *
834 * <p>Note: this is not generally useful for applications, since they should
835 * not be directly accessing the file system.
836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800837 * @return String Path to the resources.
838 */
839 public abstract String getPackageResourcePath();
840
841 /**
Kenny Root32148392010-01-21 15:40:47 -0800842 * Return the full path to this context's primary Android package.
843 * The Android package is a ZIP file which contains application's
844 * primary code and assets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800845 *
846 * <p>Note: this is not generally useful for applications, since they should
847 * not be directly accessing the file system.
848 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800849 * @return String Path to the code and assets.
850 */
851 public abstract String getPackageCodePath();
852
853 /**
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700854 * @hide
855 * @deprecated use {@link #getSharedPreferencesPath(String)}
Joe Onorato23ecae32009-06-10 17:07:15 -0700856 */
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700857 @Deprecated
Mathew Inwood5c0d3542018-08-14 13:54:31 +0100858 @UnsupportedAppUsage
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700859 public File getSharedPrefsFile(String name) {
860 return getSharedPreferencesPath(name);
861 }
Joe Onorato23ecae32009-06-10 17:07:15 -0700862
863 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800864 * Retrieve and hold the contents of the preferences file 'name', returning
865 * a SharedPreferences through which you can retrieve and modify its
866 * values. Only one instance of the SharedPreferences object is returned
867 * to any callers for the same name, meaning they will see each other's
868 * edits as soon as they are made.
869 *
Nate Fischer5272c372019-08-27 16:37:00 -0700870 * <p>This method is thread-safe.
Jonathan Dormody1bca5db2017-11-16 11:25:20 -0700871 *
Nate Fischer5272c372019-08-27 16:37:00 -0700872 * <p>If the preferences directory does not already exist, it will be created when this method
873 * is called.
874 *
875 * <p>If a preferences file by this name does not exist, it will be created when you retrieve an
876 * editor ({@link SharedPreferences#edit()}) and then commit changes ({@link
877 * SharedPreferences.Editor#commit()} or {@link SharedPreferences.Editor#apply()}).
878 *
879 * @param name Desired preferences file.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600880 * @param mode Operating mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800881 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400882 * @return The single {@link SharedPreferences} instance that can be used
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800883 * to retrieve and modify the preference values.
884 *
885 * @see #MODE_PRIVATE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800886 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600887 public abstract SharedPreferences getSharedPreferences(String name, @PreferencesMode int mode);
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700888
889 /**
890 * Retrieve and hold the contents of the preferences file, returning
891 * a SharedPreferences through which you can retrieve and modify its
892 * values. Only one instance of the SharedPreferences object is returned
893 * to any callers for the same name, meaning they will see each other's
894 * edits as soon as they are made.
895 *
896 * @param file Desired preferences file. If a preferences file by this name
897 * does not exist, it will be created when you retrieve an
898 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600899 * @param mode Operating mode.
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700900 *
901 * @return The single {@link SharedPreferences} instance that can be used
902 * to retrieve and modify the preference values.
903 *
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -0700904 * @see #getSharedPreferencesPath(String)
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700905 * @see #MODE_PRIVATE
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -0600906 * @removed
Jeff Sharkey8fc29cf2015-11-30 17:51:00 -0700907 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600908 public abstract SharedPreferences getSharedPreferences(File file, @PreferencesMode int mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800909
910 /**
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600911 * Move an existing shared preferences file from the given source storage
Jeff Sharkey35871f22016-01-29 17:13:29 -0700912 * context to this context. This is typically used to migrate data between
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600913 * storage locations after an upgrade, such as moving to device protected
914 * storage.
Jeff Sharkey35871f22016-01-29 17:13:29 -0700915 *
916 * @param sourceContext The source context which contains the existing
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600917 * shared preferences to move.
Jeff Sharkey35871f22016-01-29 17:13:29 -0700918 * @param name The name of the shared preferences file.
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600919 * @return {@code true} if the move was successful or if the shared
Jeff Sharkey35871f22016-01-29 17:13:29 -0700920 * preferences didn't exist in the source context, otherwise
921 * {@code false}.
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600922 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey35871f22016-01-29 17:13:29 -0700923 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -0600924 public abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name);
925
Jeff Sharkey35871f22016-01-29 17:13:29 -0700926 /**
927 * Delete an existing shared preferences file.
928 *
929 * @param name The name (unique in the application package) of the shared
930 * preferences file.
931 * @return {@code true} if the shared preferences file was successfully
932 * deleted; else {@code false}.
933 * @see #getSharedPreferences(String, int)
934 */
935 public abstract boolean deleteSharedPreferences(String name);
936
Christopher Tatefe2368c2017-05-17 15:42:35 -0700937 /** @hide */
938 public abstract void reloadSharedPreferences();
939
Jeff Sharkey35871f22016-01-29 17:13:29 -0700940 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800941 * Open a private file associated with this Context's application package
942 * for reading.
943 *
944 * @param name The name of the file to open; can not contain path
945 * separators.
946 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400947 * @return The resulting {@link FileInputStream}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800948 *
949 * @see #openFileOutput
950 * @see #fileList
951 * @see #deleteFile
952 * @see java.io.FileInputStream#FileInputStream(String)
953 */
954 public abstract FileInputStream openFileInput(String name)
955 throws FileNotFoundException;
956
957 /**
Nick Kralevich15069212013-01-09 15:54:56 -0800958 * Open a private file associated with this Context's application package
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700959 * for writing. Creates the file if it doesn't already exist.
960 * <p>
961 * No additional permissions are required for the calling app to read or
962 * write the returned file.
Ricardo Cervera90a5f982014-04-04 10:26:05 -0700963 *
Nick Kralevich15069212013-01-09 15:54:56 -0800964 * @param name The name of the file to open; can not contain path
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700965 * separators.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600966 * @param mode Operating mode.
John Spurlock6098c5d2013-06-17 10:32:46 -0400967 * @return The resulting {@link FileOutputStream}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800968 * @see #MODE_APPEND
969 * @see #MODE_PRIVATE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800970 * @see #openFileInput
971 * @see #fileList
972 * @see #deleteFile
973 * @see java.io.FileOutputStream#FileOutputStream(String)
974 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -0600975 public abstract FileOutputStream openFileOutput(String name, @FileMode int mode)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800976 throws FileNotFoundException;
977
978 /**
979 * Delete the given private file associated with this Context's
980 * application package.
981 *
982 * @param name The name of the file to delete; can not contain path
983 * separators.
984 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400985 * @return {@code true} if the file was successfully deleted; else
986 * {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800987 *
988 * @see #openFileInput
989 * @see #openFileOutput
990 * @see #fileList
991 * @see java.io.File#delete()
992 */
993 public abstract boolean deleteFile(String name);
994
995 /**
996 * Returns the absolute path on the filesystem where a file created with
997 * {@link #openFileOutput} is stored.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -0700998 * <p>
999 * The returned path may change over time if the calling app is moved to an
1000 * adopted storage device, so only relative paths should be persisted.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001001 *
1002 * @param name The name of the file for which you would like to get
1003 * its path.
1004 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001005 * @return An absolute path to the given file.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001006 *
1007 * @see #openFileOutput
1008 * @see #getFilesDir
1009 * @see #getDir
1010 */
1011 public abstract File getFileStreamPath(String name);
1012
1013 /**
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -07001014 * Returns the absolute path on the filesystem where a file created with
1015 * {@link #getSharedPreferences(String, int)} is stored.
1016 * <p>
1017 * The returned path may change over time if the calling app is moved to an
1018 * adopted storage device, so only relative paths should be persisted.
1019 *
1020 * @param name The name of the shared preferences for which you would like
1021 * to get a path.
1022 * @return An absolute path to the given file.
1023 * @see #getSharedPreferences(String, int)
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001024 * @removed
Jeff Sharkey6a6cdaf2015-12-07 19:25:19 -07001025 */
1026 public abstract File getSharedPreferencesPath(String name);
1027
1028 /**
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001029 * Returns the absolute path to the directory on the filesystem where all
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001030 * private files belonging to this app are stored. Apps should not use this
1031 * path directly; they should instead use {@link #getFilesDir()},
1032 * {@link #getCacheDir()}, {@link #getDir(String, int)}, or other storage
1033 * APIs on this class.
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001034 * <p>
1035 * The returned path may change over time if the calling app is moved to an
1036 * adopted storage device, so only relative paths should be persisted.
1037 * <p>
1038 * No additional permissions are required for the calling app to read or
1039 * write files under the returned path.
1040 *
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001041 * @see ApplicationInfo#dataDir
Jeff Sharkey2c1ba9a2016-02-17 15:29:38 -07001042 */
1043 public abstract File getDataDir();
1044
1045 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001046 * Returns the absolute path to the directory on the filesystem where files
1047 * created with {@link #openFileOutput} are stored.
1048 * <p>
1049 * The returned path may change over time if the calling app is moved to an
1050 * adopted storage device, so only relative paths should be persisted.
1051 * <p>
1052 * No additional permissions are required for the calling app to read or
1053 * write files under the returned path.
Ricardo Cervera90a5f982014-04-04 10:26:05 -07001054 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001055 * @return The path of the directory holding application files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001056 * @see #openFileOutput
1057 * @see #getFileStreamPath
1058 * @see #getDir
1059 */
1060 public abstract File getFilesDir();
Scott Main4b5da682010-10-21 11:49:12 -07001061
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001062 /**
Christopher Tatea7835b62014-07-11 17:25:57 -07001063 * Returns the absolute path to the directory on the filesystem similar to
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001064 * {@link #getFilesDir()}. The difference is that files placed under this
1065 * directory will be excluded from automatic backup to remote storage. See
Christopher Tatea7835b62014-07-11 17:25:57 -07001066 * {@link android.app.backup.BackupAgent BackupAgent} for a full discussion
1067 * of the automatic backup mechanism in Android.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001068 * <p>
1069 * The returned path may change over time if the calling app is moved to an
1070 * adopted storage device, so only relative paths should be persisted.
1071 * <p>
1072 * No additional permissions are required for the calling app to read or
1073 * write files under the returned path.
Christopher Tatea7835b62014-07-11 17:25:57 -07001074 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001075 * @return The path of the directory holding application files that will not
1076 * be automatically backed up to remote storage.
Christopher Tatea7835b62014-07-11 17:25:57 -07001077 * @see #openFileOutput
1078 * @see #getFileStreamPath
1079 * @see #getDir
1080 * @see android.app.backup.BackupAgent
1081 */
1082 public abstract File getNoBackupFilesDir();
1083
1084 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001085 * Returns the absolute path to the directory on the primary shared/external
1086 * storage device where the application can place persistent files it owns.
1087 * These files are internal to the applications, and not typically visible
1088 * to the user as media.
1089 * <p>
1090 * This is like {@link #getFilesDir()} in that these files will be deleted
1091 * when the application is uninstalled, however there are some important
1092 * differences:
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001093 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001094 * <li>Shared storage may not always be available, since removable media can
1095 * be ejected by the user. Media state can be checked using
1096 * {@link Environment#getExternalStorageState(File)}.
1097 * <li>There is no security enforced with these files. For example, any
1098 * application holding
1099 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001100 * these files.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001101 * </ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001102 * <p>
1103 * If a shared storage device is emulated (as determined by
1104 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1105 * backed by a private user data partition, which means there is little
1106 * benefit to storing data here instead of the private directories returned
1107 * by {@link #getFilesDir()}, etc.
1108 * <p>
1109 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001110 * are required to read or write to the returned path; it's always
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001111 * accessible to the calling app. This only applies to paths generated for
1112 * package name of the calling application. To access paths belonging to
1113 * other packages,
1114 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or
1115 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required.
1116 * <p>
1117 * On devices with multiple users (as described by {@link UserManager}),
1118 * each user has their own isolated shared storage. Applications only have
1119 * access to the shared storage for the user they're running as.
1120 * <p>
1121 * The returned path may change over time if different shared storage media
1122 * is inserted, so only relative paths should be persisted.
1123 * <p>
1124 * Here is an example of typical code to manipulate a file in an
1125 * application's shared storage:
1126 * </p>
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001127 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
1128 * private_file}
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001129 * <p>
1130 * If you supply a non-null <var>type</var> to this function, the returned
1131 * file will be a path to a sub-directory of the given type. Though these
1132 * files are not automatically scanned by the media scanner, you can
1133 * explicitly add them to the media database with
1134 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[], android.media.MediaScannerConnection.OnScanCompletedListener)
1135 * MediaScannerConnection.scanFile}. Note that this is not the same as
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001136 * {@link android.os.Environment#getExternalStoragePublicDirectory
1137 * Environment.getExternalStoragePublicDirectory()}, which provides
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001138 * directories of media shared by all applications. The directories returned
1139 * here are owned by the application, and their contents will be removed
1140 * when the application is uninstalled. Unlike
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001141 * {@link android.os.Environment#getExternalStoragePublicDirectory
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001142 * Environment.getExternalStoragePublicDirectory()}, the directory returned
1143 * here will be automatically created for you.
1144 * <p>
1145 * Here is an example of typical code to manipulate a picture in an
1146 * application's shared storage and add it to the media database:
1147 * </p>
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001148 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
1149 * private_picture}
Jeff Sharkey8c165792012-10-22 14:08:29 -07001150 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001151 * @param type The type of files directory to return. May be {@code null}
1152 * for the root of the files directory or one of the following
1153 * constants for a subdirectory:
1154 * {@link android.os.Environment#DIRECTORY_MUSIC},
1155 * {@link android.os.Environment#DIRECTORY_PODCASTS},
1156 * {@link android.os.Environment#DIRECTORY_RINGTONES},
1157 * {@link android.os.Environment#DIRECTORY_ALARMS},
1158 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
1159 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
1160 * {@link android.os.Environment#DIRECTORY_MOVIES}.
1161 * @return the absolute path to application-specific directory. May return
1162 * {@code null} if shared storage is not currently available.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001163 * @see #getFilesDir
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001164 * @see #getExternalFilesDirs(String)
1165 * @see Environment#getExternalStorageState(File)
1166 * @see Environment#isExternalStorageEmulated(File)
1167 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001168 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001169 @Nullable
1170 public abstract File getExternalFilesDir(@Nullable String type);
Scott Main4b5da682010-10-21 11:49:12 -07001171
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001172 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001173 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001174 * shared/external storage devices where the application can place
1175 * persistent files it owns. These files are internal to the application,
1176 * and not typically visible to the user as media.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001177 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001178 * This is like {@link #getFilesDir()} in that these files will be deleted
1179 * when the application is uninstalled, however there are some important
1180 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001181 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001182 * <li>Shared storage may not always be available, since removable media can
1183 * be ejected by the user. Media state can be checked using
1184 * {@link Environment#getExternalStorageState(File)}.
1185 * <li>There is no security enforced with these files. For example, any
1186 * application holding
1187 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1188 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001189 * </ul>
1190 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001191 * If a shared storage device is emulated (as determined by
1192 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1193 * backed by a private user data partition, which means there is little
1194 * benefit to storing data here instead of the private directories returned
1195 * by {@link #getFilesDir()}, etc.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001196 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001197 * Shared storage devices returned here are considered a stable part of the
1198 * device, including physical media slots under a protective cover. The
1199 * returned paths do not include transient devices, such as USB flash drives
1200 * connected to handheld devices.
1201 * <p>
1202 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001203 * example, an app may choose to store large files on the device with the
1204 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001205 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001206 * No additional permissions are required for the calling app to read or
1207 * write files under the returned path. Write access outside of these paths
1208 * on secondary external storage devices is not available.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001209 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001210 * The returned path may change over time if different shared storage media
1211 * is inserted, so only relative paths should be persisted.
Jeff Sharkey8c165792012-10-22 14:08:29 -07001212 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001213 * @param type The type of files directory to return. May be {@code null}
1214 * for the root of the files directory or one of the following
1215 * constants for a subdirectory:
1216 * {@link android.os.Environment#DIRECTORY_MUSIC},
1217 * {@link android.os.Environment#DIRECTORY_PODCASTS},
1218 * {@link android.os.Environment#DIRECTORY_RINGTONES},
1219 * {@link android.os.Environment#DIRECTORY_ALARMS},
1220 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
1221 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
1222 * {@link android.os.Environment#DIRECTORY_MOVIES}.
1223 * @return the absolute paths to application-specific directories. Some
1224 * individual paths may be {@code null} if that shared storage is
1225 * not currently available. The first path returned is the same as
1226 * {@link #getExternalFilesDir(String)}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001227 * @see #getExternalFilesDir(String)
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001228 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001229 * @see Environment#isExternalStorageEmulated(File)
1230 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001231 */
1232 public abstract File[] getExternalFilesDirs(String type);
1233
1234 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001235 * Return the primary shared/external storage directory where this
1236 * application's OBB files (if there are any) can be found. Note if the
1237 * application does not have any OBB files, this directory may not exist.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001238 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001239 * This is like {@link #getFilesDir()} in that these files will be deleted
1240 * when the application is uninstalled, however there are some important
1241 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001242 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001243 * <li>Shared storage may not always be available, since removable media can
1244 * be ejected by the user. Media state can be checked using
1245 * {@link Environment#getExternalStorageState(File)}.
1246 * <li>There is no security enforced with these files. For example, any
1247 * application holding
1248 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001249 * these files.
1250 * </ul>
1251 * <p>
1252 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Dave Friedmancfe50882017-07-05 00:40:07 -07001253 * are required to read or write to the path that this method returns.
1254 * However, starting from {@link android.os.Build.VERSION_CODES#M},
1255 * to read the OBB expansion files, you must declare the
1256 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission in the app manifest and ask for
1257 * permission at runtime as follows:
1258 * </p>
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001259 * <p>
Dave Friedmancfe50882017-07-05 00:40:07 -07001260 * {@code <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
1261 * android:maxSdkVersion="23" />}
1262 * </p>
1263 * <p>
1264 * Starting from {@link android.os.Build.VERSION_CODES#N},
1265 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE}
1266 * permission is not required, so don’t ask for this
1267 * permission at runtime. To handle both cases, your app must first try to read the OBB file,
1268 * and if it fails, you must request
1269 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission at runtime.
1270 * </p>
1271 *
1272 * <p>
1273 * The following code snippet shows how to do this:
1274 * </p>
1275 *
1276 * <pre>
1277 * File obb = new File(obb_filename);
1278 * boolean open_failed = false;
1279 *
1280 * try {
1281 * BufferedReader br = new BufferedReader(new FileReader(obb));
1282 * open_failed = false;
1283 * ReadObbFile(br);
1284 * } catch (IOException e) {
1285 * open_failed = true;
1286 * }
1287 *
1288 * if (open_failed) {
1289 * // request READ_EXTERNAL_STORAGE permission before reading OBB file
1290 * ReadObbFileWithPermission();
1291 * }
1292 * </pre>
1293 *
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001294 * On devices with multiple users (as described by {@link UserManager}),
Jeff Sharkey8c165792012-10-22 14:08:29 -07001295 * multiple users may share the same OBB storage location. Applications
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001296 * should ensure that multiple instances running under different users don't
1297 * interfere with each other.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001298 *
1299 * @return the absolute path to application-specific directory. May return
1300 * {@code null} if shared storage is not currently available.
1301 * @see #getObbDirs()
1302 * @see Environment#getExternalStorageState(File)
1303 * @see Environment#isExternalStorageEmulated(File)
1304 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborn805fd7e2011-01-16 18:30:29 -08001305 */
1306 public abstract File getObbDir();
1307
1308 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001309 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001310 * shared/external storage devices where the application's OBB files (if
1311 * there are any) can be found. Note if the application does not have any
1312 * OBB files, these directories may not exist.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001313 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001314 * This is like {@link #getFilesDir()} in that these files will be deleted
1315 * when the application is uninstalled, however there are some important
1316 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001317 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001318 * <li>Shared storage may not always be available, since removable media can
1319 * be ejected by the user. Media state can be checked using
1320 * {@link Environment#getExternalStorageState(File)}.
1321 * <li>There is no security enforced with these files. For example, any
1322 * application holding
1323 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1324 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001325 * </ul>
1326 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001327 * Shared storage devices returned here are considered a stable part of the
1328 * device, including physical media slots under a protective cover. The
1329 * returned paths do not include transient devices, such as USB flash drives
1330 * connected to handheld devices.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001331 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001332 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001333 * example, an app may choose to store large files on the device with the
1334 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001335 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001336 * No additional permissions are required for the calling app to read or
1337 * write files under the returned path. Write access outside of these paths
1338 * on secondary external storage devices is not available.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001339 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001340 * @return the absolute paths to application-specific directories. Some
1341 * individual paths may be {@code null} if that shared storage is
1342 * not currently available. The first path returned is the same as
1343 * {@link #getObbDir()}
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001344 * @see #getObbDir()
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001345 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001346 * @see Environment#isExternalStorageEmulated(File)
1347 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001348 */
1349 public abstract File[] getObbDirs();
1350
1351 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001352 * Returns the absolute path to the application specific cache directory on
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001353 * the filesystem.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001354 * <p>
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001355 * The system will automatically delete files in this directory as disk
1356 * space is needed elsewhere on the device. The system will always delete
1357 * older files first, as reported by {@link File#lastModified()}. If
1358 * desired, you can exert more control over how files are deleted using
1359 * {@link StorageManager#setCacheBehaviorGroup(File, boolean)} and
1360 * {@link StorageManager#setCacheBehaviorTombstone(File, boolean)}.
1361 * <p>
1362 * Apps are strongly encouraged to keep their usage of cache space below the
1363 * quota returned by
1364 * {@link StorageManager#getCacheQuotaBytes(java.util.UUID)}. If your app
1365 * goes above this quota, your cached files will be some of the first to be
1366 * deleted when additional disk space is needed. Conversely, if your app
1367 * stays under this quota, your cached files will be some of the last to be
1368 * deleted when additional disk space is needed.
1369 * <p>
1370 * Note that your cache quota will change over time depending on how
1371 * frequently the user interacts with your app, and depending on how much
1372 * system-wide disk space is used.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001373 * <p>
1374 * The returned path may change over time if the calling app is moved to an
1375 * adopted storage device, so only relative paths should be persisted.
1376 * <p>
1377 * Apps require no extra permissions to read or write to the returned path,
1378 * since this path lives in their private storage.
Scott Main4b5da682010-10-21 11:49:12 -07001379 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001380 * @return The path of the directory holding application cache files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001381 * @see #openFileOutput
1382 * @see #getFileStreamPath
1383 * @see #getDir
Kevin Hufnaglee9681e12016-09-23 16:44:03 -07001384 * @see #getExternalCacheDir
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001385 */
1386 public abstract File getCacheDir();
1387
1388 /**
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001389 * Returns the absolute path to the application specific cache directory on
Jeff Sharkey60a82cd2017-04-18 18:19:16 -06001390 * the filesystem designed for storing cached code.
1391 * <p>
1392 * The system will delete any files stored in this location both when your
1393 * specific application is upgraded, and when the entire platform is
1394 * upgraded.
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001395 * <p>
1396 * This location is optimal for storing compiled or optimized code generated
1397 * by your application at runtime.
1398 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001399 * The returned path may change over time if the calling app is moved to an
1400 * adopted storage device, so only relative paths should be persisted.
1401 * <p>
Jeff Sharkey4ed745d2014-07-15 20:39:15 -07001402 * Apps require no extra permissions to read or write to the returned path,
1403 * since this path lives in their private storage.
1404 *
1405 * @return The path of the directory holding application code cache files.
1406 */
1407 public abstract File getCodeCacheDir();
1408
1409 /**
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001410 * Returns absolute path to application-specific directory on the primary
1411 * shared/external storage device where the application can place cache
1412 * files it owns. These files are internal to the application, and not
1413 * typically visible to the user as media.
1414 * <p>
1415 * This is like {@link #getCacheDir()} in that these files will be deleted
1416 * when the application is uninstalled, however there are some important
1417 * differences:
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001418 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001419 * <li>The platform does not always monitor the space available in shared
1420 * storage, and thus may not automatically delete these files. Apps should
1421 * always manage the maximum space used in this location. Currently the only
1422 * time files here will be deleted by the platform is when running on
1423 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and
1424 * {@link Environment#isExternalStorageEmulated(File)} returns true.
1425 * <li>Shared storage may not always be available, since removable media can
1426 * be ejected by the user. Media state can be checked using
1427 * {@link Environment#getExternalStorageState(File)}.
1428 * <li>There is no security enforced with these files. For example, any
1429 * application holding
1430 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001431 * these files.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001432 * </ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001433 * <p>
1434 * If a shared storage device is emulated (as determined by
Kevin Hufnaglee9681e12016-09-23 16:44:03 -07001435 * {@link Environment#isExternalStorageEmulated(File)}), its contents are
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001436 * backed by a private user data partition, which means there is little
1437 * benefit to storing data here instead of the private directory returned by
1438 * {@link #getCacheDir()}.
1439 * <p>
1440 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001441 * are required to read or write to the returned path; it's always
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001442 * accessible to the calling app. This only applies to paths generated for
1443 * package name of the calling application. To access paths belonging to
1444 * other packages,
1445 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or
1446 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required.
1447 * <p>
1448 * On devices with multiple users (as described by {@link UserManager}),
1449 * each user has their own isolated shared storage. Applications only have
1450 * access to the shared storage for the user they're running as.
1451 * <p>
1452 * The returned path may change over time if different shared storage media
1453 * is inserted, so only relative paths should be persisted.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001454 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001455 * @return the absolute path to application-specific directory. May return
1456 * {@code null} if shared storage is not currently available.
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001457 * @see #getCacheDir
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001458 * @see #getExternalCacheDirs()
1459 * @see Environment#getExternalStorageState(File)
1460 * @see Environment#isExternalStorageEmulated(File)
1461 * @see Environment#isExternalStorageRemovable(File)
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001462 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001463 @Nullable
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001464 public abstract File getExternalCacheDir();
Scott Main4b5da682010-10-21 11:49:12 -07001465
Dianne Hackborne83cefce2010-02-04 17:38:14 -08001466 /**
Fyodor Kupolov61221292016-09-02 15:21:03 -07001467 * Returns absolute path to application-specific directory in the preloaded cache.
1468 * <p>Files stored in the cache directory can be deleted when the device runs low on storage.
1469 * There is no guarantee when these files will be deleted.
1470 * @hide
1471 */
1472 @Nullable
1473 @SystemApi
1474 public abstract File getPreloadsFileCache();
1475
1476 /**
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001477 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001478 * shared/external storage devices where the application can place cache
1479 * files it owns. These files are internal to the application, and not
1480 * typically visible to the user as media.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001481 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001482 * This is like {@link #getCacheDir()} in that these files will be deleted
1483 * when the application is uninstalled, however there are some important
1484 * differences:
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001485 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001486 * <li>The platform does not always monitor the space available in shared
1487 * storage, and thus may not automatically delete these files. Apps should
1488 * always manage the maximum space used in this location. Currently the only
1489 * time files here will be deleted by the platform is when running on
1490 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and
1491 * {@link Environment#isExternalStorageEmulated(File)} returns true.
1492 * <li>Shared storage may not always be available, since removable media can
1493 * be ejected by the user. Media state can be checked using
1494 * {@link Environment#getExternalStorageState(File)}.
1495 * <li>There is no security enforced with these files. For example, any
1496 * application holding
1497 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1498 * these files.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001499 * </ul>
1500 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001501 * If a shared storage device is emulated (as determined by
1502 * {@link Environment#isExternalStorageEmulated(File)}), it's contents are
1503 * backed by a private user data partition, which means there is little
1504 * benefit to storing data here instead of the private directory returned by
1505 * {@link #getCacheDir()}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001506 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001507 * Shared storage devices returned here are considered a stable part of the
1508 * device, including physical media slots under a protective cover. The
1509 * returned paths do not include transient devices, such as USB flash drives
1510 * connected to handheld devices.
1511 * <p>
1512 * An application may store data on any or all of the returned devices. For
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001513 * example, an app may choose to store large files on the device with the
1514 * most available space, as measured by {@link StatFs}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001515 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001516 * No additional permissions are required for the calling app to read or
1517 * write files under the returned path. Write access outside of these paths
1518 * on secondary external storage devices is not available.
Jeff Sharkey6feb50b2013-10-15 12:38:15 -07001519 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001520 * The returned paths may change over time if different shared storage media
1521 * is inserted, so only relative paths should be persisted.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001522 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001523 * @return the absolute paths to application-specific directories. Some
1524 * individual paths may be {@code null} if that shared storage is
1525 * not currently available. The first path returned is the same as
1526 * {@link #getExternalCacheDir()}.
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001527 * @see #getExternalCacheDir()
Jeff Sharkey4ca728c2014-01-10 16:27:19 -08001528 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001529 * @see Environment#isExternalStorageEmulated(File)
1530 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey1abdb712013-08-11 16:28:14 -07001531 */
1532 public abstract File[] getExternalCacheDirs();
1533
1534 /**
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001535 * Returns absolute paths to application-specific directories on all
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001536 * shared/external storage devices where the application can place media
1537 * files. These files are scanned and made available to other apps through
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001538 * {@link MediaStore}.
1539 * <p>
1540 * This is like {@link #getExternalFilesDirs} in that these files will be
1541 * deleted when the application is uninstalled, however there are some
1542 * important differences:
1543 * <ul>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001544 * <li>Shared storage may not always be available, since removable media can
1545 * be ejected by the user. Media state can be checked using
1546 * {@link Environment#getExternalStorageState(File)}.
1547 * <li>There is no security enforced with these files. For example, any
1548 * application holding
1549 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to
1550 * these files.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001551 * </ul>
1552 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001553 * Shared storage devices returned here are considered a stable part of the
1554 * device, including physical media slots under a protective cover. The
1555 * returned paths do not include transient devices, such as USB flash drives
1556 * connected to handheld devices.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001557 * <p>
1558 * An application may store data on any or all of the returned devices. For
1559 * example, an app may choose to store large files on the device with the
1560 * most available space, as measured by {@link StatFs}.
1561 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001562 * No additional permissions are required for the calling app to read or
1563 * write files under the returned path. Write access outside of these paths
1564 * on secondary external storage devices is not available.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001565 * <p>
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001566 * The returned paths may change over time if different shared storage media
1567 * is inserted, so only relative paths should be persisted.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001568 *
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001569 * @return the absolute paths to application-specific directories. Some
1570 * individual paths may be {@code null} if that shared storage is
1571 * not currently available.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001572 * @see Environment#getExternalStorageState(File)
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001573 * @see Environment#isExternalStorageEmulated(File)
1574 * @see Environment#isExternalStorageRemovable(File)
Jeff Sharkey588c15e2019-10-10 17:29:58 -06001575 * @deprecated These directories still exist and are scanned, but developers
1576 * are encouraged to migrate to inserting content into a
1577 * {@link MediaStore} collection directly, as any app can
1578 * contribute new media to {@link MediaStore} with no
1579 * permissions required, starting in
1580 * {@link android.os.Build.VERSION_CODES#Q}.
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001581 */
Jeff Sharkey588c15e2019-10-10 17:29:58 -06001582 @Deprecated
Jeff Sharkey2ee3c1e2014-05-30 15:38:35 -07001583 public abstract File[] getExternalMediaDirs();
1584
1585 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001586 * Returns an array of strings naming the private files associated with
1587 * this Context's application package.
1588 *
1589 * @return Array of strings naming the private files.
1590 *
1591 * @see #openFileInput
1592 * @see #openFileOutput
1593 * @see #deleteFile
1594 */
1595 public abstract String[] fileList();
1596
1597 /**
1598 * Retrieve, creating if needed, a new directory in which the application
1599 * can place its own custom data files. You can use the returned File
1600 * object to create and access files in this directory. Note that files
1601 * created through a File object will only be accessible by your own
1602 * application; you can only set the mode of the entire directory, not
1603 * of individual files.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001604 * <p>
1605 * The returned path may change over time if the calling app is moved to an
1606 * adopted storage device, so only relative paths should be persisted.
1607 * <p>
1608 * Apps require no extra permissions to read or write to the returned path,
1609 * since this path lives in their private storage.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610 *
Nick Kralevich92091fa2012-12-12 16:24:31 -08001611 * @param name Name of the directory to retrieve. This is a directory
Nick Kralevich15069212013-01-09 15:54:56 -08001612 * that is created as part of your application data.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001613 * @param mode Operating mode.
Nick Kralevich15069212013-01-09 15:54:56 -08001614 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001615 * @return A {@link File} object for the requested directory. The directory
Nick Kralevich15069212013-01-09 15:54:56 -08001616 * will have been created if it does not already exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 *
1618 * @see #openFileOutput(String, int)
1619 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001620 public abstract File getDir(String name, @FileMode int mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001621
1622 /**
1623 * Open a new private SQLiteDatabase associated with this Context's
Jeff Sharkey634dc422016-01-30 17:44:15 -07001624 * application package. Create the database file if it doesn't exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001625 *
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.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001628 * @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.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001630 * @return The contents of a newly created database with the given name.
Jeff Sharkey634dc422016-01-30 17:44:15 -07001631 * @throws android.database.sqlite.SQLiteException if the database file
1632 * could not be opened.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * @see #MODE_PRIVATE
Jeff Brown47847f32012-03-22 19:13:11 -07001634 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Sunny Goyala21e6b22015-12-02 09:51:02 -08001635 * @see #MODE_NO_LOCALIZED_COLLATORS
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001636 * @see #deleteDatabase
1637 */
1638 public abstract SQLiteDatabase openOrCreateDatabase(String name,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001639 @DatabaseMode int mode, CursorFactory factory);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001640
1641 /**
Vasu Nori74f170f2010-06-01 18:06:18 -07001642 * Open a new private SQLiteDatabase associated with this Context's
Jeff Sharkey634dc422016-01-30 17:44:15 -07001643 * application package. Creates the database file if it doesn't exist.
1644 * <p>
1645 * Accepts input param: a concrete instance of {@link DatabaseErrorHandler}
1646 * to be used to handle corruption when sqlite reports database corruption.
1647 * </p>
Vasu Nori74f170f2010-06-01 18:06:18 -07001648 *
1649 * @param name The name (unique in the application package) of the database.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001650 * @param mode Operating mode.
Vasu Nori74f170f2010-06-01 18:06:18 -07001651 * @param factory An optional factory class that is called to instantiate a
Jeff Sharkey634dc422016-01-30 17:44:15 -07001652 * cursor when query is called.
1653 * @param errorHandler the {@link DatabaseErrorHandler} to be used when
1654 * sqlite reports database corruption. if null,
1655 * {@link android.database.DefaultDatabaseErrorHandler} is
1656 * assumed.
Vasu Nori74f170f2010-06-01 18:06:18 -07001657 * @return The contents of a newly created database with the given name.
Jeff Sharkey634dc422016-01-30 17:44:15 -07001658 * @throws android.database.sqlite.SQLiteException if the database file
1659 * could not be opened.
Vasu Nori74f170f2010-06-01 18:06:18 -07001660 * @see #MODE_PRIVATE
Jeff Brown47847f32012-03-22 19:13:11 -07001661 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Sunny Goyala21e6b22015-12-02 09:51:02 -08001662 * @see #MODE_NO_LOCALIZED_COLLATORS
Vasu Nori74f170f2010-06-01 18:06:18 -07001663 * @see #deleteDatabase
1664 */
1665 public abstract SQLiteDatabase openOrCreateDatabase(String name,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001666 @DatabaseMode int mode, CursorFactory factory,
Tor Norbyed9273d62013-05-30 15:59:53 -07001667 @Nullable DatabaseErrorHandler errorHandler);
Vasu Nori74f170f2010-06-01 18:06:18 -07001668
1669 /**
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001670 * Move an existing database file from the given source storage context to
1671 * this context. This is typically used to migrate data between storage
1672 * locations after an upgrade, such as migrating to device protected
1673 * storage.
Jeff Sharkeyd21cad12016-05-20 11:30:07 -06001674 * <p>
1675 * The database must be closed before being moved.
Jeff Sharkey35871f22016-01-29 17:13:29 -07001676 *
1677 * @param sourceContext The source context which contains the existing
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001678 * database to move.
Jeff Sharkey35871f22016-01-29 17:13:29 -07001679 * @param name The name of the database file.
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001680 * @return {@code true} if the move was successful or if the database didn't
1681 * exist in the source context, otherwise {@code false}.
1682 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey35871f22016-01-29 17:13:29 -07001683 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06001684 public abstract boolean moveDatabaseFrom(Context sourceContext, String name);
1685
Jeff Sharkey35871f22016-01-29 17:13:29 -07001686 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001687 * Delete an existing private SQLiteDatabase associated with this Context's
1688 * application package.
1689 *
1690 * @param name The name (unique in the application package) of the
1691 * database.
1692 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001693 * @return {@code true} if the database was successfully deleted; else {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001694 *
1695 * @see #openOrCreateDatabase
1696 */
1697 public abstract boolean deleteDatabase(String name);
1698
1699 /**
1700 * Returns the absolute path on the filesystem where a database created with
1701 * {@link #openOrCreateDatabase} is stored.
Jeff Sharkey59d28dc82015-10-14 13:56:23 -07001702 * <p>
1703 * The returned path may change over time if the calling app is moved to an
1704 * adopted storage device, so only relative paths should be persisted.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001705 *
1706 * @param name The name of the database for which you would like to get
1707 * its path.
1708 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001709 * @return An absolute path to the given database.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001710 *
1711 * @see #openOrCreateDatabase
1712 */
1713 public abstract File getDatabasePath(String name);
1714
1715 /**
1716 * Returns an array of strings naming the private databases associated with
1717 * this Context's application package.
1718 *
1719 * @return Array of strings naming the private databases.
1720 *
1721 * @see #openOrCreateDatabase
1722 * @see #deleteDatabase
1723 */
1724 public abstract String[] databaseList();
1725
1726 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001727 * @deprecated Use {@link android.app.WallpaperManager#getDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001728 * WallpaperManager.get()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001729 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001730 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001731 public abstract Drawable getWallpaper();
1732
1733 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001734 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001735 * WallpaperManager.peek()} instead.
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 Drawable peekWallpaper();
1739
1740 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001741 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth()
1742 * WallpaperManager.getDesiredMinimumWidth()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001743 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001744 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001745 public abstract int getWallpaperDesiredMinimumWidth();
1746
1747 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001748 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight()
1749 * WallpaperManager.getDesiredMinimumHeight()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001750 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001751 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001752 public abstract int getWallpaperDesiredMinimumHeight();
1753
1754 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001755 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001756 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001757 * <p>This method requires the caller to hold the permission
1758 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001759 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001760 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001761 public abstract void setWallpaper(Bitmap bitmap) throws IOException;
1762
1763 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -07001764 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001765 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001766 * <p>This method requires the caller to hold the permission
1767 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001768 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001769 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001770 public abstract void setWallpaper(InputStream data) throws IOException;
1771
1772 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -07001773 * @deprecated Use {@link android.app.WallpaperManager#clear
1774 * WallpaperManager.clear()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -07001775 * <p>This method requires the caller to hold the permission
1776 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001777 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -07001778 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001779 public abstract void clearWallpaper() throws IOException;
1780
1781 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001782 * Same as {@link #startActivity(Intent, Bundle)} with no options
1783 * specified.
1784 *
1785 * @param intent The description of the activity to start.
1786 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001787 * @throws ActivityNotFoundException &nbsp;
Svet Ganov1ed0e552015-06-11 01:15:43 -07001788 *`
John Spurlock6098c5d2013-06-17 10:32:46 -04001789 * @see #startActivity(Intent, Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -07001790 * @see PackageManager#resolveActivity
1791 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001792 public abstract void startActivity(@RequiresPermission Intent intent);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001793
1794 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001795 * Version of {@link #startActivity(Intent)} that allows you to specify the
1796 * user the activity will be started for. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001797 * that are not pre-installed on the system image.
Amith Yamasani82644082012-08-03 13:09:11 -07001798 * @param intent The description of the activity to start.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001799 * @param user The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -04001800 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani82644082012-08-03 13:09:11 -07001801 * @hide
1802 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001803 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Philip P. Moltmann4e615e62018-08-28 14:57:49 -07001804 @SystemApi
Adrian Roosebc927c2019-02-28 16:21:18 +01001805 public void startActivityAsUser(@RequiresPermission @NonNull Intent intent,
1806 @NonNull UserHandle user) {
Amith Yamasani82644082012-08-03 13:09:11 -07001807 throw new RuntimeException("Not implemented. Must override in a subclass.");
1808 }
1809
1810 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001811 * Launch a new activity. You will not receive any information about when
1812 * the activity exits.
1813 *
1814 * <p>Note that if this method is being called from outside of an
1815 * {@link android.app.Activity} Context, then the Intent must include
1816 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because,
1817 * without being started from an existing Activity, there is no existing
1818 * task in which to place the new activity and thus it needs to be placed
1819 * in its own separate task.
1820 *
1821 * <p>This method throws {@link ActivityNotFoundException}
1822 * if there was no Activity found to run the given Intent.
1823 *
1824 * @param intent The description of the activity to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001825 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001826 * May be null if there are no options. See {@link android.app.ActivityOptions}
1827 * for how to build the Bundle supplied here; there are no supported definitions
1828 * for building it manually.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001829 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001830 * @throws ActivityNotFoundException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001831 *
Scott Main60dd5202012-06-23 00:01:22 -07001832 * @see #startActivity(Intent)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001833 * @see PackageManager#resolveActivity
1834 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001835 public abstract void startActivity(@RequiresPermission Intent intent,
1836 @Nullable Bundle options);
Dianne Hackborna4972e92012-03-14 10:38:05 -07001837
1838 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001839 * Version of {@link #startActivity(Intent, Bundle)} that allows you to specify the
1840 * user the activity will be started for. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001841 * that are not pre-installed on the system image.
Amith Yamasani258848d2012-08-10 17:06:33 -07001842 * @param intent The description of the activity to start.
1843 * @param options Additional options for how the Activity should be started.
1844 * May be null if there are no options. See {@link android.app.ActivityOptions}
1845 * for how to build the Bundle supplied here; there are no supported definitions
1846 * for building it manually.
Dianne Hackborn221ea892013-08-04 16:50:16 -07001847 * @param userId The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -04001848 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani258848d2012-08-10 17:06:33 -07001849 * @hide
1850 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001851 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001852 @UnsupportedAppUsage
Tor Norbye788fc2b2015-07-05 16:10:42 -07001853 public void startActivityAsUser(@RequiresPermission Intent intent, @Nullable Bundle options,
1854 UserHandle userId) {
Amith Yamasani258848d2012-08-10 17:06:33 -07001855 throw new RuntimeException("Not implemented. Must override in a subclass.");
1856 }
1857
1858 /**
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001859 * Version of {@link #startActivity(Intent, Bundle)} that returns a result to the caller. This
1860 * is only supported for Views and Fragments.
1861 * @param who The identifier for the calling element that will receive the result.
1862 * @param intent The intent to start.
1863 * @param requestCode The code that will be returned with onActivityResult() identifying this
1864 * request.
1865 * @param options Additional options for how the Activity should be started.
1866 * May be null if there are no options. See {@link android.app.ActivityOptions}
1867 * for how to build the Bundle supplied here; there are no supported definitions
1868 * for building it manually.
1869 * @hide
1870 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001871 @UnsupportedAppUsage
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001872 public void startActivityForResult(
1873 @NonNull String who, Intent intent, int requestCode, @Nullable Bundle options) {
1874 throw new RuntimeException("This method is only implemented for Activity-based Contexts. "
1875 + "Check canStartActivityForResult() before calling.");
1876 }
1877
1878 /**
1879 * Identifies whether this Context instance will be able to process calls to
1880 * {@link #startActivityForResult(String, Intent, int, Bundle)}.
1881 * @hide
1882 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01001883 @UnsupportedAppUsage
Clara Bayarrid5bf3ed2015-03-27 17:32:45 +00001884 public boolean canStartActivityForResult() {
1885 return false;
1886 }
1887
1888 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001889 * Same as {@link #startActivities(Intent[], Bundle)} with no options
1890 * specified.
1891 *
1892 * @param intents An array of Intents to be started.
1893 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001894 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborna4972e92012-03-14 10:38:05 -07001895 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001896 * @see #startActivities(Intent[], Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -07001897 * @see PackageManager#resolveActivity
1898 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001899 public abstract void startActivities(@RequiresPermission Intent[] intents);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001900
1901 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001902 * Launch multiple new activities. This is generally the same as calling
1903 * {@link #startActivity(Intent)} for the first Intent in the array,
1904 * that activity during its creation calling {@link #startActivity(Intent)}
1905 * for the second entry, etc. Note that unlike that approach, generally
1906 * none of the activities except the last in the array will be created
1907 * at this point, but rather will be created when the user first visits
1908 * them (due to pressing back from the activity on top).
1909 *
1910 * <p>This method throws {@link ActivityNotFoundException}
1911 * if there was no Activity found for <em>any</em> given Intent. In this
1912 * case the state of the activity stack is undefined (some Intents in the
1913 * list may be on it, some not), so you probably want to avoid such situations.
1914 *
1915 * @param intents An array of Intents to be started.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001916 * @param options Additional options for how the Activity should be started.
Elliot Waite54de7742017-01-11 15:30:35 -08001917 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001918 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001919 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001920 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001921 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001922 * @see #startActivities(Intent[])
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001923 * @see PackageManager#resolveActivity
1924 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07001925 public abstract void startActivities(@RequiresPermission Intent[] intents, Bundle options);
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001926
1927 /**
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001928 * @hide
1929 * Launch multiple new activities. This is generally the same as calling
1930 * {@link #startActivity(Intent)} for the first Intent in the array,
1931 * that activity during its creation calling {@link #startActivity(Intent)}
1932 * for the second entry, etc. Note that unlike that approach, generally
1933 * none of the activities except the last in the array will be created
1934 * at this point, but rather will be created when the user first visits
1935 * them (due to pressing back from the activity on top).
1936 *
1937 * <p>This method throws {@link ActivityNotFoundException}
1938 * if there was no Activity found for <em>any</em> given Intent. In this
1939 * case the state of the activity stack is undefined (some Intents in the
1940 * list may be on it, some not), so you probably want to avoid such situations.
1941 *
1942 * @param intents An array of Intents to be started.
1943 * @param options Additional options for how the Activity should be started.
1944 * @param userHandle The user for whom to launch the activities
Elliot Waite54de7742017-01-11 15:30:35 -08001945 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001946 * Context.startActivity(Intent, Bundle)} for more details.
1947 *
Selim Cinek7fa385a2018-01-24 08:35:28 -08001948 * @return The corresponding flag {@link ActivityManager#START_CANCELED},
1949 * {@link ActivityManager#START_SUCCESS} etc. indicating whether the launch was
1950 * successful.
1951 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001952 * @throws ActivityNotFoundException &nbsp;
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001953 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001954 * @see #startActivities(Intent[])
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001955 * @see PackageManager#resolveActivity
1956 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001957 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Selim Cinek7fa385a2018-01-24 08:35:28 -08001958 public int startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle) {
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001959 throw new RuntimeException("Not implemented. Must override in a subclass.");
1960 }
1961
1962 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001963 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)}
1964 * with no options specified.
1965 *
1966 * @param intent The IntentSender to launch.
1967 * @param fillInIntent If non-null, this will be provided as the
1968 * intent parameter to {@link IntentSender#sendIntent}.
1969 * @param flagsMask Intent flags in the original IntentSender that you
1970 * would like to change.
1971 * @param flagsValues Desired values for any bits set in
1972 * <var>flagsMask</var>
1973 * @param extraFlags Always set to 0.
1974 *
1975 * @see #startActivity(Intent)
1976 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle)
1977 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06001978 public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent,
1979 @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues,
1980 int extraFlags) throws IntentSender.SendIntentException;
Dianne Hackborna4972e92012-03-14 10:38:05 -07001981
1982 /**
1983 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001984 * to start. If the IntentSender is for an activity, that activity will be started
Dianne Hackbornae22c052009-09-17 18:46:22 -07001985 * as if you had called the regular {@link #startActivity(Intent)}
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001986 * here; otherwise, its associated action will be executed (such as
1987 * sending a broadcast) as if you had called
1988 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Scott Main4b5da682010-10-21 11:49:12 -07001989 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001990 * @param intent The IntentSender to launch.
1991 * @param fillInIntent If non-null, this will be provided as the
1992 * intent parameter to {@link IntentSender#sendIntent}.
1993 * @param flagsMask Intent flags in the original IntentSender that you
1994 * would like to change.
1995 * @param flagsValues Desired values for any bits set in
1996 * <var>flagsMask</var>
1997 * @param extraFlags Always set to 0.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001998 * @param options Additional options for how the Activity should be started.
Elliot Waite54de7742017-01-11 15:30:35 -08001999 * See {@link android.content.Context#startActivity(Intent, Bundle)}
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07002000 * Context.startActivity(Intent, Bundle)} for more details. If options
2001 * have also been supplied by the IntentSender, options given here will
2002 * override any that conflict with those given by the IntentSender.
Dianne Hackborna4972e92012-03-14 10:38:05 -07002003 *
2004 * @see #startActivity(Intent, Bundle)
2005 * @see #startIntentSender(IntentSender, Intent, int, int, int)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002006 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002007 public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent,
2008 @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues,
2009 int extraFlags, @Nullable Bundle options) throws IntentSender.SendIntentException;
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002010
2011 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002012 * Broadcast the given intent to all interested BroadcastReceivers. 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.
2024 *
2025 * @see android.content.BroadcastReceiver
2026 * @see #registerReceiver
2027 * @see #sendBroadcast(Intent, String)
2028 * @see #sendOrderedBroadcast(Intent, String)
2029 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2030 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002031 public abstract void sendBroadcast(@RequiresPermission Intent intent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002032
2033 /**
2034 * Broadcast the given intent to all interested BroadcastReceivers, allowing
2035 * an optional required permission to be enforced. This
2036 * call is asynchronous; it returns immediately, and you will continue
2037 * executing while the receivers are run. No results are propagated from
2038 * receivers and receivers can not abort the broadcast. If you want
2039 * to allow receivers to propagate results or abort the broadcast, you must
2040 * send an ordered broadcast using
2041 * {@link #sendOrderedBroadcast(Intent, String)}.
2042 *
2043 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2044 *
2045 * @param intent The Intent to broadcast; all receivers matching this
2046 * Intent will receive the broadcast.
Brad Fitzpatrick26b71be2010-12-07 14:52:58 -08002047 * @param receiverPermission (optional) String naming a permission that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 * a receiver must hold in order to receive your broadcast.
2049 * If null, no permission is required.
2050 *
2051 * @see android.content.BroadcastReceiver
2052 * @see #registerReceiver
2053 * @see #sendBroadcast(Intent)
2054 * @see #sendOrderedBroadcast(Intent, String)
2055 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2056 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002057 public abstract void sendBroadcast(@RequiresPermission Intent intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07002058 @Nullable String receiverPermission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002059
Fyodor Kupolovd4fd8c72015-07-13 19:19:25 -07002060
2061 /**
2062 * Broadcast the given intent to all interested BroadcastReceivers, allowing
2063 * an array of required permissions to be enforced. This call is asynchronous; it returns
2064 * immediately, and you will continue executing while the receivers are run. No results are
2065 * propagated from receivers and receivers can not abort the broadcast. If you want to allow
2066 * receivers to propagate results or abort the broadcast, you must send an ordered broadcast
2067 * using {@link #sendOrderedBroadcast(Intent, String)}.
2068 *
2069 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2070 *
2071 * @param intent The Intent to broadcast; all receivers matching this
2072 * Intent will receive the broadcast.
2073 * @param receiverPermissions Array of names of permissions that a receiver must hold
2074 * in order to receive your broadcast.
2075 * If null or empty, no permissions are required.
2076 *
2077 * @see android.content.BroadcastReceiver
2078 * @see #registerReceiver
2079 * @see #sendBroadcast(Intent)
2080 * @see #sendOrderedBroadcast(Intent, String)
2081 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2082 * @hide
2083 */
2084 public abstract void sendBroadcastMultiplePermissions(Intent intent,
2085 String[] receiverPermissions);
2086
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002087 /**
Dianne Hackborna750a632015-06-16 17:18:23 -07002088 * Broadcast the given intent to all interested BroadcastReceivers, allowing
Tyler Gunnf955e562018-04-26 14:43:31 -07002089 * an array of required permissions to be enforced. This call is asynchronous; it returns
2090 * immediately, and you will continue executing while the receivers are run. No results are
2091 * propagated from receivers and receivers can not abort the broadcast. If you want to allow
2092 * receivers to propagate results or abort the broadcast, you must send an ordered broadcast
2093 * using {@link #sendOrderedBroadcast(Intent, String)}.
2094 *
2095 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2096 *
2097 * @param intent The Intent to broadcast; all receivers matching this
2098 * Intent will receive the broadcast.
2099 * @param user The user to send the broadcast to.
2100 * @param receiverPermissions Array of names of permissions that a receiver must hold
2101 * in order to receive your broadcast.
2102 * If null or empty, no permissions are required.
2103 *
2104 * @see android.content.BroadcastReceiver
2105 * @see #registerReceiver
2106 * @see #sendBroadcast(Intent)
2107 * @see #sendOrderedBroadcast(Intent, String)
2108 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2109 * @hide
2110 */
2111 public abstract void sendBroadcastAsUserMultiplePermissions(Intent intent, UserHandle user,
2112 String[] receiverPermissions);
2113
2114 /**
2115 * Broadcast the given intent to all interested BroadcastReceivers, allowing
Dianne Hackborna750a632015-06-16 17:18:23 -07002116 * an optional required permission to be enforced. This
2117 * call is asynchronous; it returns immediately, and you will continue
2118 * executing while the receivers are run. No results are propagated from
2119 * receivers and receivers can not abort the broadcast. If you want
2120 * to allow receivers to propagate results or abort the broadcast, you must
2121 * send an ordered broadcast using
2122 * {@link #sendOrderedBroadcast(Intent, String)}.
2123 *
2124 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2125 *
2126 * @param intent The Intent to broadcast; all receivers matching this
2127 * Intent will receive the broadcast.
2128 * @param receiverPermission (optional) String naming a permission that
2129 * a receiver must hold in order to receive your broadcast.
2130 * If null, no permission is required.
2131 * @param options (optional) Additional sending options, generated from a
2132 * {@link android.app.BroadcastOptions}.
2133 *
2134 * @see android.content.BroadcastReceiver
2135 * @see #registerReceiver
2136 * @see #sendBroadcast(Intent)
2137 * @see #sendOrderedBroadcast(Intent, String)
2138 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2139 * @hide
2140 */
2141 @SystemApi
2142 public abstract void sendBroadcast(Intent intent,
2143 @Nullable String receiverPermission,
2144 @Nullable Bundle options);
2145
2146 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002147 * Like {@link #sendBroadcast(Intent, String)}, but also allows specification
Tor Norbyed9273d62013-05-30 15:59:53 -07002148 * of an associated app op as per {@link android.app.AppOpsManager}.
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002149 * @hide
2150 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002151 @UnsupportedAppUsage
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002152 public abstract void sendBroadcast(Intent intent,
2153 String receiverPermission, int appOp);
2154
2155 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002156 * Broadcast the given intent to all interested BroadcastReceivers, delivering
2157 * them one at a time to allow more preferred receivers to consume the
2158 * broadcast before it is delivered to less preferred receivers. This
2159 * call is asynchronous; it returns immediately, and you will continue
2160 * executing while the receivers are run.
2161 *
2162 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2163 *
2164 * @param intent The Intent to broadcast; all receivers matching this
2165 * Intent will receive the broadcast.
2166 * @param receiverPermission (optional) String naming a permissions that
2167 * a receiver must hold in order to receive your broadcast.
2168 * If null, no permission is required.
2169 *
2170 * @see android.content.BroadcastReceiver
2171 * @see #registerReceiver
2172 * @see #sendBroadcast(Intent)
2173 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2174 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002175 public abstract void sendOrderedBroadcast(@RequiresPermission Intent intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07002176 @Nullable String receiverPermission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177
2178 /**
2179 * Version of {@link #sendBroadcast(Intent)} that allows you to
2180 * receive data back from the broadcast. This is accomplished by
2181 * supplying your own BroadcastReceiver when calling, which will be
2182 * treated as a final receiver at the end of the broadcast -- its
2183 * {@link BroadcastReceiver#onReceive} method will be called with
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002184 * the result values collected from the other receivers. The broadcast will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 * be serialized in the same way as calling
2186 * {@link #sendOrderedBroadcast(Intent, String)}.
2187 *
2188 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2189 * asynchronous; it will return before
2190 * resultReceiver.onReceive() is called.
2191 *
2192 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2193 *
2194 * @param intent The Intent to broadcast; all receivers matching this
2195 * Intent will receive the broadcast.
2196 * @param receiverPermission String naming a permissions that
2197 * a receiver must hold in order to receive your broadcast.
2198 * If null, no permission is required.
2199 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2200 * receiver of the broadcast.
2201 * @param scheduler A custom Handler with which to schedule the
2202 * resultReceiver callback; if null it will be
2203 * scheduled in the Context's main thread.
2204 * @param initialCode An initial value for the result code. Often
2205 * Activity.RESULT_OK.
2206 * @param initialData An initial value for the result data. Often
2207 * null.
2208 * @param initialExtras An initial value for the result extras. Often
2209 * null.
2210 *
2211 * @see #sendBroadcast(Intent)
2212 * @see #sendBroadcast(Intent, String)
2213 * @see #sendOrderedBroadcast(Intent, String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002214 * @see android.content.BroadcastReceiver
2215 * @see #registerReceiver
2216 * @see android.app.Activity#RESULT_OK
2217 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07002218 public abstract void sendOrderedBroadcast(@RequiresPermission @NonNull Intent intent,
Dianne Hackborna750a632015-06-16 17:18:23 -07002219 @Nullable String receiverPermission, @Nullable BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002220 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2221 @Nullable Bundle initialExtras);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222
2223 /**
Dianne Hackborna750a632015-06-16 17:18:23 -07002224 * Version of {@link #sendBroadcast(Intent)} that allows you to
2225 * receive data back from the broadcast. This is accomplished by
2226 * supplying your own BroadcastReceiver when calling, which will be
2227 * treated as a final receiver at the end of the broadcast -- its
2228 * {@link BroadcastReceiver#onReceive} method will be called with
2229 * the result values collected from the other receivers. The broadcast will
2230 * be serialized in the same way as calling
2231 * {@link #sendOrderedBroadcast(Intent, String)}.
2232 *
2233 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2234 * asynchronous; it will return before
2235 * resultReceiver.onReceive() is called.
2236 *
2237 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2238 *
2239 *
2240 * @param intent The Intent to broadcast; all receivers matching this
2241 * Intent will receive the broadcast.
2242 * @param receiverPermission String naming a permissions that
2243 * a receiver must hold in order to receive your broadcast.
2244 * If null, no permission is required.
2245 * @param options (optional) Additional sending options, generated from a
2246 * {@link android.app.BroadcastOptions}.
2247 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2248 * receiver of the broadcast.
2249 * @param scheduler A custom Handler with which to schedule the
2250 * resultReceiver callback; if null it will be
2251 * scheduled in the Context's main thread.
2252 * @param initialCode An initial value for the result code. Often
2253 * Activity.RESULT_OK.
2254 * @param initialData An initial value for the result data. Often
2255 * null.
2256 * @param initialExtras An initial value for the result extras. Often
2257 * null.
2258 * @see #sendBroadcast(Intent)
2259 * @see #sendBroadcast(Intent, String)
2260 * @see #sendOrderedBroadcast(Intent, String)
2261 * @see android.content.BroadcastReceiver
2262 * @see #registerReceiver
2263 * @see android.app.Activity#RESULT_OK
2264 * @hide
2265 */
2266 @SystemApi
2267 public abstract void sendOrderedBroadcast(@NonNull Intent intent,
2268 @Nullable String receiverPermission, @Nullable Bundle options,
2269 @Nullable BroadcastReceiver resultReceiver, @Nullable Handler scheduler,
2270 int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
2271
2272 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002273 * Like {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler,
2274 * int, String, android.os.Bundle)}, but also allows specification
Tor Norbyed9273d62013-05-30 15:59:53 -07002275 * of an associated app op as per {@link android.app.AppOpsManager}.
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002276 * @hide
2277 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002278 @UnsupportedAppUsage
Dianne Hackbornf51f6122013-02-04 18:23:34 -08002279 public abstract void sendOrderedBroadcast(Intent intent,
2280 String receiverPermission, int appOp, BroadcastReceiver resultReceiver,
2281 Handler scheduler, int initialCode, String initialData,
2282 Bundle initialExtras);
2283
2284 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002285 * Version of {@link #sendBroadcast(Intent)} that allows you to specify the
2286 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002287 * that are not pre-installed on the system image.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002288 * @param intent The intent to broadcast
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07002289 * @param user UserHandle to send the intent to.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002290 * @see #sendBroadcast(Intent)
2291 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002292 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002293 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2294 UserHandle user);
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002295
2296 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002297 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the
2298 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002299 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002300 *
2301 * @param intent The Intent to broadcast; all receivers matching this
2302 * Intent will receive the broadcast.
2303 * @param user UserHandle to send the intent to.
2304 * @param receiverPermission (optional) String naming a permission that
2305 * a receiver must hold in order to receive your broadcast.
2306 * If null, no permission is required.
2307 *
2308 * @see #sendBroadcast(Intent, String)
2309 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002310 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002311 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2312 UserHandle user, @Nullable String receiverPermission);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002313
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002314 /**
2315 * Version of {@link #sendBroadcast(Intent, String, Bundle)} that allows you to specify the
2316 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002317 * that are not pre-installed on the system image.
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002318 *
2319 * @param intent The Intent to broadcast; all receivers matching this
2320 * Intent will receive the broadcast.
2321 * @param user UserHandle to send the intent to.
2322 * @param receiverPermission (optional) String naming a permission that
2323 * a receiver must hold in order to receive your broadcast.
2324 * If null, no permission is required.
2325 * @param options (optional) Additional sending options, generated from a
2326 * {@link android.app.BroadcastOptions}.
2327 *
2328 * @see #sendBroadcast(Intent, String, Bundle)
2329 * @hide
2330 */
2331 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002332 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Chad Brubaker52c8edc2016-07-25 14:30:26 -07002333 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2334 UserHandle user, @Nullable String receiverPermission, @Nullable Bundle options);
Svet Ganov16a16892015-04-16 10:32:04 -07002335
2336 /**
2337 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the
2338 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002339 * that are not pre-installed on the system image.
Svet Ganov16a16892015-04-16 10:32:04 -07002340 *
2341 * @param intent The Intent to broadcast; all receivers matching this
2342 * Intent will receive the broadcast.
2343 * @param user UserHandle to send the intent to.
2344 * @param receiverPermission (optional) String naming a permission that
2345 * a receiver must hold in order to receive your broadcast.
2346 * If null, no permission is required.
2347 * @param appOp The app op associated with the broadcast.
2348 *
2349 * @see #sendBroadcast(Intent, String)
2350 *
2351 * @hide
2352 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002353 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002354 @UnsupportedAppUsage
Tor Norbye788fc2b2015-07-05 16:10:42 -07002355 public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent,
2356 UserHandle user, @Nullable String receiverPermission, int appOp);
Svet Ganov16a16892015-04-16 10:32:04 -07002357
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002358 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07002359 * Version of
2360 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)}
2361 * that allows you to specify the
2362 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002363 * that are not pre-installed on the system image.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002364 *
2365 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2366 *
2367 * @param intent The Intent to broadcast; all receivers matching this
2368 * Intent will receive the broadcast.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07002369 * @param user UserHandle to send the intent to.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002370 * @param receiverPermission String naming a permissions that
2371 * a receiver must hold in order to receive your broadcast.
2372 * If null, no permission is required.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002373 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2374 * receiver of the broadcast.
2375 * @param scheduler A custom Handler with which to schedule the
2376 * resultReceiver callback; if null it will be
2377 * scheduled in the Context's main thread.
2378 * @param initialCode An initial value for the result code. Often
2379 * Activity.RESULT_OK.
2380 * @param initialData An initial value for the result data. Often
2381 * null.
2382 * @param initialExtras An initial value for the result extras. Often
2383 * null.
2384 *
2385 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2386 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002387 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002388 public abstract void sendOrderedBroadcastAsUser(@RequiresPermission Intent intent,
2389 UserHandle user, @Nullable String receiverPermission, BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002390 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2391 @Nullable Bundle initialExtras);
Dianne Hackborn7d19e022012-08-07 19:12:33 -07002392
2393 /**
Amith Yamasani3cf75722014-05-16 12:37:29 -07002394 * Similar to above but takes an appOp as well, to enforce restrictions.
2395 * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String,
2396 * BroadcastReceiver, Handler, int, String, Bundle)
2397 * @hide
2398 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002399 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002400 @UnsupportedAppUsage
Amith Yamasani3cf75722014-05-16 12:37:29 -07002401 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user,
2402 @Nullable String receiverPermission, int appOp, BroadcastReceiver resultReceiver,
2403 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2404 @Nullable Bundle initialExtras);
2405
2406 /**
Dianne Hackbornfd854ee2015-07-13 18:00:37 -07002407 * Similar to above but takes an appOp as well, to enforce restrictions, and an options Bundle.
2408 * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String,
2409 * BroadcastReceiver, Handler, int, String, Bundle)
2410 * @hide
2411 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002412 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002413 @UnsupportedAppUsage
Dianne Hackbornfd854ee2015-07-13 18:00:37 -07002414 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user,
2415 @Nullable String receiverPermission, int appOp, @Nullable Bundle options,
2416 BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode,
2417 @Nullable String initialData, @Nullable Bundle initialExtras);
2418
2419 /**
Jordan Liu54735532019-10-29 10:33:55 -07002420 * Version of
2421 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String,
2422 * Bundle)} that allows you to specify the App Op to enforce restrictions on which receivers
2423 * the broadcast will be sent to.
2424 *
2425 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2426 *
2427 * @param intent The Intent to broadcast; all receivers matching this
2428 * Intent will receive the broadcast.
2429 * @param receiverPermission String naming a permissions that
2430 * a receiver must hold in order to receive your broadcast.
2431 * If null, no permission is required.
2432 * @param receiverAppOp The app op associated with the broadcast. If null, no appOp is
2433 * required. If both receiverAppOp and receiverPermission are non-null,
2434 * a receiver must have both of them to
2435 * receive the broadcast
2436 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2437 * receiver of the broadcast.
2438 * @param scheduler A custom Handler with which to schedule the
2439 * resultReceiver callback; if null it will be
2440 * scheduled in the Context's main thread.
2441 * @param initialCode An initial value for the result code. Often
2442 * Activity.RESULT_OK.
2443 * @param initialData An initial value for the result data. Often
2444 * null.
2445 * @param initialExtras An initial value for the result extras. Often
2446 * null.
2447 *
2448 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
2449 */
2450 public void sendOrderedBroadcast(@RequiresPermission @NonNull Intent intent,
2451 @Nullable String receiverPermission, @Nullable String receiverAppOp,
2452 @Nullable BroadcastReceiver resultReceiver, @Nullable Handler scheduler,
2453 int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras) {
2454 throw new RuntimeException("Not implemented. Must override in a subclass.");
2455 }
2456
2457 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002458 * <p>Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002459 * Intent you are sending stays around after the broadcast is complete,
2460 * so that others can quickly retrieve that data through the return
2461 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In
2462 * all other ways, this behaves the same as
2463 * {@link #sendBroadcast(Intent)}.
2464 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002465 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2466 * can access them), no protection (anyone can modify them), and many other problems.
2467 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2468 * has changed, with another mechanism for apps to retrieve the current value whenever
2469 * desired.
2470 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002471 * @param intent The Intent to broadcast; all receivers matching this
2472 * Intent will receive the broadcast, and the Intent will be held to
2473 * be re-broadcast to future receivers.
2474 *
2475 * @see #sendBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002476 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002477 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002478 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002479 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002480 public abstract void sendStickyBroadcast(@RequiresPermission Intent intent);
Scott Main4b5da682010-10-21 11:49:12 -07002481
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002482 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002483 * <p>Version of {@link #sendStickyBroadcast} that allows you to
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002484 * receive data back from the broadcast. This is accomplished by
2485 * supplying your own BroadcastReceiver when calling, which will be
2486 * treated as a final receiver at the end of the broadcast -- its
2487 * {@link BroadcastReceiver#onReceive} method will be called with
2488 * the result values collected from the other receivers. The broadcast will
2489 * be serialized in the same way as calling
2490 * {@link #sendOrderedBroadcast(Intent, String)}.
2491 *
2492 * <p>Like {@link #sendBroadcast(Intent)}, this method is
2493 * asynchronous; it will return before
2494 * resultReceiver.onReceive() is called. Note that the sticky data
2495 * stored is only the data you initially supply to the broadcast, not
2496 * the result of any changes made by the receivers.
2497 *
2498 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2499 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002500 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2501 * can access them), no protection (anyone can modify them), and many other problems.
2502 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2503 * has changed, with another mechanism for apps to retrieve the current value whenever
2504 * desired.
2505 *
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002506 * @param intent The Intent to broadcast; all receivers matching this
2507 * Intent will receive the broadcast.
2508 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2509 * receiver of the broadcast.
2510 * @param scheduler A custom Handler with which to schedule the
2511 * resultReceiver callback; if null it will be
2512 * scheduled in the Context's main thread.
2513 * @param initialCode An initial value for the result code. Often
2514 * Activity.RESULT_OK.
2515 * @param initialData An initial value for the result data. Often
2516 * null.
2517 * @param initialExtras An initial value for the result extras. Often
2518 * null.
2519 *
2520 * @see #sendBroadcast(Intent)
2521 * @see #sendBroadcast(Intent, String)
2522 * @see #sendOrderedBroadcast(Intent, String)
2523 * @see #sendStickyBroadcast(Intent)
2524 * @see android.content.BroadcastReceiver
2525 * @see #registerReceiver
2526 * @see android.app.Activity#RESULT_OK
2527 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002528 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002529 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002530 public abstract void sendStickyOrderedBroadcast(@RequiresPermission Intent intent,
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002531 BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002532 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2533 @Nullable Bundle initialExtras);
Dianne Hackbornefa199f2009-09-19 12:03:15 -07002534
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002535 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002536 * <p>Remove the data previously sent with {@link #sendStickyBroadcast},
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002537 * so that it is as if the sticky broadcast had never happened.
2538 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002539 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2540 * can access them), no protection (anyone can modify them), and many other problems.
2541 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2542 * has changed, with another mechanism for apps to retrieve the current value whenever
2543 * desired.
2544 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002545 * @param intent The Intent that was previously broadcast.
2546 *
2547 * @see #sendStickyBroadcast
2548 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002549 @Deprecated
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06002550 @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY)
Tor Norbye788fc2b2015-07-05 16:10:42 -07002551 public abstract void removeStickyBroadcast(@RequiresPermission Intent intent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002552
2553 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002554 * <p>Version of {@link #sendStickyBroadcast(Intent)} that allows you to specify the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002555 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002556 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002557 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002558 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2559 * can access them), no protection (anyone can modify them), and many other problems.
2560 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2561 * has changed, with another mechanism for apps to retrieve the current value whenever
2562 * desired.
2563 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002564 * @param intent The Intent to broadcast; all receivers matching this
2565 * Intent will receive the broadcast, and the Intent will be held to
2566 * be re-broadcast to future receivers.
2567 * @param user UserHandle to send the intent to.
2568 *
2569 * @see #sendBroadcast(Intent)
2570 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002571 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002572 @RequiresPermission(allOf = {
2573 android.Manifest.permission.INTERACT_ACROSS_USERS,
2574 android.Manifest.permission.BROADCAST_STICKY
2575 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002576 public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent,
2577 UserHandle user);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002578
2579 /**
Dianne Hackborne0e413e2015-12-09 17:22:26 -08002580 * @hide
2581 * This is just here for sending CONNECTIVITY_ACTION.
2582 */
2583 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002584 @RequiresPermission(allOf = {
2585 android.Manifest.permission.INTERACT_ACROSS_USERS,
2586 android.Manifest.permission.BROADCAST_STICKY
2587 })
Dianne Hackborne0e413e2015-12-09 17:22:26 -08002588 public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent,
2589 UserHandle user, Bundle options);
2590
2591 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002592 * <p>Version of
Dianne Hackborn8832c182012-09-17 17:20:24 -07002593 * {@link #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)}
2594 * that allows you to specify the
2595 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002596 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002597 *
2598 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2599 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002600 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2601 * can access them), no protection (anyone can modify them), and many other problems.
2602 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2603 * has changed, with another mechanism for apps to retrieve the current value whenever
2604 * desired.
2605 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002606 * @param intent The Intent to broadcast; all receivers matching this
2607 * Intent will receive the broadcast.
2608 * @param user UserHandle to send the intent to.
2609 * @param resultReceiver Your own BroadcastReceiver to treat as the final
2610 * receiver of the broadcast.
2611 * @param scheduler A custom Handler with which to schedule the
2612 * resultReceiver callback; if null it will be
2613 * scheduled in the Context's main thread.
2614 * @param initialCode An initial value for the result code. Often
2615 * Activity.RESULT_OK.
2616 * @param initialData An initial value for the result data. Often
2617 * null.
2618 * @param initialExtras An initial value for the result extras. Often
2619 * null.
2620 *
2621 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
2622 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002623 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002624 @RequiresPermission(allOf = {
2625 android.Manifest.permission.INTERACT_ACROSS_USERS,
2626 android.Manifest.permission.BROADCAST_STICKY
2627 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002628 public abstract void sendStickyOrderedBroadcastAsUser(@RequiresPermission Intent intent,
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002629 UserHandle user, BroadcastReceiver resultReceiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002630 @Nullable Handler scheduler, int initialCode, @Nullable String initialData,
2631 @Nullable Bundle initialExtras);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002632
2633 /**
Dianne Hackborn2c353002014-08-29 15:13:30 -07002634 * <p>Version of {@link #removeStickyBroadcast(Intent)} that allows you to specify the
Dianne Hackborn8832c182012-09-17 17:20:24 -07002635 * user the broadcast will be sent to. This is not available to applications
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002636 * that are not pre-installed on the system image.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002637 *
2638 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
2639 * permission in order to use this API. If you do not hold that
2640 * permission, {@link SecurityException} will be thrown.
2641 *
Dianne Hackborn2c353002014-08-29 15:13:30 -07002642 * @deprecated Sticky broadcasts should not be used. They provide no security (anyone
2643 * can access them), no protection (anyone can modify them), and many other problems.
2644 * The recommended pattern is to use a non-sticky broadcast to report that <em>something</em>
2645 * has changed, with another mechanism for apps to retrieve the current value whenever
2646 * desired.
2647 *
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002648 * @param intent The Intent that was previously broadcast.
2649 * @param user UserHandle to remove the sticky broadcast from.
2650 *
2651 * @see #sendStickyBroadcastAsUser
2652 */
Dianne Hackborn2c353002014-08-29 15:13:30 -07002653 @Deprecated
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002654 @RequiresPermission(allOf = {
2655 android.Manifest.permission.INTERACT_ACROSS_USERS,
2656 android.Manifest.permission.BROADCAST_STICKY
2657 })
Tor Norbye788fc2b2015-07-05 16:10:42 -07002658 public abstract void removeStickyBroadcastAsUser(@RequiresPermission Intent intent,
2659 UserHandle user);
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07002660
2661 /**
Chris Tatea34df8a22009-04-02 23:15:58 -07002662 * Register a BroadcastReceiver to be run in the main activity thread. The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002663 * <var>receiver</var> will be called with any broadcast Intent that
2664 * matches <var>filter</var>, in the main application thread.
2665 *
2666 * <p>The system may broadcast Intents that are "sticky" -- these stay
Kweku Adams86f39a42016-11-16 12:50:38 -08002667 * around after the broadcast has finished, to be sent to any later
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002668 * registrations. If your IntentFilter matches one of these sticky
2669 * Intents, that Intent will be returned by this function
2670 * <strong>and</strong> sent to your <var>receiver</var> as if it had just
2671 * been broadcast.
2672 *
2673 * <p>There may be multiple sticky Intents that match <var>filter</var>,
2674 * in which case each of these will be sent to <var>receiver</var>. In
2675 * this case, only one of these can be returned directly by the function;
2676 * which of these that is returned is arbitrarily decided by the system.
2677 *
2678 * <p>If you know the Intent your are registering for is sticky, you can
2679 * supply null for your <var>receiver</var>. In this case, no receiver is
2680 * registered -- the function simply returns the sticky Intent that
2681 * matches <var>filter</var>. In the case of multiple matches, the same
2682 * rules as described above apply.
2683 *
2684 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2685 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07002686 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2687 * registered with this method will correctly respect the
2688 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2689 * Prior to that, it would be ignored and delivered to all matching registered
2690 * receivers. Be careful if using this for security.</p>
2691 *
Chris Tatea34df8a22009-04-02 23:15:58 -07002692 * <p class="note">Note: this method <em>cannot be called from a
2693 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver
2694 * that is declared in an application's manifest. It is okay, however, to call
2695 * this method from another BroadcastReceiver that has itself been registered
2696 * at run time with {@link #registerReceiver}, since the lifetime of such a
2697 * registered BroadcastReceiver is tied to the object that registered it.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002698 *
2699 * @param receiver The BroadcastReceiver to handle the broadcast.
2700 * @param filter Selects the Intent broadcasts to be received.
2701 *
2702 * @return The first sticky intent found that matches <var>filter</var>,
2703 * or null if there are none.
2704 *
2705 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2706 * @see #sendBroadcast
2707 * @see #unregisterReceiver
2708 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002709 @Nullable
2710 public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002711 IntentFilter filter);
2712
2713 /**
Chad Brubaker816c83b2017-03-02 10:27:59 -08002714 * Register to receive intent broadcasts, with the receiver optionally being
2715 * exposed to Instant Apps. See
2716 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
2717 * information. By default Instant Apps cannot interact with receivers in other
2718 * applications, this allows you to expose a receiver that Instant Apps can
2719 * interact with.
2720 *
2721 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2722 *
2723 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2724 * registered with this method will correctly respect the
2725 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2726 * Prior to that, it would be ignored and delivered to all matching registered
2727 * receivers. Be careful if using this for security.</p>
2728 *
2729 * @param receiver The BroadcastReceiver to handle the broadcast.
2730 * @param filter Selects the Intent broadcasts to be received.
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002731 * @param flags Additional options for the receiver. May be 0 or
2732 * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}.
Chad Brubaker816c83b2017-03-02 10:27:59 -08002733 *
2734 * @return The first sticky intent found that matches <var>filter</var>,
2735 * or null if there are none.
2736 *
2737 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
2738 * @see #sendBroadcast
2739 * @see #unregisterReceiver
2740 */
2741 @Nullable
2742 public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver,
2743 IntentFilter filter,
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002744 @RegisterReceiverFlags int flags);
Chad Brubaker816c83b2017-03-02 10:27:59 -08002745
2746 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002747 * Register to receive intent broadcasts, to run in the context of
2748 * <var>scheduler</var>. See
2749 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
2750 * information. This allows you to enforce permissions on who can
2751 * broadcast intents to your receiver, or have the receiver run in
2752 * a different thread than the main application thread.
2753 *
2754 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2755 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07002756 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2757 * registered with this method will correctly respect the
2758 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2759 * Prior to that, it would be ignored and delivered to all matching registered
2760 * receivers. Be careful if using this for security.</p>
2761 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002762 * @param receiver The BroadcastReceiver to handle the broadcast.
2763 * @param filter Selects the Intent broadcasts to be received.
2764 * @param broadcastPermission String naming a permissions that a
2765 * broadcaster must hold in order to send an Intent to you. If null,
2766 * no permission is required.
2767 * @param scheduler Handler identifying the thread that will receive
2768 * the Intent. If null, the main thread of the process will be used.
2769 *
2770 * @return The first sticky intent found that matches <var>filter</var>,
2771 * or null if there are none.
2772 *
2773 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
2774 * @see #sendBroadcast
2775 * @see #unregisterReceiver
2776 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002777 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002778 public abstract Intent registerReceiver(BroadcastReceiver receiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002779 IntentFilter filter, @Nullable String broadcastPermission,
2780 @Nullable Handler scheduler);
Dianne Hackborn20e80982012-08-31 19:00:44 -07002781
2782 /**
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002783 * Register to receive intent broadcasts, to run in the context of
2784 * <var>scheduler</var>. See
2785 * {@link #registerReceiver(BroadcastReceiver, IntentFilter, int)} and
Chad Brubaker816c83b2017-03-02 10:27:59 -08002786 * {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)}
2787 * for more information.
2788 *
2789 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
2790 *
2791 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
2792 * registered with this method will correctly respect the
2793 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
2794 * Prior to that, it would be ignored and delivered to all matching registered
2795 * receivers. Be careful if using this for security.</p>
2796 *
2797 * @param receiver The BroadcastReceiver to handle the broadcast.
2798 * @param filter Selects the Intent broadcasts to be received.
2799 * @param broadcastPermission String naming a permissions that a
2800 * broadcaster must hold in order to send an Intent to you. If null,
2801 * no permission is required.
2802 * @param scheduler Handler identifying the thread that will receive
2803 * the Intent. If null, the main thread of the process will be used.
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002804 * @param flags Additional options for the receiver. May be 0 or
2805 * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}.
Chad Brubaker816c83b2017-03-02 10:27:59 -08002806 *
2807 * @return The first sticky intent found that matches <var>filter</var>,
2808 * or null if there are none.
2809 *
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002810 * @see #registerReceiver(BroadcastReceiver, IntentFilter, int)
Chad Brubaker816c83b2017-03-02 10:27:59 -08002811 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2812 * @see #sendBroadcast
2813 * @see #unregisterReceiver
2814 */
2815 @Nullable
2816 public abstract Intent registerReceiver(BroadcastReceiver receiver,
2817 IntentFilter filter, @Nullable String broadcastPermission,
Chad Brubaker6d6015f2017-04-18 11:25:16 -07002818 @Nullable Handler scheduler, @RegisterReceiverFlags int flags);
Chad Brubaker816c83b2017-03-02 10:27:59 -08002819
2820 /**
Dianne Hackborn20e80982012-08-31 19:00:44 -07002821 * @hide
2822 * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
2823 * but for a specific user. This receiver will receiver broadcasts that
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002824 * are sent to the requested user.
Dianne Hackborn20e80982012-08-31 19:00:44 -07002825 *
2826 * @param receiver The BroadcastReceiver to handle the broadcast.
2827 * @param user UserHandle to send the intent to.
2828 * @param filter Selects the Intent broadcasts to be received.
2829 * @param broadcastPermission String naming a permissions that a
2830 * broadcaster must hold in order to send an Intent to you. If null,
2831 * no permission is required.
2832 * @param scheduler Handler identifying the thread that will receive
2833 * the Intent. If null, the main thread of the process will be used.
2834 *
2835 * @return The first sticky intent found that matches <var>filter</var>,
2836 * or null if there are none.
2837 *
Jeff Brown6e539312015-02-24 18:53:21 -08002838 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
Dianne Hackborn20e80982012-08-31 19:00:44 -07002839 * @see #sendBroadcast
2840 * @see #unregisterReceiver
2841 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002842 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002843 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002844 @UnsupportedAppUsage
Dianne Hackborn20e80982012-08-31 19:00:44 -07002845 public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver,
Tor Norbyed9273d62013-05-30 15:59:53 -07002846 UserHandle user, IntentFilter filter, @Nullable String broadcastPermission,
2847 @Nullable Handler scheduler);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002848
2849 /**
2850 * Unregister a previously registered BroadcastReceiver. <em>All</em>
2851 * filters that have been registered for this BroadcastReceiver will be
2852 * removed.
2853 *
2854 * @param receiver The BroadcastReceiver to unregister.
2855 *
2856 * @see #registerReceiver
2857 */
2858 public abstract void unregisterReceiver(BroadcastReceiver receiver);
2859
2860 /**
2861 * Request that a given application service be started. The Intent
Hans Boehmfb9f6ac2016-05-05 13:09:28 -07002862 * should either contain the complete class name of a specific service
2863 * implementation to start, or a specific package name to target. If the
2864 * Intent is less specified, it logs a warning about this. In this case any of the
2865 * multiple matching services may be used. If this service
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002866 * is not already running, it will be instantiated and started (creating a
2867 * process for it if needed); if it is running then it remains running.
2868 *
2869 * <p>Every call to this method will result in a corresponding call to
Scott Main4b5da682010-10-21 11:49:12 -07002870 * the target service's {@link android.app.Service#onStartCommand} method,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002871 * with the <var>intent</var> given here. This provides a convenient way
2872 * to submit jobs to a service without having to bind and call on to its
2873 * interface.
2874 *
2875 * <p>Using startService() overrides the default service lifetime that is
2876 * managed by {@link #bindService}: it requires the service to remain
2877 * running until {@link #stopService} is called, regardless of whether
2878 * any clients are connected to it. Note that calls to startService()
Hans Boehmfb9f6ac2016-05-05 13:09:28 -07002879 * do not nest: no matter how many times you call startService(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002880 * a single call to {@link #stopService} will stop it.
2881 *
2882 * <p>The system attempts to keep running services around as much as
2883 * possible. The only time they should be stopped is if the current
2884 * foreground application is using so many resources that the service needs
2885 * to be killed. If any errors happen in the service's process, it will
2886 * automatically be restarted.
2887 *
2888 * <p>This function will throw {@link SecurityException} if you do not
2889 * have permission to start the given service.
2890 *
Chris Craik1e353522016-04-18 10:20:50 -07002891 * <p class="note"><strong>Note:</strong> Each call to startService()
2892 * results in significant work done by the system to manage service
2893 * lifecycle surrounding the processing of the intent, which can take
2894 * multiple milliseconds of CPU time. Due to this cost, startService()
2895 * should not be used for frequent intent delivery to a service, and only
2896 * for scheduling significant work. Use {@link #bindService bound services}
2897 * for high frequency calls.
2898 * </p>
2899 *
Mark Lu94ebbe02016-12-13 16:29:51 -08002900 * @param service Identifies the service to be started. The Intent must be
2901 * fully explicit (supplying a component name). Additional values
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002902 * may be included in the Intent extras to supply arguments along with
2903 * this specific start call.
2904 *
2905 * @return If the service is being started or is already running, the
2906 * {@link ComponentName} of the actual service that was started is
2907 * returned; else if the service does not exist null is returned.
2908 *
Christopher Tate08992ac2017-03-21 11:37:06 -07002909 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08002910 * or the service can not be found.
2911 * @throws IllegalStateException If the application is in a state where the service
2912 * 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 -08002913 *
2914 * @see #stopService
2915 * @see #bindService
2916 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002917 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002918 public abstract ComponentName startService(Intent service);
2919
2920 /**
Christopher Tate08992ac2017-03-21 11:37:06 -07002921 * Similar to {@link #startService(Intent)}, but with an implicit promise that the
Neil Fullerfe6ec562017-03-16 18:29:36 +00002922 * Service will call {@link android.app.Service#startForeground(int, android.app.Notification)
2923 * startForeground(int, android.app.Notification)} once it begins running. The service is given
Christopher Tate08992ac2017-03-21 11:37:06 -07002924 * an amount of time comparable to the ANR interval to do this, otherwise the system
2925 * will automatically stop the service and declare the app ANR.
2926 *
2927 * <p>Unlike the ordinary {@link #startService(Intent)}, this method can be used
2928 * at any time, regardless of whether the app hosting the service is in a foreground
2929 * state.
2930 *
2931 * @param service Identifies the service to be started. The Intent must be
2932 * fully explicit (supplying a component name). Additional values
2933 * may be included in the Intent extras to supply arguments along with
2934 * this specific start call.
2935 *
2936 * @return If the service is being started or is already running, the
2937 * {@link ComponentName} of the actual service that was started is
2938 * returned; else if the service does not exist null is returned.
2939 *
2940 * @throws SecurityException If the caller does not have permission to access the service
2941 * or the service can not be found.
2942 *
2943 * @see #stopService
Neil Fullerfe6ec562017-03-16 18:29:36 +00002944 * @see android.app.Service#startForeground(int, android.app.Notification)
Christopher Tate08992ac2017-03-21 11:37:06 -07002945 */
2946 @Nullable
2947 public abstract ComponentName startForegroundService(Intent service);
2948
2949 /**
2950 * @hide like {@link #startForegroundService(Intent)} but for a specific user.
2951 */
2952 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002953 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Christopher Tate08992ac2017-03-21 11:37:06 -07002954 public abstract ComponentName startForegroundServiceAsUser(Intent service, UserHandle user);
2955
2956 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002957 * Request that a given application service be stopped. If the service is
2958 * not running, nothing happens. Otherwise it is stopped. Note that calls
2959 * to startService() are not counted -- this stops the service no matter
2960 * how many times it was started.
2961 *
2962 * <p>Note that if a stopped service still has {@link ServiceConnection}
2963 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will
2964 * not be destroyed until all of these bindings are removed. See
2965 * the {@link android.app.Service} documentation for more details on a
2966 * service's lifecycle.
2967 *
2968 * <p>This function will throw {@link SecurityException} if you do not
2969 * have permission to stop the given service.
2970 *
Dianne Hackborn221ea892013-08-04 16:50:16 -07002971 * @param service Description of the service to be stopped. The Intent must be either
2972 * fully explicit (supplying a component name) or specify a specific package
kopriva219f7dc2018-10-09 13:42:28 -07002973 * name it is targeted to.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002974 *
2975 * @return If there is a service matching the given Intent that is already
John Spurlock6098c5d2013-06-17 10:32:46 -04002976 * 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 -08002977 *
Christopher Tate08992ac2017-03-21 11:37:06 -07002978 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08002979 * or the service can not be found.
2980 * @throws IllegalStateException If the application is in a state where the service
2981 * 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 -08002982 *
2983 * @see #startService
2984 */
2985 public abstract boolean stopService(Intent service);
2986
2987 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002988 * @hide like {@link #startService(Intent)} but for a specific user.
2989 */
Christopher Tate42a386b2016-11-07 12:21:21 -08002990 @Nullable
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002991 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood5c0d3542018-08-14 13:54:31 +01002992 @UnsupportedAppUsage
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002993 public abstract ComponentName startServiceAsUser(Intent service, UserHandle user);
2994
2995 /**
2996 * @hide like {@link #stopService(Intent)} but for a specific user.
2997 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06002998 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Dianne Hackborn7767eac2012-08-23 18:25:40 -07002999 public abstract boolean stopServiceAsUser(Intent service, UserHandle user);
RoboErik01fe6612014-02-13 14:19:04 -08003000
Dianne Hackborn7767eac2012-08-23 18:25:40 -07003001 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003002 * Connect to an application service, creating it if needed. This defines
3003 * a dependency between your application and the service. The given
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003004 * <var>conn</var> will receive the service object when it is created and be
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003005 * told if it dies and restarts. The service will be considered required
3006 * by the system only for as long as the calling context exists. For
3007 * example, if this Context is an Activity that is stopped, the service will
3008 * not be required to continue running until the Activity is resumed.
3009 *
Christopher Tate5d73b6d2017-10-06 16:15:34 -07003010 * <p>If the service does not support binding, it may return {@code null} from
3011 * its {@link android.app.Service#onBind(Intent) onBind()} method. If it does, then
3012 * the ServiceConnection's
3013 * {@link ServiceConnection#onNullBinding(ComponentName) onNullBinding()} method
3014 * will be invoked instead of
3015 * {@link ServiceConnection#onServiceConnected(ComponentName, IBinder) onServiceConnected()}.
3016 *
3017 * <p>This method will throw {@link SecurityException} if the calling app does not
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003018 * have permission to bind to the given service.
3019 *
Christopher Tate5d73b6d2017-10-06 16:15:34 -07003020 * <p class="note">Note: this method <em>cannot be called from a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003021 * {@link BroadcastReceiver} component</em>. A pattern you can use to
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003022 * communicate from a BroadcastReceiver to a Service is to call
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003023 * {@link #startService} with the arguments containing the command to be
3024 * sent, with the service calling its
3025 * {@link android.app.Service#stopSelf(int)} method when done executing
3026 * that command. See the API demo App/Service/Service Start Arguments
3027 * Controller for an illustration of this. It is okay, however, to use
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003028 * this method from a BroadcastReceiver that has been registered with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003029 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver
3030 * is tied to another object (the one that registered it).</p>
3031 *
Mark Lu94ebbe02016-12-13 16:29:51 -08003032 * @param service Identifies the service to connect to. The Intent must
3033 * specify an explicit component name.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003034 * @param conn Receives information as the service is started and stopped.
Christopher Tate79b33172012-06-18 14:54:21 -07003035 * This must be a valid ServiceConnection object; it must not be null.
Scott Main4b5da682010-10-21 11:49:12 -07003036 * @param flags Operation options for the binding. May be 0,
Dianne Hackbornc68c9132011-07-29 01:25:18 -07003037 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND},
3038 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT},
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003039 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, {@link #BIND_WAIVE_PRIORITY}.
3040 * {@link #BIND_IMPORTANT}, or
3041 * {@link #BIND_ADJUST_WITH_ACTIVITY}.
Kevin Hufnagle34acbc9b2017-06-29 15:58:48 -07003042 * @return {@code true} if the system is in the process of bringing up a
3043 * service that your client has permission to bind to; {@code false}
3044 * if the system couldn't find the service or if your client doesn't
3045 * have permission to bind to it. If this value is {@code true}, you
3046 * should later call {@link #unbindService} to release the
3047 * connection.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003048 *
Christopher Tate08992ac2017-03-21 11:37:06 -07003049 * @throws SecurityException If the caller does not have permission to access the service
Dianne Hackborn85e35642017-01-12 15:10:57 -08003050 * or the service can not be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003051 *
3052 * @see #unbindService
3053 * @see #startService
3054 * @see #BIND_AUTO_CREATE
Scott Main4b5da682010-10-21 11:49:12 -07003055 * @see #BIND_DEBUG_UNBIND
3056 * @see #BIND_NOT_FOREGROUND
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003057 * @see #BIND_ABOVE_CLIENT
3058 * @see #BIND_ALLOW_OOM_MANAGEMENT
3059 * @see #BIND_WAIVE_PRIORITY
3060 * @see #BIND_IMPORTANT
3061 * @see #BIND_ADJUST_WITH_ACTIVITY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003062 */
Tor Norbye788fc2b2015-07-05 16:10:42 -07003063 public abstract boolean bindService(@RequiresPermission Intent service,
3064 @NonNull ServiceConnection conn, @BindServiceFlags int flags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003065
3066 /**
Bo Liu58a57662019-03-06 20:21:45 +00003067 * Same as {@link #bindService(Intent, ServiceConnection, int)} with executor to control
3068 * ServiceConnection callbacks.
3069 * @param executor Callbacks on ServiceConnection will be called on executor. Must use same
3070 * instance for the same instance of ServiceConnection.
3071 */
3072 public boolean bindService(@RequiresPermission @NonNull Intent service,
3073 @BindServiceFlags int flags, @NonNull @CallbackExecutor Executor executor,
3074 @NonNull ServiceConnection conn) {
3075 throw new RuntimeException("Not implemented. Must override in a subclass.");
3076 }
3077
3078 /**
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003079 * Variation of {@link #bindService} that, in the specific case of isolated
3080 * services, allows the caller to generate multiple instances of a service
Dianne Hackborncc67f962019-04-29 16:32:44 -07003081 * from a single component declaration. In other words, you can use this to bind
3082 * to a service that has specified {@link android.R.attr#isolatedProcess} and, in
3083 * addition to the existing behavior of running in an isolated process, you can
3084 * also through the arguments here have the system bring up multiple concurrent
3085 * processes hosting their own instances of that service. The <var>instanceName</var>
3086 * you provide here identifies the different instances, and you can use
3087 * {@link #updateServiceGroup(ServiceConnection, int, int)} to tell the system how it
3088 * should manage each of these instances.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003089 *
3090 * @param service Identifies the service to connect to. The Intent must
3091 * specify an explicit component name.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003092 * @param flags Operation options for the binding as per {@link #bindService}.
3093 * @param instanceName Unique identifier for the service instance. Each unique
Robert Seseke3a5bc62019-04-22 17:43:03 -04003094 * name here will result in a different service instance being created. Identifiers
3095 * must only contain ASCII letters, digits, underscores, and periods.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003096 * @return Returns success of binding as per {@link #bindService}.
Bo Liu58a57662019-03-06 20:21:45 +00003097 * @param executor Callbacks on ServiceConnection will be called on executor.
3098 * Must use same instance for the same instance of ServiceConnection.
3099 * @param conn Receives information as the service is started and stopped.
3100 * This must be a valid ServiceConnection object; it must not be null.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003101 *
3102 * @throws SecurityException If the caller does not have permission to access the service
Robert Seseke3a5bc62019-04-22 17:43:03 -04003103 * @throws IllegalArgumentException If the instanceName is invalid.
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003104 *
3105 * @see #bindService
Dianne Hackborncc67f962019-04-29 16:32:44 -07003106 * @see #updateServiceGroup
3107 * @see android.R.attr#isolatedProcess
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003108 */
Adrian Roosebc927c2019-02-28 16:21:18 +01003109 public boolean bindIsolatedService(@RequiresPermission @NonNull Intent service,
Bo Liu58a57662019-03-06 20:21:45 +00003110 @BindServiceFlags int flags, @NonNull String instanceName,
3111 @NonNull @CallbackExecutor Executor executor, @NonNull ServiceConnection conn) {
Adrian Roosfe6aeaf2019-01-22 16:58:56 +01003112 throw new RuntimeException("Not implemented. Must override in a subclass.");
3113 }
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003114
3115 /**
Dianne Hackborn7d19e022012-08-07 19:12:33 -07003116 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle
Amith Yamasani37ce3a82012-02-06 12:04:42 -08003117 * argument for use by system server and other multi-user aware code.
3118 * @hide
3119 */
Amith Yamasanic85029f2014-09-11 16:47:17 -07003120 @SystemApi
Jeff Brown6e539312015-02-24 18:53:21 -08003121 @SuppressWarnings("unused")
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06003122 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Tor Norbye788fc2b2015-07-05 16:10:42 -07003123 public boolean bindServiceAsUser(@RequiresPermission Intent service, ServiceConnection conn,
Jeff Brown6e539312015-02-24 18:53:21 -08003124 int flags, UserHandle user) {
Amith Yamasani37ce3a82012-02-06 12:04:42 -08003125 throw new RuntimeException("Not implemented. Must override in a subclass.");
3126 }
3127
3128 /**
Dianne Hackborn27b4d942018-11-12 15:01:40 -08003129 * Same as {@link #bindServiceAsUser(Intent, ServiceConnection, int, UserHandle)}, but with an
Adrian Roos691546e2016-02-09 10:13:41 -08003130 * explicit non-null Handler to run the ServiceConnection callbacks on.
3131 *
3132 * @hide
3133 */
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06003134 @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS)
Mathew Inwood7bcc1742019-07-04 11:39:42 +01003135 @UnsupportedAppUsage(trackingBug = 136728678)
Adrian Roos691546e2016-02-09 10:13:41 -08003136 public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags,
3137 Handler handler, UserHandle user) {
3138 throw new RuntimeException("Not implemented. Must override in a subclass.");
3139 }
3140
3141 /**
Dianne Hackborna631d562018-11-20 15:58:15 -08003142 * For a service previously bound with {@link #bindService} or a related method, change
3143 * how the system manages that service's process in relation to other processes. This
3144 * doesn't modify the original bind flags that were passed in when binding, but adjusts
3145 * how the process will be managed in some cases based on those flags. Currently only
3146 * works on isolated processes (will be ignored for non-isolated processes).
3147 *
Dianne Hackborn2f55e5a2018-11-30 16:31:31 -08003148 * <p>Note that this call does not take immediate effect, but will be applied the next
3149 * time the impacted process is adjusted for some other reason. Typically you would
3150 * call this before then calling a new {@link #bindIsolatedService} on the service
3151 * of interest, with that binding causing the process to be shuffled accordingly.</p>
3152 *
Dianne Hackborna631d562018-11-20 15:58:15 -08003153 * @param conn The connection interface previously supplied to bindService(). This
3154 * parameter must not be null.
3155 * @param group A group to put this connection's process in. Upon calling here, this
3156 * will override any previous group that was set for that process. The group
3157 * tells the system about processes that are logically grouped together, so
3158 * should be managed as one unit of importance (such as when being considered
3159 * a recently used app). All processes in the same app with the same group
3160 * are considered to be related. Supplying 0 reverts to the default behavior
3161 * of not grouping.
3162 * @param importance Additional importance of the processes within a group. Upon calling
Dianne Hackborncc67f962019-04-29 16:32:44 -07003163 * here, this will override any previous importance that was set for that
3164 * process. The most important process is 0, and higher values are
3165 * successively less important. You can view this as describing how
3166 * to order the processes in an array, with the processes at the end of
3167 * the array being the least important. This value has no meaning besides
3168 * indicating how processes should be ordered in that array one after the
3169 * other. This provides a way to fine-tune the system's process killing,
3170 * guiding it to kill processes at the end of the array first.
3171 *
3172 * @see #bindIsolatedService
Dianne Hackborna631d562018-11-20 15:58:15 -08003173 */
Adrian Roosfe6aeaf2019-01-22 16:58:56 +01003174 public void updateServiceGroup(@NonNull ServiceConnection conn, int group,
3175 int importance) {
3176 throw new RuntimeException("Not implemented. Must override in a subclass.");
3177 }
Dianne Hackborna631d562018-11-20 15:58:15 -08003178
3179 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003180 * Disconnect from an application service. You will no longer receive
3181 * calls as the service is restarted, and the service is now allowed to
3182 * stop at any time.
3183 *
3184 * @param conn The connection interface previously supplied to
Christopher Tate79b33172012-06-18 14:54:21 -07003185 * bindService(). This parameter must not be null.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003186 *
3187 * @see #bindService
3188 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003189 public abstract void unbindService(@NonNull ServiceConnection conn);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003190
3191 /**
3192 * Start executing an {@link android.app.Instrumentation} class. The given
3193 * Instrumentation component will be run by killing its target application
3194 * (if currently running), starting the target process, instantiating the
3195 * instrumentation component, and then letting it drive the application.
3196 *
3197 * <p>This function is not synchronous -- it returns as soon as the
3198 * instrumentation has started and while it is running.
3199 *
3200 * <p>Instrumentation is normally only allowed to run against a package
3201 * that is either unsigned or signed with a signature that the
3202 * the instrumentation package is also signed with (ensuring the target
3203 * trusts the instrumentation).
3204 *
3205 * @param className Name of the Instrumentation component to be run.
3206 * @param profileFile Optional path to write profiling data as the
3207 * instrumentation runs, or null for no profiling.
3208 * @param arguments Additional optional arguments to pass to the
3209 * instrumentation, or null.
3210 *
John Spurlock6098c5d2013-06-17 10:32:46 -04003211 * @return {@code true} if the instrumentation was successfully started,
3212 * else {@code false} if it could not be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003213 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003214 public abstract boolean startInstrumentation(@NonNull ComponentName className,
3215 @Nullable String profileFile, @Nullable Bundle arguments);
3216
3217 /** @hide */
Jeff Sharkey5db9a912017-12-08 17:32:32 -07003218 @StringDef(suffix = { "_SERVICE" }, value = {
Tor Norbyed9273d62013-05-30 15:59:53 -07003219 POWER_SERVICE,
3220 WINDOW_SERVICE,
3221 LAYOUT_INFLATER_SERVICE,
3222 ACCOUNT_SERVICE,
3223 ACTIVITY_SERVICE,
3224 ALARM_SERVICE,
3225 NOTIFICATION_SERVICE,
3226 ACCESSIBILITY_SERVICE,
3227 CAPTIONING_SERVICE,
3228 KEYGUARD_SERVICE,
3229 LOCATION_SERVICE,
3230 //@hide: COUNTRY_DETECTOR,
3231 SEARCH_SERVICE,
3232 SENSOR_SERVICE,
Chad Brubaker90f391f2018-10-19 10:26:19 -07003233 SENSOR_PRIVACY_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003234 STORAGE_SERVICE,
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003235 STORAGE_STATS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003236 WALLPAPER_SERVICE,
Neil Fullerfe6ec562017-03-16 18:29:36 +00003237 TIME_ZONE_RULES_MANAGER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003238 VIBRATOR_SERVICE,
3239 //@hide: STATUS_BAR_SERVICE,
3240 CONNECTIVITY_SERVICE,
Chalard Jean8c141bd2018-12-04 20:20:56 +09003241 //@hide: IP_MEMORY_STORE_SERVICE,
Nathan Harold330e1082017-01-12 18:38:57 -08003242 IPSEC_SERVICE,
Benedict Wong99a48412018-11-09 14:45:34 -08003243 TEST_NETWORK_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003244 //@hide: UPDATE_LOCK_SERVICE,
3245 //@hide: NETWORKMANAGEMENT_SERVICE,
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003246 NETWORK_STATS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003247 //@hide: NETWORK_POLICY_SERVICE,
3248 WIFI_SERVICE,
Etan Cohen04133272016-10-26 11:22:06 -07003249 WIFI_AWARE_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003250 WIFI_P2P_SERVICE,
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003251 WIFI_SCANNING_SERVICE,
Robert Quattlebaum87a71042017-05-15 15:45:20 -07003252 //@hide: LOWPAN_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003253 //@hide: WIFI_RTT_SERVICE,
Lorenzo Colittibd8a3742014-05-22 11:51:27 -07003254 //@hide: ETHERNET_SERVICE,
Etan Cohen46efb482017-12-07 13:50:57 -08003255 WIFI_RTT_RANGING_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003256 NSD_SERVICE,
3257 AUDIO_SERVICE,
Jim Millerce7eb6d2015-04-03 19:29:13 -07003258 FINGERPRINT_SERVICE,
Gilad Brettercb51b8b2018-03-22 17:04:51 +02003259 //@hide: FACE_SERVICE,
Kevin Chyn05c21502018-09-18 13:07:19 -07003260 BIOMETRIC_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003261 MEDIA_ROUTER_SERVICE,
3262 TELEPHONY_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003263 TELEPHONY_SUBSCRIPTION_SERVICE,
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08003264 CARRIER_CONFIG_SERVICE,
hyunhae.lee75fdafa2019-07-19 22:08:41 +09003265 EUICC_SERVICE,
Tyler Gunnef9f6f92014-09-12 22:16:17 -07003266 TELECOM_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003267 CLIPBOARD_SERVICE,
3268 INPUT_METHOD_SERVICE,
3269 TEXT_SERVICES_MANAGER_SERVICE,
Abodunrinwa Toki3de110b2017-05-04 16:29:04 +01003270 TEXT_CLASSIFICATION_SERVICE,
Svetoslav976e8bd2014-07-16 15:12:03 -07003271 APPWIDGET_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003272 //@hide: VOICE_INTERACTION_MANAGER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003273 //@hide: BACKUP_SERVICE,
Richard Uhlerb29f1452018-09-12 16:38:15 +01003274 ROLLBACK_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003275 DROPBOX_SERVICE,
Dianne Hackborn1958e5e2015-06-12 18:11:41 -07003276 //@hide: DEVICE_IDLE_CONTROLLER,
Tor Norbyed9273d62013-05-30 15:59:53 -07003277 DEVICE_POLICY_SERVICE,
3278 UI_MODE_SERVICE,
3279 DOWNLOAD_SERVICE,
3280 NFC_SERVICE,
3281 BLUETOOTH_SERVICE,
3282 //@hide: SIP_SERVICE,
3283 USB_SERVICE,
Amith Yamasani4f582632014-02-19 14:31:52 -08003284 LAUNCHER_APPS_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003285 //@hide: SERIAL_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003286 //@hide: HDMI_CONTROL_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003287 INPUT_SERVICE,
3288 DISPLAY_SERVICE,
Christine Franks39b03112018-07-03 14:46:07 -07003289 //@hide COLOR_DISPLAY_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003290 USER_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003291 RESTRICTIONS_SERVICE,
3292 APP_OPS_SERVICE,
Hai Zhangb7776682018-09-25 15:10:57 -07003293 ROLE_SERVICE,
Hai Zhanga4959e52019-03-06 12:21:07 -08003294 //@hide ROLE_CONTROLLER_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003295 CAMERA_SERVICE,
atrostde54a8ac2019-08-15 16:53:01 +01003296 //@hide: PLATFORM_COMPAT_SERVICE,
atrost87488352019-10-10 19:27:31 +01003297 //@hide: PLATFORM_COMPAT_NATIVE_SERVICE,
RoboErik01fe6612014-02-13 14:19:04 -08003298 PRINT_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003299 CONSUMER_IR_SERVICE,
3300 //@hide: TRUST_SERVICE,
3301 TV_INPUT_SERVICE,
3302 //@hide: NETWORK_SCORE_SERVICE,
3303 USAGE_STATS_SERVICE,
RoboErik01fe6612014-02-13 14:19:04 -08003304 MEDIA_SESSION_SERVICE,
Todd Poynore35872d2013-12-10 11:57:21 -08003305 BATTERY_SERVICE,
Christopher Tate7060b042014-06-09 19:50:00 -07003306 JOB_SCHEDULER_SERVICE,
Tor Norbyebf44ce22015-02-12 11:47:32 -08003307 //@hide: PERSISTENT_DATA_BLOCK_SERVICE,
Andrew Scull3b8b46f2017-02-13 18:12:15 +00003308 //@hide: OEM_LOCK_SERVICE,
Michael Wright446e0192014-12-22 09:38:43 -08003309 MEDIA_PROJECTION_SERVICE,
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08003310 MIDI_SERVICE,
Eric Laurent2035ac82015-03-05 15:18:44 -08003311 RADIO_SERVICE,
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003312 HARDWARE_PROPERTIES_SERVICE,
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08003313 //@hide: SOUND_TRIGGER_SERVICE,
Makoto Onuki6f7362d92016-03-04 13:39:41 -08003314 SHORTCUT_SERVICE,
Peng Xu9ff7d222016-02-11 13:02:05 -08003315 //@hide: CONTEXTHUB_SERVICE,
Joe Onorato1754d742016-11-21 17:51:35 -08003316 SYSTEM_HEALTH_SERVICE,
Tor Norbye8246c072017-07-07 10:21:09 -07003317 //@hide: INCIDENT_SERVICE,
Joe Onoratoe21ab7e2018-12-18 15:00:25 -08003318 //@hide: INCIDENT_COMPANION_SERVICE,
Bookatz94726412017-08-31 09:26:15 -07003319 //@hide: STATS_COMPANION_SERVICE,
Tony Mak9240c7f2017-12-29 11:02:02 +00003320 COMPANION_DEVICE_SERVICE,
Tao Bao07342dc2017-01-24 15:08:21 -08003321 CROSS_PROFILE_APPS_SERVICE,
3322 //@hide: SYSTEM_UPDATE_SERVICE,
Neil Fullerfeeee682018-05-30 14:35:24 +01003323 //@hide: TIME_DETECTOR_SERVICE,
Philip P. Moltmann039678e2018-09-18 13:04:38 -07003324 PERMISSION_SERVICE,
Tor Norbyed9273d62013-05-30 15:59:53 -07003325 })
3326 @Retention(RetentionPolicy.SOURCE)
3327 public @interface ServiceName {}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003328
3329 /**
3330 * Return the handle to a system-level service by name. The class of the
3331 * returned object varies by the requested name. Currently available names
3332 * are:
Scott Main4b5da682010-10-21 11:49:12 -07003333 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003334 * <dl>
3335 * <dt> {@link #WINDOW_SERVICE} ("window")
3336 * <dd> The top-level window manager in which you can place custom
3337 * windows. The returned object is a {@link android.view.WindowManager}.
3338 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater")
3339 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources
3340 * in this context.
3341 * <dt> {@link #ACTIVITY_SERVICE} ("activity")
3342 * <dd> A {@link android.app.ActivityManager} for interacting with the
3343 * global activity state of the system.
3344 * <dt> {@link #POWER_SERVICE} ("power")
3345 * <dd> A {@link android.os.PowerManager} for controlling power
3346 * management.
3347 * <dt> {@link #ALARM_SERVICE} ("alarm")
3348 * <dd> A {@link android.app.AlarmManager} for receiving intents at the
3349 * time of your choosing.
3350 * <dt> {@link #NOTIFICATION_SERVICE} ("notification")
3351 * <dd> A {@link android.app.NotificationManager} for informing the user
3352 * of background events.
3353 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard")
3354 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard.
3355 * <dt> {@link #LOCATION_SERVICE} ("location")
3356 * <dd> A {@link android.location.LocationManager} for controlling location
3357 * (e.g., GPS) updates.
3358 * <dt> {@link #SEARCH_SERVICE} ("search")
3359 * <dd> A {@link android.app.SearchManager} for handling search.
3360 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator")
3361 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator
3362 * hardware.
Sudheer Shanka09b0ee62019-10-03 14:45:15 -07003363 * <dt> {@link #CONNECTIVITY_SERVICE} ("connectivity")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003364 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for
3365 * handling management of network connections.
Nathan Haroldd999d222017-09-11 19:53:33 -07003366 * <dt> {@link #IPSEC_SERVICE} ("ipsec")
3367 * <dd> A {@link android.net.IpSecManager IpSecManager} for managing IPSec on
3368 * sockets and networks.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003369 * <dt> {@link #WIFI_SERVICE} ("wifi")
Paul Stewart0e164b12016-08-08 10:20:13 -07003370 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of Wi-Fi
3371 * connectivity. On releases before NYC, it should only be obtained from an application
3372 * context, and not from any other derived context to avoid memory leaks within the calling
3373 * process.
Etan Cohen6a4b3232017-01-09 21:47:32 -08003374 * <dt> {@link #WIFI_AWARE_SERVICE} ("wifiaware")
3375 * <dd> A {@link android.net.wifi.aware.WifiAwareManager WifiAwareManager} for management of
3376 * Wi-Fi Aware discovery and connectivity.
Vinit Deshapnde011e1b32014-05-07 21:09:11 -07003377 * <dt> {@link #WIFI_P2P_SERVICE} ("wifip2p")
3378 * <dd> A {@link android.net.wifi.p2p.WifiP2pManager WifiP2pManager} for management of
3379 * Wi-Fi Direct connectivity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003380 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method")
3381 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager}
3382 * for management of input methods.
Tobias Haamel53332882010-02-18 16:15:43 -08003383 * <dt> {@link #UI_MODE_SERVICE} ("uimode")
3384 * <dd> An {@link android.app.UiModeManager} for controlling UI modes.
Steve Howard7083c422010-07-28 16:01:23 -07003385 * <dt> {@link #DOWNLOAD_SERVICE} ("download")
Steve Howardd58429f2010-09-27 16:32:39 -07003386 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads
Todd Poynore35872d2013-12-10 11:57:21 -08003387 * <dt> {@link #BATTERY_SERVICE} ("batterymanager")
Todd Poynor99f7e122014-04-15 16:03:42 -07003388 * <dd> A {@link android.os.BatteryManager} for managing battery state
Christopher Tate7060b042014-06-09 19:50:00 -07003389 * <dt> {@link #JOB_SCHEDULER_SERVICE} ("taskmanager")
3390 * <dd> A {@link android.app.job.JobScheduler} for managing scheduled tasks
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003391 * <dt> {@link #NETWORK_STATS_SERVICE} ("netstats")
3392 * <dd> A {@link android.app.usage.NetworkStatsManager NetworkStatsManager} for querying network
3393 * usage statistics.
Polina Bondarenko8333c732016-03-09 18:08:42 +01003394 * <dt> {@link #HARDWARE_PROPERTIES_SERVICE} ("hardware_properties")
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003395 * <dd> A {@link android.os.HardwarePropertiesManager} for accessing hardware properties.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003396 * </dl>
Scott Main4b5da682010-10-21 11:49:12 -07003397 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003398 * <p>Note: System services obtained via this API may be closely associated with
3399 * the Context in which they are obtained from. In general, do not share the
3400 * service objects between various different contexts (Activities, Applications,
3401 * Services, Providers, etc.)
3402 *
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003403 * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true,
3404 * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE},
Donald Chaiee4c91c2018-09-19 14:42:41 -07003405 * {@link #FINGERPRINT_SERVICE}, {@link #KEYGUARD_SERVICE}, {@link #SHORTCUT_SERVICE},
3406 * {@link #USB_SERVICE}, {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE},
3407 * {@link #WIFI_SERVICE}, {@link #WIFI_AWARE_SERVICE}. For these services this method will
3408 * return <code>null</code>. Generally, if you are running as an instant app you should always
Felipe Leme4685b862019-03-06 10:32:33 -08003409 * check whether the result of this method is {@code null}.
3410 *
3411 * <p>Note: When implementing this method, keep in mind that new services can be added on newer
3412 * Android releases, so if you're looking for just the explicit names mentioned above, make sure
3413 * to return {@code null} when you don't recognize the name &mdash; if you throw a
3414 * {@link RuntimeException} exception instead, you're app might break on new Android releases.
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003415 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003416 * @param name The name of the desired service.
Scott Main4b5da682010-10-21 11:49:12 -07003417 *
Felipe Leme4685b862019-03-06 10:32:33 -08003418 * @return The service or {@code null} if the name does not exist.
Scott Main4b5da682010-10-21 11:49:12 -07003419 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003420 * @see #WINDOW_SERVICE
3421 * @see android.view.WindowManager
3422 * @see #LAYOUT_INFLATER_SERVICE
3423 * @see android.view.LayoutInflater
3424 * @see #ACTIVITY_SERVICE
3425 * @see android.app.ActivityManager
3426 * @see #POWER_SERVICE
3427 * @see android.os.PowerManager
3428 * @see #ALARM_SERVICE
3429 * @see android.app.AlarmManager
3430 * @see #NOTIFICATION_SERVICE
3431 * @see android.app.NotificationManager
3432 * @see #KEYGUARD_SERVICE
3433 * @see android.app.KeyguardManager
3434 * @see #LOCATION_SERVICE
3435 * @see android.location.LocationManager
3436 * @see #SEARCH_SERVICE
3437 * @see android.app.SearchManager
3438 * @see #SENSOR_SERVICE
3439 * @see android.hardware.SensorManager
San Mehatc9d81752010-02-01 10:23:27 -08003440 * @see #STORAGE_SERVICE
San Mehatb1043402010-02-05 08:26:50 -08003441 * @see android.os.storage.StorageManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003442 * @see #VIBRATOR_SERVICE
3443 * @see android.os.Vibrator
3444 * @see #CONNECTIVITY_SERVICE
3445 * @see android.net.ConnectivityManager
3446 * @see #WIFI_SERVICE
3447 * @see android.net.wifi.WifiManager
3448 * @see #AUDIO_SERVICE
3449 * @see android.media.AudioManager
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07003450 * @see #MEDIA_ROUTER_SERVICE
3451 * @see android.media.MediaRouter
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003452 * @see #TELEPHONY_SERVICE
3453 * @see android.telephony.TelephonyManager
Wink Savilled09c4ca2014-11-22 10:08:16 -08003454 * @see #TELEPHONY_SUBSCRIPTION_SERVICE
3455 * @see android.telephony.SubscriptionManager
Jonathan Basseri9a1c9b62015-02-25 13:01:52 -08003456 * @see #CARRIER_CONFIG_SERVICE
3457 * @see android.telephony.CarrierConfigManager
hyunhae.lee75fdafa2019-07-19 22:08:41 +09003458 * @see #EUICC_SERVICE
3459 * @see android.telephony.euicc.EuiccManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003460 * @see #INPUT_METHOD_SERVICE
3461 * @see android.view.inputmethod.InputMethodManager
Tobias Haamel53332882010-02-18 16:15:43 -08003462 * @see #UI_MODE_SERVICE
3463 * @see android.app.UiModeManager
Steve Howard7083c422010-07-28 16:01:23 -07003464 * @see #DOWNLOAD_SERVICE
Steve Howardd58429f2010-09-27 16:32:39 -07003465 * @see android.app.DownloadManager
Todd Poynore35872d2013-12-10 11:57:21 -08003466 * @see #BATTERY_SERVICE
3467 * @see android.os.BatteryManager
Christopher Tate7060b042014-06-09 19:50:00 -07003468 * @see #JOB_SCHEDULER_SERVICE
3469 * @see android.app.job.JobScheduler
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003470 * @see #NETWORK_STATS_SERVICE
3471 * @see android.app.usage.NetworkStatsManager
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01003472 * @see android.os.HardwarePropertiesManager
3473 * @see #HARDWARE_PROPERTIES_SERVICE
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003474 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003475 public abstract @Nullable Object getSystemService(@ServiceName @NonNull String name);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003476
3477 /**
Jeff Brown6e539312015-02-24 18:53:21 -08003478 * Return the handle to a system-level service by class.
3479 * <p>
3480 * Currently available classes are:
3481 * {@link android.view.WindowManager}, {@link android.view.LayoutInflater},
3482 * {@link android.app.ActivityManager}, {@link android.os.PowerManager},
3483 * {@link android.app.AlarmManager}, {@link android.app.NotificationManager},
3484 * {@link android.app.KeyguardManager}, {@link android.location.LocationManager},
3485 * {@link android.app.SearchManager}, {@link android.os.Vibrator},
3486 * {@link android.net.ConnectivityManager},
3487 * {@link android.net.wifi.WifiManager},
3488 * {@link android.media.AudioManager}, {@link android.media.MediaRouter},
3489 * {@link android.telephony.TelephonyManager}, {@link android.telephony.SubscriptionManager},
3490 * {@link android.view.inputmethod.InputMethodManager},
3491 * {@link android.app.UiModeManager}, {@link android.app.DownloadManager},
Zoltan Szatmary-Ban9c5dfa52015-02-23 17:20:20 +00003492 * {@link android.os.BatteryManager}, {@link android.app.job.JobScheduler},
3493 * {@link android.app.usage.NetworkStatsManager}.
Felipe Leme4685b862019-03-06 10:32:33 -08003494 * </p>
3495 *
3496 * <p>
Jeff Brown6e539312015-02-24 18:53:21 -08003497 * Note: System services obtained via this API may be closely associated with
3498 * the Context in which they are obtained from. In general, do not share the
3499 * service objects between various different contexts (Activities, Applications,
3500 * Services, Providers, etc.)
3501 * </p>
3502 *
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003503 * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true,
3504 * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE},
Donald Chaiee4c91c2018-09-19 14:42:41 -07003505 * {@link #FINGERPRINT_SERVICE}, {@link #KEYGUARD_SERVICE}, {@link #SHORTCUT_SERVICE},
3506 * {@link #USB_SERVICE}, {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE},
3507 * {@link #WIFI_SERVICE}, {@link #WIFI_AWARE_SERVICE}. For these services this method will
Felipe Leme4685b862019-03-06 10:32:33 -08003508 * return {@code null}. Generally, if you are running as an instant app you should always
3509 * check whether the result of this method is {@code null}.
3510 * </p>
Svet Ganov8f90bcc2017-12-22 23:29:24 -08003511 *
Jeff Brown6e539312015-02-24 18:53:21 -08003512 * @param serviceClass The class of the desired service.
Felipe Leme4685b862019-03-06 10:32:33 -08003513 * @return The service or {@code null} if the class is not a supported system service. Note:
3514 * <b>never</b> throw a {@link RuntimeException} if the name is not supported.
Jeff Brown6e539312015-02-24 18:53:21 -08003515 */
3516 @SuppressWarnings("unchecked")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003517 public final @Nullable <T> T getSystemService(@NonNull Class<T> serviceClass) {
Jeff Brown6e539312015-02-24 18:53:21 -08003518 // Because subclasses may override getSystemService(String) we cannot
3519 // perform a lookup by class alone. We must first map the class to its
3520 // service name then invoke the string-based method.
3521 String serviceName = getSystemServiceName(serviceClass);
3522 return serviceName != null ? (T)getSystemService(serviceName) : null;
3523 }
3524
3525 /**
3526 * Gets the name of the system-level service that is represented by the specified class.
3527 *
3528 * @param serviceClass The class of the desired service.
3529 * @return The service name or null if the class is not a supported system service.
Jeff Brown6e539312015-02-24 18:53:21 -08003530 */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06003531 public abstract @Nullable String getSystemServiceName(@NonNull Class<?> serviceClass);
Jeff Brown6e539312015-02-24 18:53:21 -08003532
3533 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003534 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003535 * {@link android.os.PowerManager} for controlling power management,
3536 * including "wake locks," which let you keep the device on while
3537 * you're running long tasks.
3538 */
3539 public static final String POWER_SERVICE = "power";
Scott Main4b5da682010-10-21 11:49:12 -07003540
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003541 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003542 * Use with {@link #getSystemService(String)} to retrieve a
Tao Baoe8a403d2015-12-31 07:44:55 -08003543 * {@link android.os.RecoverySystem} for accessing the recovery system
3544 * service.
3545 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003546 * @see #getSystemService(String)
Tao Baoe8a403d2015-12-31 07:44:55 -08003547 * @hide
3548 */
3549 public static final String RECOVERY_SERVICE = "recovery";
3550
3551 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003552 * Use with {@link #getSystemService(String)} to retrieve a
Tao Bao07342dc2017-01-24 15:08:21 -08003553 * {@link android.os.SystemUpdateManager} for accessing the system update
3554 * manager service.
3555 *
3556 * @see #getSystemService(String)
3557 * @hide
3558 */
3559 @SystemApi
3560 public static final String SYSTEM_UPDATE_SERVICE = "system_update";
3561
3562 /**
3563 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003564 * {@link android.view.WindowManager} for accessing the system's window
3565 * manager.
3566 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003567 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003568 * @see android.view.WindowManager
3569 */
3570 public static final String WINDOW_SERVICE = "window";
Scott Main4b5da682010-10-21 11:49:12 -07003571
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003572 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003573 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003574 * {@link android.view.LayoutInflater} for inflating layout resources in this
3575 * context.
3576 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003577 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003578 * @see android.view.LayoutInflater
3579 */
3580 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
Scott Main4b5da682010-10-21 11:49:12 -07003581
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003582 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003583 * Use with {@link #getSystemService(String)} to retrieve a
Fred Quintana60307342009-03-24 22:48:12 -07003584 * {@link android.accounts.AccountManager} for receiving intents at a
3585 * time of your choosing.
Fred Quintana60307342009-03-24 22:48:12 -07003586 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003587 * @see #getSystemService(String)
Fred Quintana60307342009-03-24 22:48:12 -07003588 * @see android.accounts.AccountManager
3589 */
3590 public static final String ACCOUNT_SERVICE = "account";
Scott Main4b5da682010-10-21 11:49:12 -07003591
Fred Quintana60307342009-03-24 22:48:12 -07003592 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003593 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003594 * {@link android.app.ActivityManager} for interacting with the global
3595 * system state.
3596 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003597 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003598 * @see android.app.ActivityManager
3599 */
3600 public static final String ACTIVITY_SERVICE = "activity";
Scott Main4b5da682010-10-21 11:49:12 -07003601
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003602 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003603 * Use with {@link #getSystemService(String)} to retrieve a
Wale Ogunwale65ebd952018-04-25 15:41:44 -07003604 * {@link android.app.ActivityTaskManager} for interacting with the global system state.
3605 *
3606 * @see #getSystemService(String)
3607 * @see android.app.ActivityTaskManager
3608 * @hide
3609 */
3610 public static final String ACTIVITY_TASK_SERVICE = "activity_task";
3611
3612 /**
3613 * Use with {@link #getSystemService(String)} to retrieve a
Wale Ogunwale6d50dcc2018-07-21 23:00:40 -07003614 * {@link android.app.UriGrantsManager} for interacting with the global system state.
3615 *
3616 * @see #getSystemService(String)
3617 * @see android.app.UriGrantsManager
3618 * @hide
3619 */
3620 public static final String URI_GRANTS_SERVICE = "uri_grants";
3621
3622 /**
3623 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003624 * {@link android.app.AlarmManager} for receiving intents at a
3625 * time of your choosing.
3626 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003627 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003628 * @see android.app.AlarmManager
3629 */
3630 public static final String ALARM_SERVICE = "alarm";
Scott Main4b5da682010-10-21 11:49:12 -07003631
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003632 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003633 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003634 * {@link android.app.NotificationManager} for informing the user of
3635 * background events.
3636 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003637 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003638 * @see android.app.NotificationManager
3639 */
3640 public static final String NOTIFICATION_SERVICE = "notification";
Scott Main4b5da682010-10-21 11:49:12 -07003641
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003642 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003643 * Use with {@link #getSystemService(String)} to retrieve a
svetoslavganov75986cf2009-05-14 22:28:01 -07003644 * {@link android.view.accessibility.AccessibilityManager} for giving the user
3645 * feedback for UI events through the registered event listeners.
3646 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003647 * @see #getSystemService(String)
svetoslavganov75986cf2009-05-14 22:28:01 -07003648 * @see android.view.accessibility.AccessibilityManager
3649 */
3650 public static final String ACCESSIBILITY_SERVICE = "accessibility";
Scott Main4b5da682010-10-21 11:49:12 -07003651
svetoslavganov75986cf2009-05-14 22:28:01 -07003652 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003653 * Use with {@link #getSystemService(String)} to retrieve a
Alan Viverette69ce69b2013-08-29 12:23:48 -07003654 * {@link android.view.accessibility.CaptioningManager} for obtaining
3655 * captioning properties and listening for changes in captioning
3656 * preferences.
3657 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003658 * @see #getSystemService(String)
Alan Viverette69ce69b2013-08-29 12:23:48 -07003659 * @see android.view.accessibility.CaptioningManager
3660 */
3661 public static final String CAPTIONING_SERVICE = "captioning";
3662
3663 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003664 * Use with {@link #getSystemService(String)} to retrieve a
kopriva5495dbb2018-09-13 14:18:34 -07003665 * {@link android.app.KeyguardManager} for controlling keyguard.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003666 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003667 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003668 * @see android.app.KeyguardManager
3669 */
3670 public static final String KEYGUARD_SERVICE = "keyguard";
Scott Main4b5da682010-10-21 11:49:12 -07003671
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003672 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003673 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003674 * android.location.LocationManager} for controlling location
3675 * updates.
3676 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003677 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003678 * @see android.location.LocationManager
3679 */
3680 public static final String LOCATION_SERVICE = "location";
Bai Taoa58a8752010-07-13 15:32:16 +08003681
3682 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003683 * Use with {@link #getSystemService(String)} to retrieve a
Bai Taoa58a8752010-07-13 15:32:16 +08003684 * {@link android.location.CountryDetector} for detecting the country that
3685 * the user is in.
3686 *
3687 * @hide
3688 */
Mathew Inwood8c854f82018-09-14 12:35:36 +01003689 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
Bai Taoa58a8752010-07-13 15:32:16 +08003690 public static final String COUNTRY_DETECTOR = "country_detector";
3691
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003692 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003693 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003694 * android.app.SearchManager} for handling searches.
3695 *
Erik Wolsheimerac5cecd2017-12-05 13:11:50 -08003696 * <p>
3697 * {@link Configuration#UI_MODE_TYPE_WATCH} does not support
3698 * {@link android.app.SearchManager}.
3699 *
3700 * @see #getSystemService
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003701 * @see android.app.SearchManager
3702 */
3703 public static final String SEARCH_SERVICE = "search";
Scott Main4b5da682010-10-21 11:49:12 -07003704
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003705 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003706 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003707 * android.hardware.SensorManager} for accessing sensors.
3708 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003709 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003710 * @see android.hardware.SensorManager
3711 */
3712 public static final String SENSOR_SERVICE = "sensor";
Scott Main4b5da682010-10-21 11:49:12 -07003713
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003714 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003715 * Use with {@link #getSystemService(String)} to retrieve a {@link
Chad Brubaker90f391f2018-10-19 10:26:19 -07003716 * android.hardware.SensorPrivacyManager} for accessing sensor privacy
3717 * functions.
3718 *
3719 * @see #getSystemService(String)
3720 * @see android.hardware.SensorPrivacyManager
3721 *
3722 * @hide
3723 */
3724 public static final String SENSOR_PRIVACY_SERVICE = "sensor_privacy";
3725
3726 /**
3727 * Use with {@link #getSystemService(String)} to retrieve a {@link
Kenny Root02c87302010-07-01 08:10:18 -07003728 * android.os.storage.StorageManager} for accessing system storage
San Mehatc9d81752010-02-01 10:23:27 -08003729 * functions.
3730 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003731 * @see #getSystemService(String)
San Mehatb1043402010-02-05 08:26:50 -08003732 * @see android.os.storage.StorageManager
San Mehatc9d81752010-02-01 10:23:27 -08003733 */
3734 public static final String STORAGE_SERVICE = "storage";
3735
3736 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003737 * Use with {@link #getSystemService(String)} to retrieve a {@link
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003738 * android.app.usage.StorageStatsManager} for accessing system storage
3739 * statistics.
3740 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003741 * @see #getSystemService(String)
Jeff Sharkeye8cece92017-01-04 11:33:33 -07003742 * @see android.app.usage.StorageStatsManager
3743 */
3744 public static final String STORAGE_STATS_SERVICE = "storagestats";
3745
3746 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003747 * Use with {@link #getSystemService(String)} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003748 * com.android.server.WallpaperService for accessing wallpapers.
3749 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003750 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003751 */
3752 public static final String WALLPAPER_SERVICE = "wallpaper";
Scott Main4b5da682010-10-21 11:49:12 -07003753
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003754 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003755 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003756 * android.os.Vibrator} for interacting with the vibration hardware.
3757 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003758 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003759 * @see android.os.Vibrator
3760 */
3761 public static final String VIBRATOR_SERVICE = "vibrator";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07003762
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003763 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003764 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003765 * android.app.StatusBarManager} for interacting with the status bar.
3766 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003767 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003768 * @see android.app.StatusBarManager
Evan Lairdedd016f2019-01-23 18:36:29 -05003769 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003770 * @hide
3771 */
Evan Lairdedd016f2019-01-23 18:36:29 -05003772 @SystemApi
Evan Laird418ba8f2019-04-17 15:55:21 -04003773 @TestApi
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003774 public static final String STATUS_BAR_SERVICE = "statusbar";
3775
3776 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003777 * Use with {@link #getSystemService(String)} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003778 * android.net.ConnectivityManager} for handling management of
3779 * network connections.
3780 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003781 * @see #getSystemService(String)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003782 * @see android.net.ConnectivityManager
3783 */
3784 public static final String CONNECTIVITY_SERVICE = "connectivity";
3785
3786 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08003787 * Use with {@link #getSystemService(String)} to retrieve a
Remi NGUYEN VAN31935982019-01-28 11:40:08 +09003788 * {@link android.net.INetd} for communicating with the network stack
3789 * @hide
3790 * @see #getSystemService(String)
3791 * @hide
3792 */
3793 @SystemApi
3794 public static final String NETD_SERVICE = "netd";
3795
3796 /**
Remi NGUYEN VAN310da6f2019-02-14 18:04:20 +09003797 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
3798 * {@link NetworkStackClient} IBinder for communicating with the network stack
Remi NGUYEN VANc094a542018-12-07 16:52:24 +09003799 * @hide
Remi NGUYEN VAN310da6f2019-02-14 18:04:20 +09003800 * @see NetworkStackClient
Remi NGUYEN VANc094a542018-12-07 16:52:24 +09003801 */
3802 public static final String NETWORK_STACK_SERVICE = "network_stack";
3803
3804 /**
Roshan Pius6f5338d2019-06-14 14:37:14 -07003805 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
3806 * {@link android.net.WifiStackClient} IBinder for communicating with the network stack
3807 * @hide
3808 * @see android.net.WifiStackClient
3809 */
3810 public static final String WIFI_STACK_SERVICE = "wifi_stack";
3811
3812 /**
Remi NGUYEN VANc094a542018-12-07 16:52:24 +09003813 * 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 *
Felipe Leme6378bd42019-08-14 18:14:55 -07004187 * <p><b>NOTE: </b> this service is optional; callers of
4188 * {@code Context.getSystemServiceName(APP_PREDICTION_SERVICE)} should check for {@code null}.
4189 *
Sunny Goyal54e91342018-11-14 11:59:02 -08004190 * @hide
4191 * @see #getSystemService(String)
4192 */
4193 @SystemApi
4194 public static final String APP_PREDICTION_SERVICE = "app_prediction";
4195
4196 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004197 * Use with {@link #getSystemService(String)} to access the
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004198 * {@link com.android.server.voiceinteraction.SoundTriggerService}.
4199 *
4200 * @hide
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004201 * @see #getSystemService(String)
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004202 */
4203 public static final String SOUND_TRIGGER_SERVICE = "soundtrigger";
4204
Philip P. Moltmann039678e2018-09-18 13:04:38 -07004205 /**
4206 * Official published name of the (internal) permission service.
4207 *
4208 * @see #getSystemService(String)
4209 * @hide
4210 */
Winsonf27394e2019-06-07 14:44:40 -07004211 @TestApi
Philip P. Moltmann039678e2018-09-18 13:04:38 -07004212 @SystemApi
4213 public static final String PERMISSION_SERVICE = "permission";
Arunesh Mishraa772e5f2016-01-25 10:33:11 -08004214
4215 /**
Philip P. Moltmannbc054d82018-12-21 09:41:58 -08004216 * Official published name of the (internal) permission controller service.
4217 *
4218 * @see #getSystemService(String)
4219 * @hide
4220 */
4221 public static final String PERMISSION_CONTROLLER_SERVICE = "permission_controller";
4222
4223 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004224 * Use with {@link #getSystemService(String)} to retrieve an
Christopher Tate45281862010-03-05 15:46:30 -08004225 * {@link android.app.backup.IBackupManager IBackupManager} for communicating
Christopher Tate487529a2009-04-29 14:03:25 -07004226 * with the backup mechanism.
Dianne Hackborn7f205432009-07-28 00:13:47 -07004227 * @hide
Scott Main4b5da682010-10-21 11:49:12 -07004228 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004229 * @see #getSystemService(String)
Christopher Tate487529a2009-04-29 14:03:25 -07004230 */
Christopher Tated5cf7222014-07-29 16:53:09 -07004231 @SystemApi
Christopher Tate487529a2009-04-29 14:03:25 -07004232 public static final String BACKUP_SERVICE = "backup";
Dan Egnor95240272009-10-27 18:23:39 -07004233
4234 /**
Richard Uhlerb29f1452018-09-12 16:38:15 +01004235 * Use with {@link #getSystemService(String)} to retrieve an
4236 * {@link android.content.rollback.RollbackManager} for communicating
4237 * with the rollback manager
4238 *
4239 * @see #getSystemService(String)
Richard Uhlerc739c8c2018-12-12 11:03:34 +00004240 * @hide
Richard Uhlerb29f1452018-09-12 16:38:15 +01004241 */
Richard Uhler8a977452019-03-08 13:27:17 +00004242 @SystemApi @TestApi
Richard Uhlerb29f1452018-09-12 16:38:15 +01004243 public static final String ROLLBACK_SERVICE = "rollback";
4244
4245 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004246 * Use with {@link #getSystemService(String)} to retrieve a
Dan Egnor1337b012010-01-04 11:01:44 -08004247 * {@link android.os.DropBoxManager} instance for recording
Dan Egnor95240272009-10-27 18:23:39 -07004248 * diagnostic logs.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004249 * @see #getSystemService(String)
Dan Egnor95240272009-10-27 18:23:39 -07004250 */
4251 public static final String DROPBOX_SERVICE = "dropbox";
4252
Christopher Tate487529a2009-04-29 14:03:25 -07004253 /**
Philip P. Moltmannf80809f2018-04-04 11:20:44 -07004254 * System service name for the DeviceIdleManager.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004255 * @see #getSystemService(String)
Dianne Hackborn1958e5e2015-06-12 18:11:41 -07004256 * @hide
4257 */
Makoto Onuki7d6d9ca2019-08-13 11:45:45 -07004258 @TestApi
Dianne Hackborn1958e5e2015-06-12 18:11:41 -07004259 public static final String DEVICE_IDLE_CONTROLLER = "deviceidle";
4260
4261 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004262 * Use with {@link #getSystemService(String)} to retrieve a
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08004263 * {@link android.app.admin.DevicePolicyManager} for working with global
Dianne Hackbornd6847842010-01-12 18:14:19 -08004264 * device policy management.
4265 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004266 * @see #getSystemService(String)
Dianne Hackbornd6847842010-01-12 18:14:19 -08004267 */
4268 public static final String DEVICE_POLICY_SERVICE = "device_policy";
4269
4270 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004271 * Use with {@link #getSystemService(String)} to retrieve a
Tobias Haamel53332882010-02-18 16:15:43 -08004272 * {@link android.app.UiModeManager} for controlling UI modes.
4273 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004274 * @see #getSystemService(String)
Tobias Haamel53332882010-02-18 16:15:43 -08004275 */
4276 public static final String UI_MODE_SERVICE = "uimode";
4277
4278 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004279 * Use with {@link #getSystemService(String)} to retrieve a
Steve Howardd58429f2010-09-27 16:32:39 -07004280 * {@link android.app.DownloadManager} for requesting HTTP downloads.
Steve Howarda2709362010-07-02 17:12:48 -07004281 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004282 * @see #getSystemService(String)
Steve Howarda2709362010-07-02 17:12:48 -07004283 */
4284 public static final String DOWNLOAD_SERVICE = "download";
4285
4286 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004287 * Use with {@link #getSystemService(String)} to retrieve a
Todd Poynore35872d2013-12-10 11:57:21 -08004288 * {@link android.os.BatteryManager} for managing battery state.
4289 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004290 * @see #getSystemService(String)
Todd Poynore35872d2013-12-10 11:57:21 -08004291 */
4292 public static final String BATTERY_SERVICE = "batterymanager";
4293
4294 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004295 * Use with {@link #getSystemService(String)} to retrieve a
Nick Pelly50b4d8f2010-12-07 22:40:28 -08004296 * {@link android.nfc.NfcManager} for using NFC.
4297 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004298 * @see #getSystemService(String)
Nick Pelly50b4d8f2010-12-07 22:40:28 -08004299 */
4300 public static final String NFC_SERVICE = "nfc";
4301
4302 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004303 * Use with {@link #getSystemService(String)} to retrieve a
Florian Salbrechter084da9b2015-03-25 11:00:55 +00004304 * {@link android.bluetooth.BluetoothManager} for using Bluetooth.
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08004305 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004306 * @see #getSystemService(String)
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08004307 */
4308 public static final String BLUETOOTH_SERVICE = "bluetooth";
4309
4310 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004311 * Use with {@link #getSystemService(String)} to retrieve a
Chung-yih Wang2d942312010-08-05 12:17:37 +08004312 * {@link android.net.sip.SipManager} for accessing the SIP related service.
4313 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004314 * @see #getSystemService(String)
Chung-yih Wang2d942312010-08-05 12:17:37 +08004315 */
4316 /** @hide */
4317 public static final String SIP_SERVICE = "sip";
4318
4319 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004320 * Use with {@link #getSystemService(String)} to retrieve a {@link
Mike Lockwoodc4308f02011-03-01 08:04:54 -08004321 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host)
Mike Lockwoode7d511e2010-12-30 13:39:37 -05004322 * and for controlling this device's behavior as a USB device.
4323 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004324 * @see #getSystemService(String)
John Spurlock6098c5d2013-06-17 10:32:46 -04004325 * @see android.hardware.usb.UsbManager
Mike Lockwoode7d511e2010-12-30 13:39:37 -05004326 */
4327 public static final String USB_SERVICE = "usb";
4328
4329 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004330 * Use with {@link #getSystemService(String)} to retrieve a {@link
Kenny Rootf74bfde2018-01-18 15:42:48 -08004331 * Use with {@link #getSystemService} to retrieve a {@link
4332 * android.debug.AdbManager} for access to ADB debug functions.
4333 *
4334 * @see #getSystemService(String)
4335 * @see android.debug.AdbManager
4336 *
4337 * @hide
4338 */
4339 public static final String ADB_SERVICE = "adb";
4340
4341 /**
4342 * Use with {@link #getSystemService(String)} to retrieve a {@link
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04004343 * android.hardware.SerialManager} for access to serial ports.
4344 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004345 * @see #getSystemService(String)
Dianne Hackborn35f72be2013-09-16 10:57:39 -07004346 * @see android.hardware.SerialManager
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04004347 *
4348 * @hide
4349 */
4350 public static final String SERIAL_SERVICE = "serial";
4351
4352 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004353 * Use with {@link #getSystemService(String)} to retrieve a
Jinsuk Kim91120c52014-05-08 17:12:51 +09004354 * {@link android.hardware.hdmi.HdmiControlManager} for controlling and managing
4355 * HDMI-CEC protocol.
4356 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004357 * @see #getSystemService(String)
Jinsuk Kim91120c52014-05-08 17:12:51 +09004358 * @see android.hardware.hdmi.HdmiControlManager
Jinsuk Kim66d1eb22014-06-06 16:12:18 +09004359 * @hide
Jinsuk Kim91120c52014-05-08 17:12:51 +09004360 */
Jinsuk Kim66d1eb22014-06-06 16:12:18 +09004361 @SystemApi
Jinsuk Kim91120c52014-05-08 17:12:51 +09004362 public static final String HDMI_CONTROL_SERVICE = "hdmi_control";
Jinsuk Kimfbcd5032014-03-21 16:25:13 +09004363
4364 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004365 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Brown9df6e7a2012-04-05 11:49:26 -07004366 * {@link android.hardware.input.InputManager} for interacting with input devices.
4367 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004368 * @see #getSystemService(String)
Jeff Brown9df6e7a2012-04-05 11:49:26 -07004369 * @see android.hardware.input.InputManager
4370 */
4371 public static final String INPUT_SERVICE = "input";
4372
4373 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004374 * Use with {@link #getSystemService(String)} to retrieve a
Jeff Brownfa25bf52012-07-23 19:26:30 -07004375 * {@link android.hardware.display.DisplayManager} for interacting with display devices.
4376 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004377 * @see #getSystemService(String)
Jeff Brownfa25bf52012-07-23 19:26:30 -07004378 * @see android.hardware.display.DisplayManager
4379 */
4380 public static final String DISPLAY_SERVICE = "display";
4381
4382 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004383 * Use with {@link #getSystemService(String)} to retrieve a
Christine Franks39b03112018-07-03 14:46:07 -07004384 * {@link android.hardware.display.ColorDisplayManager} for controlling color transforms.
4385 *
4386 * @see #getSystemService(String)
4387 * @see android.hardware.display.ColorDisplayManager
4388 * @hide
4389 */
4390 public static final String COLOR_DISPLAY_SERVICE = "color_display";
4391
4392 /**
4393 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasani258848d2012-08-10 17:06:33 -07004394 * {@link android.os.UserManager} for managing users on devices that support multiple users.
4395 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004396 * @see #getSystemService(String)
Amith Yamasani258848d2012-08-10 17:06:33 -07004397 * @see android.os.UserManager
4398 */
4399 public static final String USER_SERVICE = "user";
4400
4401 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004402 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasani4f582632014-02-19 14:31:52 -08004403 * {@link android.content.pm.LauncherApps} for querying and monitoring launchable apps across
4404 * profiles of a user.
4405 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004406 * @see #getSystemService(String)
Amith Yamasani4f582632014-02-19 14:31:52 -08004407 * @see android.content.pm.LauncherApps
4408 */
4409 public static final String LAUNCHER_APPS_SERVICE = "launcherapps";
4410
4411 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004412 * Use with {@link #getSystemService(String)} to retrieve a
Amith Yamasanif20d6402014-05-24 15:34:37 -07004413 * {@link android.content.RestrictionsManager} for retrieving application restrictions
4414 * and requesting permissions for restricted operations.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004415 * @see #getSystemService(String)
Amith Yamasanif20d6402014-05-24 15:34:37 -07004416 * @see android.content.RestrictionsManager
4417 */
4418 public static final String RESTRICTIONS_SERVICE = "restrictions";
4419
4420 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004421 * Use with {@link #getSystemService(String)} to retrieve a
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004422 * {@link android.app.AppOpsManager} for tracking application operations
4423 * on the device.
4424 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004425 * @see #getSystemService(String)
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004426 * @see android.app.AppOpsManager
Dianne Hackborna06de0f2012-12-11 16:34:47 -08004427 */
4428 public static final String APP_OPS_SERVICE = "appops";
4429
4430 /**
Hai Zhangb7776682018-09-25 15:10:57 -07004431 * Use with {@link #getSystemService(String)} to retrieve a {@link android.app.role.RoleManager}
4432 * for managing roles.
4433 *
4434 * @see #getSystemService(String)
4435 * @see android.app.role.RoleManager
4436 */
4437 public static final String ROLE_SERVICE = "role";
4438
4439 /**
Hai Zhanga4959e52019-03-06 12:21:07 -08004440 * Official published name of the (internal) role controller service.
4441 *
4442 * @see #getSystemService(String)
4443 * @see android.app.role.RoleControllerService
4444 *
4445 * @hide
4446 */
4447 public static final String ROLE_CONTROLLER_SERVICE = "role_controller";
4448
4449 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004450 * Use with {@link #getSystemService(String)} to retrieve a
Eino-Ville Talvala2f1a2e42013-07-25 17:12:05 -07004451 * {@link android.hardware.camera2.CameraManager} for interacting with
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08004452 * camera devices.
4453 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004454 * @see #getSystemService(String)
Dianne Hackborn221ea892013-08-04 16:50:16 -07004455 * @see android.hardware.camera2.CameraManager
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08004456 */
4457 public static final String CAMERA_SERVICE = "camera";
4458
4459 /**
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004460 * {@link android.print.PrintManager} for printing and managing
Jeff Brown511cd352013-08-23 17:43:37 -07004461 * printers and print tasks.
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004462 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004463 * @see #getSystemService(String)
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07004464 * @see android.print.PrintManager
4465 */
4466 public static final String PRINT_SERVICE = "print";
4467
4468 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004469 * Use with {@link #getSystemService(String)} to retrieve a
Eugene Susla6ed45d82017-01-22 13:52:51 -08004470 * {@link android.companion.CompanionDeviceManager} for managing companion devices
4471 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004472 * @see #getSystemService(String)
Eugene Susla6ed45d82017-01-22 13:52:51 -08004473 * @see android.companion.CompanionDeviceManager
4474 */
Eugene Suslad7355cc2017-04-20 11:14:45 -07004475 public static final String COMPANION_DEVICE_SERVICE = "companiondevice";
Eugene Susla6ed45d82017-01-22 13:52:51 -08004476
4477 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004478 * Use with {@link #getSystemService(String)} to retrieve a
Erik Gilling51e95df2013-06-26 11:06:51 -07004479 * {@link android.hardware.ConsumerIrManager} for transmitting infrared
4480 * signals from the device.
4481 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004482 * @see #getSystemService(String)
Erik Gilling51e95df2013-06-26 11:06:51 -07004483 * @see android.hardware.ConsumerIrManager
4484 */
4485 public static final String CONSUMER_IR_SERVICE = "consumer_ir";
4486
4487 /**
Adrian Roos82142c22014-03-27 14:56:59 +01004488 * {@link android.app.trust.TrustManager} for managing trust agents.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004489 * @see #getSystemService(String)
Adrian Roos82142c22014-03-27 14:56:59 +01004490 * @see android.app.trust.TrustManager
4491 * @hide
4492 */
4493 public static final String TRUST_SERVICE = "trust";
4494
4495 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004496 * Use with {@link #getSystemService(String)} to retrieve a
Jae Seod5cc4a22014-05-30 16:57:43 -07004497 * {@link android.media.tv.TvInputManager} for interacting with TV inputs
4498 * on the device.
Jae Seo39570912014-02-20 18:23:25 -08004499 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004500 * @see #getSystemService(String)
Jae Seod5cc4a22014-05-30 16:57:43 -07004501 * @see android.media.tv.TvInputManager
Jae Seo39570912014-02-20 18:23:25 -08004502 */
4503 public static final String TV_INPUT_SERVICE = "tv_input";
4504
4505 /**
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004506 * {@link android.net.NetworkScoreManager} for managing network scoring.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004507 * @see #getSystemService(String)
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004508 * @see android.net.NetworkScoreManager
4509 * @hide
4510 */
Jeff Davidson5ad20792014-07-21 13:55:42 -07004511 @SystemApi
Jeff Davidsonb51e0a62014-04-09 12:38:15 -07004512 public static final String NETWORK_SCORE_SERVICE = "network_score";
4513
4514 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004515 * Use with {@link #getSystemService(String)} to retrieve a {@link
Adam Lesinskiaa607672014-11-24 11:27:50 -08004516 * android.app.usage.UsageStatsManager} for querying device usage stats.
Dianne Hackborne22b3b12014-05-07 18:06:44 -07004517 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004518 * @see #getSystemService(String)
Dianne Hackbornff170242014-11-19 10:59:01 -08004519 * @see android.app.usage.UsageStatsManager
Dianne Hackborne22b3b12014-05-07 18:06:44 -07004520 */
4521 public static final String USAGE_STATS_SERVICE = "usagestats";
4522
4523 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004524 * Use with {@link #getSystemService(String)} to retrieve a {@link
Christopher Tate7060b042014-06-09 19:50:00 -07004525 * android.app.job.JobScheduler} instance for managing occasional
Christopher Tatefa380e92014-05-19 13:46:29 -07004526 * background tasks.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004527 * @see #getSystemService(String)
Christopher Tate7060b042014-06-09 19:50:00 -07004528 * @see android.app.job.JobScheduler
Christopher Tatefa380e92014-05-19 13:46:29 -07004529 */
Christopher Tate7060b042014-06-09 19:50:00 -07004530 public static final String JOB_SCHEDULER_SERVICE = "jobscheduler";
Christopher Tatefa380e92014-05-19 13:46:29 -07004531
4532 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004533 * Use with {@link #getSystemService(String)} to retrieve a {@link
Andres Morales33df9372014-09-26 17:08:59 -07004534 * android.service.persistentdata.PersistentDataBlockManager} instance
4535 * for interacting with a storage device that lives across factory resets.
4536 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004537 * @see #getSystemService(String)
Andres Morales68d4acd2014-07-01 19:40:41 -07004538 * @see android.service.persistentdata.PersistentDataBlockManager
4539 * @hide
4540 */
Andres Morales33df9372014-09-26 17:08:59 -07004541 @SystemApi
Andres Morales68d4acd2014-07-01 19:40:41 -07004542 public static final String PERSISTENT_DATA_BLOCK_SERVICE = "persistent_data_block";
4543
4544 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004545 * Use with {@link #getSystemService(String)} to retrieve a {@link
Andrew Scull3b8b46f2017-02-13 18:12:15 +00004546 * android.service.oemlock.OemLockManager} instance for managing the OEM lock.
4547 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004548 * @see #getSystemService(String)
Andrew Scull3b8b46f2017-02-13 18:12:15 +00004549 * @see android.service.oemlock.OemLockManager
4550 * @hide
4551 */
4552 @SystemApi
4553 public static final String OEM_LOCK_SERVICE = "oem_lock";
4554
4555 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004556 * Use with {@link #getSystemService(String)} to retrieve a {@link
Michael Wrightc39d47a2014-07-08 18:07:36 -07004557 * android.media.projection.MediaProjectionManager} instance for managing
4558 * media projection sessions.
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004559 * @see #getSystemService(String)
Jeff Brown6e539312015-02-24 18:53:21 -08004560 * @see android.media.projection.MediaProjectionManager
Michael Wrightc39d47a2014-07-08 18:07:36 -07004561 */
4562 public static final String MEDIA_PROJECTION_SERVICE = "media_projection";
4563
4564 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004565 * Use with {@link #getSystemService(String)} to retrieve a
Mike Lockwoodb6737702015-02-20 08:28:47 -08004566 * {@link android.media.midi.MidiManager} for accessing the MIDI service.
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08004567 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004568 * @see #getSystemService(String)
Mike Lockwood67f8e8b2014-12-01 13:54:59 -08004569 */
4570 public static final String MIDI_SERVICE = "midi";
4571
Eric Laurent2035ac82015-03-05 15:18:44 -08004572
4573 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004574 * Use with {@link #getSystemService(String)} to retrieve a
Eric Laurent2035ac82015-03-05 15:18:44 -08004575 * {@link android.hardware.radio.RadioManager} for accessing the broadcast radio service.
4576 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004577 * @see #getSystemService(String)
Eric Laurent2035ac82015-03-05 15:18:44 -08004578 * @hide
4579 */
Tomasz Wasilczyk9110df72017-06-22 07:57:20 -07004580 public static final String RADIO_SERVICE = "broadcastradio";
Eric Laurent2035ac82015-03-05 15:18:44 -08004581
Paul McLeana33be212015-02-20 07:52:45 -08004582 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004583 * Use with {@link #getSystemService(String)} to retrieve a
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004584 * {@link android.os.HardwarePropertiesManager} for accessing the hardware properties service.
4585 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004586 * @see #getSystemService(String)
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004587 */
Polina Bondarenko8333c732016-03-09 18:08:42 +01004588 public static final String HARDWARE_PROPERTIES_SERVICE = "hardware_properties";
Polina Bondarenko965ecbb2015-11-13 15:34:28 +01004589
4590 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004591 * Use with {@link #getSystemService(String)} to retrieve a
Wei Wangbad7c202018-11-01 11:57:39 -07004592 * {@link android.os.ThermalService} for accessing the thermal service.
4593 *
4594 * @see #getSystemService(String)
4595 * @hide
4596 */
4597 public static final String THERMAL_SERVICE = "thermalservice";
4598
4599 /**
4600 * Use with {@link #getSystemService(String)} to retrieve a
Makoto Onukib5a012f2016-06-21 11:13:53 -07004601 * {@link android.content.pm.ShortcutManager} for accessing the launcher shortcut service.
Makoto Onuki6f7362d92016-03-04 13:39:41 -08004602 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004603 * @see #getSystemService(String)
Makoto Onuki6f7362d92016-03-04 13:39:41 -08004604 * @see android.content.pm.ShortcutManager
4605 */
4606 public static final String SHORTCUT_SERVICE = "shortcut";
4607
4608 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004609 * Use with {@link #getSystemService(String)} to retrieve a {@link
Peng Xu9ff7d222016-02-11 13:02:05 -08004610 * android.hardware.location.ContextHubManager} for accessing context hubs.
4611 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004612 * @see #getSystemService(String)
Peng Xu9ff7d222016-02-11 13:02:05 -08004613 * @see android.hardware.location.ContextHubManager
4614 *
4615 * @hide
4616 */
4617 @SystemApi
4618 public static final String CONTEXTHUB_SERVICE = "contexthub";
4619
4620 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004621 * Use with {@link #getSystemService(String)} to retrieve a
Joe Onorato713fec82016-03-04 10:34:02 -08004622 * {@link android.os.health.SystemHealthManager} for accessing system health (battery, power,
4623 * memory, etc) metrics.
4624 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004625 * @see #getSystemService(String)
Joe Onorato713fec82016-03-04 10:34:02 -08004626 */
4627 public static final String SYSTEM_HEALTH_SERVICE = "systemhealth";
4628
4629 /**
Amith Yamasanid04aaa32016-06-13 12:09:36 -07004630 * Gatekeeper Service.
4631 * @hide
4632 */
4633 public static final String GATEKEEPER_SERVICE = "android.service.gatekeeper.IGateKeeperService";
4634
4635 /**
Svet Ganov37e43272016-09-09 16:01:32 -07004636 * Service defining the policy for access to device identifiers.
4637 * @hide
4638 */
4639 public static final String DEVICE_IDENTIFIERS_SERVICE = "device_identifiers";
4640
4641 /**
Joe Onorato1754d742016-11-21 17:51:35 -08004642 * Service to report a system health "incident"
4643 * @hide
4644 */
4645 public static final String INCIDENT_SERVICE = "incident";
4646
4647 /**
Joe Onoratoe21ab7e2018-12-18 15:00:25 -08004648 * Service to assist incidentd and dumpstated in reporting status to the user
4649 * and in confirming authorization to take an incident report or bugreport
4650 * @hide
4651 */
4652 public static final String INCIDENT_COMPANION_SERVICE = "incidentcompanion";
4653
4654 /**
Bookatz94726412017-08-31 09:26:15 -07004655 * Service to assist statsd in obtaining general stats.
4656 * @hide
4657 */
4658 public static final String STATS_COMPANION_SERVICE = "statscompanion";
4659
4660 /**
Bookatzc6977972018-01-16 16:55:05 -08004661 * Use with {@link #getSystemService(String)} to retrieve an {@link android.app.StatsManager}.
David Chenadaf8b32017-11-03 15:42:08 -07004662 * @hide
4663 */
4664 @SystemApi
4665 public static final String STATS_MANAGER = "stats";
4666
4667 /**
atrostde54a8ac2019-08-15 16:53:01 +01004668 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
4669 * {@link IPlatformCompat} IBinder for communicating with the platform compat service.
4670 * @hide
4671 */
4672 public static final String PLATFORM_COMPAT_SERVICE = "platform_compat";
4673
4674 /**
atrost87488352019-10-10 19:27:31 +01004675 * Use with {@link android.os.ServiceManager.getService()} to retrieve a
4676 * {@link IPlatformCompatNative} IBinder for native code communicating with the platform compat
4677 * service.
4678 * @hide
4679 */
4680 public static final String PLATFORM_COMPAT_NATIVE_SERVICE = "platform_compat_native";
4681
4682 /**
Nandana Duttd11850c2018-12-12 17:26:57 +00004683 * Service to capture a bugreport.
4684 * @see #getSystemService(String)
4685 * @see android.os.BugreportManager
4686 * @hide
4687 */
Nandana Duttd7e8d5a2019-04-11 17:27:45 +01004688 @SystemApi @TestApi
Nandana Duttd11850c2018-12-12 17:26:57 +00004689 public static final String BUGREPORT_SERVICE = "bugreport";
4690
4691 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004692 * Use with {@link #getSystemService(String)} to retrieve a {@link
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01004693 * android.content.om.OverlayManager} for managing overlay packages.
4694 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004695 * @see #getSystemService(String)
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01004696 * @see android.content.om.OverlayManager
4697 * @hide
4698 */
4699 public static final String OVERLAY_SERVICE = "overlay";
4700
4701 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004702 * Use with {@link #getSystemService(String)} to retrieve a
MÃ¥rten Kongstad06a1ac82018-09-20 13:09:47 +02004703 * {android.os.IIdmap2} for managing idmap files (used by overlay
4704 * packages).
4705 *
4706 * @see #getSystemService(String)
4707 * @hide
4708 */
4709 public static final String IDMAP_SERVICE = "idmap";
4710
4711 /**
4712 * Use with {@link #getSystemService(String)} to retrieve a
Zak Cohen56345f42017-01-26 13:54:28 -08004713 * {@link VrManager} for accessing the VR service.
4714 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004715 * @see #getSystemService(String)
Zak Cohen56345f42017-01-26 13:54:28 -08004716 * @hide
4717 */
4718 @SystemApi
4719 public static final String VR_SERVICE = "vrmanager";
4720
4721 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004722 * Use with {@link #getSystemService(String)} to retrieve an
Neil Fullerfe6ec562017-03-16 18:29:36 +00004723 * {@link android.app.timezone.ITimeZoneRulesManager}.
4724 * @hide
4725 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004726 * @see #getSystemService(String)
Neil Fullerfe6ec562017-03-16 18:29:36 +00004727 */
4728 public static final String TIME_ZONE_RULES_MANAGER_SERVICE = "timezone";
4729
4730 /**
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004731 * Use with {@link #getSystemService(String)} to retrieve a
Tony Makb0d22622018-01-18 12:49:49 +00004732 * {@link android.content.pm.CrossProfileApps} for cross profile operations.
Tony Mak1b708e62017-10-12 10:59:11 +01004733 *
Ng Zhi Anf7c1e2b2018-01-08 11:18:08 -08004734 * @see #getSystemService(String)
Tony Mak1b708e62017-10-12 10:59:11 +01004735 */
4736 public static final String CROSS_PROFILE_APPS_SERVICE = "crossprofileapps";
4737
4738 /**
Ruchi Kandoi6149b0f2018-01-03 16:14:57 -08004739 * Use with {@link #getSystemService} to retrieve a
4740 * {@link android.se.omapi.ISecureElementService}
4741 * for accessing the SecureElementService.
4742 *
4743 * @hide
4744 */
4745 @SystemApi
4746 public static final String SECURE_ELEMENT_SERVICE = "secure_element";
4747
4748 /**
Neil Fullerfeeee682018-05-30 14:35:24 +01004749 * Use with {@link #getSystemService(String)} to retrieve an
4750 * {@link android.app.timedetector.ITimeDetectorService}.
4751 * @hide
4752 *
4753 * @see #getSystemService(String)
4754 */
4755 public static final String TIME_DETECTOR_SERVICE = "time_detector";
4756
4757 /**
Makoto Onukidf7e4812018-09-24 14:31:25 -07004758 * Binder service name for {@link AppBindingService}.
4759 * @hide
4760 */
4761 public static final String APP_BINDING_SERVICE = "app_binding";
4762
4763 /**
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004764 * Use with {@link #getSystemService(String)} to retrieve an
Brad Ebingerd1cb3462019-06-20 14:20:01 -07004765 * {@link android.telephony.ims.RcsMessageManager}.
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004766 * @hide
4767 */
Brad Ebingerd1cb3462019-06-20 14:20:01 -07004768 public static final String TELEPHONY_RCS_MESSAGE_SERVICE = "ircsmessage";
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004769
Howard Chen0a947642019-01-07 14:10:44 +08004770 /**
4771 * Use with {@link #getSystemService(String)} to retrieve an
Po-Chien Hsueh4e908c22019-03-07 11:57:17 +08004772 * {@link android.os.image.DynamicSystemManager}.
Howard Chen0a947642019-01-07 14:10:44 +08004773 * @hide
4774 */
Po-Chien Hsueh4e908c22019-03-07 11:57:17 +08004775 public static final String DYNAMIC_SYSTEM_SERVICE = "dynamic_system";
Howard Chen0a947642019-01-07 14:10:44 +08004776
Sahin Caliskan9458ebc2018-10-31 13:23:29 -07004777 /**
Chen Xu288b71c2019-09-15 18:28:21 -07004778 * Use with {@link #getSystemService(String)} to retrieve an
Chen Xu1f6cfa52019-10-13 17:30:32 -07004779 * {@link TelephonyRegistryManager}.
Chen Xu288b71c2019-09-15 18:28:21 -07004780 * @hide
4781 */
4782 @SystemApi
4783 public static final String TELEPHONY_REGISTRY_SERVICE = "telephony_registry";
4784
4785 /**
Roshan Pius848513e2019-10-11 13:44:00 -07004786 * Use with {@link #getSystemService(String)} to retrieve an
4787 * {@link android.os.BatteryStatsManager}.
4788 * @hide
4789 */
4790 @SystemApi
4791 public static final String BATTERY_STATS_SERVICE = "batterystats";
4792
4793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004794 * Determine whether the given permission is allowed for a particular
4795 * process and user ID running in the system.
4796 *
4797 * @param permission The name of the permission being checked.
4798 * @param pid The process ID being checked against. Must be > 0.
4799 * @param uid The user ID being checked against. A uid of 0 is the root
4800 * user, which will pass every permission check.
4801 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004802 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004803 * pid/uid is allowed that permission, or
4804 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4805 *
4806 * @see PackageManager#checkPermission(String, String)
4807 * @see #checkCallingPermission
4808 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004809 @CheckResult(suggest="#enforcePermission(String,int,int,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004810 @PackageManager.PermissionResult
4811 public abstract int checkPermission(@NonNull String permission, int pid, int uid);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004812
Dianne Hackbornff170242014-11-19 10:59:01 -08004813 /** @hide */
4814 @PackageManager.PermissionResult
Mathew Inwood5c0d3542018-08-14 13:54:31 +01004815 @UnsupportedAppUsage
Dianne Hackbornff170242014-11-19 10:59:01 -08004816 public abstract int checkPermission(@NonNull String permission, int pid, int uid,
4817 IBinder callerToken);
4818
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004819 /**
4820 * Determine whether the calling process of an IPC you are handling has been
4821 * granted a particular permission. This is basically the same as calling
4822 * {@link #checkPermission(String, int, int)} with the pid and uid returned
4823 * by {@link android.os.Binder#getCallingPid} and
4824 * {@link android.os.Binder#getCallingUid}. One important difference
4825 * is that if you are not currently processing an IPC, this function
4826 * will always fail. This is done to protect against accidentally
4827 * leaking permissions; you can use {@link #checkCallingOrSelfPermission}
4828 * to avoid this protection.
4829 *
4830 * @param permission The name of the permission being checked.
4831 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004832 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004833 * pid/uid is allowed that permission, or
4834 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4835 *
4836 * @see PackageManager#checkPermission(String, String)
4837 * @see #checkPermission
4838 * @see #checkCallingOrSelfPermission
4839 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004840 @CheckResult(suggest="#enforceCallingPermission(String,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004841 @PackageManager.PermissionResult
4842 public abstract int checkCallingPermission(@NonNull String permission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004843
4844 /**
4845 * Determine whether the calling process of an IPC <em>or you</em> have been
4846 * granted a particular permission. This is the same as
4847 * {@link #checkCallingPermission}, except it grants your own permissions
4848 * if you are not currently processing an IPC. Use with care!
4849 *
4850 * @param permission The name of the permission being checked.
4851 *
John Spurlock6098c5d2013-06-17 10:32:46 -04004852 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004853 * pid/uid is allowed that permission, or
4854 * {@link PackageManager#PERMISSION_DENIED} if it is not.
4855 *
4856 * @see PackageManager#checkPermission(String, String)
4857 * @see #checkPermission
4858 * @see #checkCallingPermission
4859 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08004860 @CheckResult(suggest="#enforceCallingOrSelfPermission(String,String)")
Tor Norbyed9273d62013-05-30 15:59:53 -07004861 @PackageManager.PermissionResult
4862 public abstract int checkCallingOrSelfPermission(@NonNull String permission);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004863
4864 /**
Svetoslavc6d1c342015-02-26 14:44:43 -08004865 * Determine whether <em>you</em> have been granted a particular permission.
4866 *
4867 * @param permission The name of the permission being checked.
4868 *
4869 * @return {@link PackageManager#PERMISSION_GRANTED} if you have the
4870 * permission, or {@link PackageManager#PERMISSION_DENIED} if not.
4871 *
4872 * @see PackageManager#checkPermission(String, String)
4873 * @see #checkCallingPermission(String)
4874 */
4875 @PackageManager.PermissionResult
4876 public abstract int checkSelfPermission(@NonNull String permission);
4877
4878 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004879 * If the given permission is not allowed for a particular process
4880 * and user ID running in the system, throw a {@link SecurityException}.
4881 *
4882 * @param permission The name of the permission being checked.
4883 * @param pid The process ID being checked against. Must be &gt; 0.
4884 * @param uid The user ID being checked against. A uid of 0 is the root
4885 * user, which will pass every permission check.
4886 * @param message A message to include in the exception if it is thrown.
4887 *
4888 * @see #checkPermission(String, int, int)
4889 */
4890 public abstract void enforcePermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004891 @NonNull String permission, int pid, int uid, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004892
4893 /**
4894 * If the calling process of an IPC you are handling has not been
4895 * granted a particular permission, throw a {@link
4896 * SecurityException}. This is basically the same as calling
4897 * {@link #enforcePermission(String, int, int, String)} with the
4898 * pid and uid returned by {@link android.os.Binder#getCallingPid}
4899 * and {@link android.os.Binder#getCallingUid}. One important
4900 * difference is that if you are not currently processing an IPC,
4901 * this function will always throw the SecurityException. This is
4902 * done to protect against accidentally leaking permissions; you
4903 * can use {@link #enforceCallingOrSelfPermission} to avoid this
4904 * protection.
4905 *
4906 * @param permission The name of the permission being checked.
4907 * @param message A message to include in the exception if it is thrown.
4908 *
4909 * @see #checkCallingPermission(String)
4910 */
4911 public abstract void enforceCallingPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004912 @NonNull String permission, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004913
4914 /**
4915 * If neither you nor the calling process of an IPC you are
4916 * handling has been granted a particular permission, throw a
4917 * {@link SecurityException}. This is the same as {@link
4918 * #enforceCallingPermission}, except it grants your own
4919 * permissions if you are not currently processing an IPC. Use
4920 * with care!
4921 *
4922 * @param permission The name of the permission being checked.
4923 * @param message A message to include in the exception if it is thrown.
4924 *
4925 * @see #checkCallingOrSelfPermission(String)
4926 */
4927 public abstract void enforceCallingOrSelfPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07004928 @NonNull String permission, @Nullable String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004929
4930 /**
4931 * Grant permission to access a specific Uri to another package, regardless
4932 * of whether that package has general permission to access the Uri's
4933 * content provider. This can be used to grant specific, temporary
4934 * permissions, typically in response to user interaction (such as the
4935 * user opening an attachment that you would like someone else to
4936 * display).
4937 *
4938 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
4939 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
4940 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
4941 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to
4942 * start an activity instead of this function directly. If you use this
4943 * function directly, you should be sure to call
4944 * {@link #revokeUriPermission} when the target should no longer be allowed
4945 * to access it.
4946 *
4947 * <p>To succeed, the content provider owning the Uri must have set the
4948 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions
4949 * grantUriPermissions} attribute in its manifest or included the
4950 * {@link android.R.styleable#AndroidManifestGrantUriPermission
4951 * &lt;grant-uri-permissions&gt;} tag.
4952 *
4953 * @param toPackage The package you would like to allow to access the Uri.
4954 * @param uri The Uri you would like to grant access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004955 * @param modeFlags The desired access modes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004956 *
4957 * @see #revokeUriPermission
4958 */
4959 public abstract void grantUriPermission(String toPackage, Uri uri,
Tor Norbyed9273d62013-05-30 15:59:53 -07004960 @Intent.GrantUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004961
4962 /**
4963 * Remove all permissions to access a particular content provider Uri
Dianne Hackborna47223f2017-03-30 13:49:13 -07004964 * that were previously added with {@link #grantUriPermission} or <em>any other</em> mechanism.
4965 * The given Uri will match all previously granted Uris that are the same or a
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004966 * sub-path of the given Uri. That is, revoking "content://foo/target" will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004967 * revoke both "content://foo/target" and "content://foo/target/sub", but not
Jeff Sharkey846318a2014-04-04 12:12:41 -07004968 * "content://foo". It will not remove any prefix grants that exist at a
4969 * higher level.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004970 *
Dianne Hackborn955d8d62014-10-07 20:17:19 -07004971 * <p>Prior to {@link android.os.Build.VERSION_CODES#LOLLIPOP}, if you did not have
Dianne Hackborn192679a2014-09-10 14:28:48 -07004972 * regular permission access to a Uri, but had received access to it through
4973 * a specific Uri permission grant, you could not revoke that grant with this
4974 * function and a {@link SecurityException} would be thrown. As of
Dianne Hackborna47223f2017-03-30 13:49:13 -07004975 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this function will not throw a security
4976 * exception, but will remove whatever permission grants to the Uri had been given to the app
Dianne Hackborn192679a2014-09-10 14:28:48 -07004977 * (or none).</p>
4978 *
Dianne Hackborna47223f2017-03-30 13:49:13 -07004979 * <p>Unlike {@link #revokeUriPermission(String, Uri, int)}, this method impacts all permission
4980 * grants matching the given Uri, for any package they had been granted to, through any
4981 * mechanism this had happened (such as indirectly through the clipboard, activity launch,
4982 * service start, etc). That means this can be potentially dangerous to use, as it can
4983 * revoke grants that another app could be strongly expecting to stick around.</p>
4984 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004985 * @param uri The Uri you would like to revoke access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06004986 * @param modeFlags The access modes to revoke.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004987 *
4988 * @see #grantUriPermission
4989 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004990 public abstract void revokeUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004991
4992 /**
Dianne Hackborna47223f2017-03-30 13:49:13 -07004993 * Remove permissions to access a particular content provider Uri
4994 * that were previously added with {@link #grantUriPermission} for a specific target
4995 * package. The given Uri will match all previously granted Uris that are the same or a
4996 * sub-path of the given Uri. That is, revoking "content://foo/target" will
4997 * revoke both "content://foo/target" and "content://foo/target/sub", but not
4998 * "content://foo". It will not remove any prefix grants that exist at a
4999 * higher level.
5000 *
5001 * <p>Unlike {@link #revokeUriPermission(Uri, int)}, this method will <em>only</em>
5002 * revoke permissions that had been explicitly granted through {@link #grantUriPermission}
5003 * and only for the package specified. Any matching grants that have happened through
5004 * other mechanisms (clipboard, activity launching, service starting, etc) will not be
5005 * removed.</p>
5006 *
5007 * @param toPackage The package you had previously granted access to.
5008 * @param uri The Uri you would like to revoke access to.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005009 * @param modeFlags The access modes to revoke.
Dianne Hackborna47223f2017-03-30 13:49:13 -07005010 *
5011 * @see #grantUriPermission
5012 */
5013 public abstract void revokeUriPermission(String toPackage, Uri uri,
5014 @Intent.AccessUriMode int modeFlags);
5015
5016 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005017 * Determine whether a particular process and user ID has been granted
5018 * permission to access a specific URI. This only checks for permissions
5019 * that have been explicitly granted -- if the given process/uid has
5020 * more general access to the URI's content provider then this check will
5021 * always fail.
5022 *
5023 * @param uri The uri that is being checked.
5024 * @param pid The process ID being checked against. Must be &gt; 0.
5025 * @param uid The user ID being checked against. A uid of 0 is the root
5026 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005027 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005028 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005029 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005030 * pid/uid is allowed to access that uri, or
5031 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5032 *
5033 * @see #checkCallingUriPermission
5034 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005035 @CheckResult(suggest="#enforceUriPermission(Uri,int,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005036 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005037 public abstract int checkUriPermission(Uri uri, int pid, int uid,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005038 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005039
Dianne Hackbornff170242014-11-19 10:59:01 -08005040 /** @hide */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005041 @PackageManager.PermissionResult
Dianne Hackbornff170242014-11-19 10:59:01 -08005042 public abstract int checkUriPermission(Uri uri, int pid, int uid,
5043 @Intent.AccessUriMode int modeFlags, IBinder callerToken);
5044
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005045 /**
5046 * Determine whether the calling process and user ID has been
5047 * granted permission to access a specific URI. This is basically
5048 * the same as calling {@link #checkUriPermission(Uri, int, int,
5049 * int)} with the pid and uid returned by {@link
5050 * android.os.Binder#getCallingPid} and {@link
5051 * android.os.Binder#getCallingUid}. One important difference is
5052 * that if you are not currently processing an IPC, this function
5053 * will always fail.
5054 *
5055 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005056 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005057 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005058 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005059 * is allowed to access that uri, or
5060 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5061 *
5062 * @see #checkUriPermission(Uri, int, int, int)
5063 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005064 @CheckResult(suggest="#enforceCallingUriPermission(Uri,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005065 @PackageManager.PermissionResult
Jeff Sharkey846318a2014-04-04 12:12:41 -07005066 public abstract int checkCallingUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005067
5068 /**
5069 * Determine whether the calling process of an IPC <em>or you</em> has been granted
5070 * permission to access a specific URI. This is the same as
5071 * {@link #checkCallingUriPermission}, except it grants your own permissions
5072 * if you are not currently processing an IPC. Use with care!
5073 *
5074 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005075 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005076 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005077 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005078 * is allowed to access that uri, or
5079 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5080 *
5081 * @see #checkCallingUriPermission
5082 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005083 @CheckResult(suggest="#enforceCallingOrSelfUriPermission(Uri,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005084 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005085 public abstract int checkCallingOrSelfUriPermission(Uri uri,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005086 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005087
5088 /**
5089 * Check both a Uri and normal permission. This allows you to perform
5090 * both {@link #checkPermission} and {@link #checkUriPermission} in one
5091 * call.
5092 *
5093 * @param uri The Uri whose permission is to be checked, or null to not
5094 * do this check.
5095 * @param readPermission The permission that provides overall read access,
5096 * or null to not do this check.
5097 * @param writePermission The permission that provides overall write
Tor Norbyed9273d62013-05-30 15:59:53 -07005098 * access, or null to not do this check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005099 * @param pid The process ID being checked against. Must be &gt; 0.
5100 * @param uid The user ID being checked against. A uid of 0 is the root
5101 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005102 * @param modeFlags The access modes to check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005103 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005104 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005105 * is allowed to access that uri or holds one of the given permissions, or
5106 * {@link PackageManager#PERMISSION_DENIED} if it is not.
5107 */
Tor Norbye1c2bf032015-03-02 10:57:08 -08005108 @CheckResult(suggest="#enforceUriPermission(Uri,String,String,int,int,int,String)")
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005109 @PackageManager.PermissionResult
Tor Norbyed9273d62013-05-30 15:59:53 -07005110 public abstract int checkUriPermission(@Nullable Uri uri, @Nullable String readPermission,
5111 @Nullable String writePermission, int pid, int uid,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005112 @Intent.AccessUriMode int modeFlags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005113
5114 /**
5115 * If a particular process and user ID has not been granted
5116 * permission to access a specific URI, throw {@link
5117 * SecurityException}. This only checks for permissions that have
5118 * been explicitly granted -- if the given process/uid has more
5119 * general access to the URI's content provider then this check
5120 * will always fail.
5121 *
5122 * @param uri The uri that is being checked.
5123 * @param pid The process ID being checked against. Must be &gt; 0.
5124 * @param uid The user ID being checked against. A uid of 0 is the root
5125 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005126 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005127 * @param message A message to include in the exception if it is thrown.
5128 *
5129 * @see #checkUriPermission(Uri, int, int, int)
5130 */
5131 public abstract void enforceUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005132 Uri uri, int pid, int uid, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005133
5134 /**
5135 * If the calling process and user ID has not been granted
5136 * permission to access a specific URI, throw {@link
5137 * SecurityException}. This is basically the same as calling
5138 * {@link #enforceUriPermission(Uri, int, int, int, String)} with
5139 * the pid and uid returned by {@link
5140 * android.os.Binder#getCallingPid} and {@link
5141 * android.os.Binder#getCallingUid}. One important difference is
5142 * that if you are not currently processing an IPC, this function
5143 * will always throw a SecurityException.
5144 *
5145 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005146 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005147 * @param message A message to include in the exception if it is thrown.
5148 *
5149 * @see #checkCallingUriPermission(Uri, int)
5150 */
5151 public abstract void enforceCallingUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005152 Uri uri, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005153
5154 /**
5155 * If the calling process of an IPC <em>or you</em> has not been
5156 * granted permission to access a specific URI, throw {@link
5157 * SecurityException}. This is the same as {@link
5158 * #enforceCallingUriPermission}, except it grants your own
5159 * permissions if you are not currently processing an IPC. Use
5160 * with care!
Scott Main4b5da682010-10-21 11:49:12 -07005161 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005162 * @param uri The uri that is being checked.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005163 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005164 * @param message A message to include in the exception if it is thrown.
5165 *
5166 * @see #checkCallingOrSelfUriPermission(Uri, int)
5167 */
5168 public abstract void enforceCallingOrSelfUriPermission(
Jeff Sharkey846318a2014-04-04 12:12:41 -07005169 Uri uri, @Intent.AccessUriMode int modeFlags, String message);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005170
5171 /**
5172 * Enforce both a Uri and normal permission. This allows you to perform
5173 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one
5174 * call.
Scott Main4b5da682010-10-21 11:49:12 -07005175 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005176 * @param uri The Uri whose permission is to be checked, or null to not
5177 * do this check.
5178 * @param readPermission The permission that provides overall read access,
5179 * or null to not do this check.
5180 * @param writePermission The permission that provides overall write
Tor Norbyed9273d62013-05-30 15:59:53 -07005181 * access, or null to not do this check.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005182 * @param pid The process ID being checked against. Must be &gt; 0.
5183 * @param uid The user ID being checked against. A uid of 0 is the root
5184 * user, which will pass every permission check.
Jeff Sharkey6503bd82017-04-19 23:24:18 -06005185 * @param modeFlags The access modes to enforce.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005186 * @param message A message to include in the exception if it is thrown.
5187 *
5188 * @see #checkUriPermission(Uri, String, String, int, int, int)
5189 */
5190 public abstract void enforceUriPermission(
Tor Norbyed9273d62013-05-30 15:59:53 -07005191 @Nullable Uri uri, @Nullable String readPermission,
Jeff Sharkey846318a2014-04-04 12:12:41 -07005192 @Nullable String writePermission, int pid, int uid, @Intent.AccessUriMode int modeFlags,
Tor Norbyed9273d62013-05-30 15:59:53 -07005193 @Nullable String message);
5194
5195 /** @hide */
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005196 @IntDef(flag = true, prefix = { "CONTEXT_" }, value = {
5197 CONTEXT_INCLUDE_CODE,
5198 CONTEXT_IGNORE_SECURITY,
5199 CONTEXT_RESTRICTED,
5200 CONTEXT_DEVICE_PROTECTED_STORAGE,
5201 CONTEXT_CREDENTIAL_PROTECTED_STORAGE,
5202 CONTEXT_REGISTER_PACKAGE,
5203 })
Tor Norbyed9273d62013-05-30 15:59:53 -07005204 @Retention(RetentionPolicy.SOURCE)
5205 public @interface CreatePackageOptions {}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005206
5207 /**
5208 * Flag for use with {@link #createPackageContext}: include the application
5209 * code with the context. This means loading code into the caller's
5210 * process, so that {@link #getClassLoader()} can be used to instantiate
5211 * the application's classes. Setting this flags imposes security
5212 * restrictions on what application context you can access; if the
5213 * requested application can not be safely loaded into your process,
5214 * java.lang.SecurityException will be thrown. If this flag is not set,
5215 * there will be no restrictions on the packages that can be loaded,
5216 * but {@link #getClassLoader} will always return the default system
5217 * class loader.
5218 */
5219 public static final int CONTEXT_INCLUDE_CODE = 0x00000001;
5220
5221 /**
5222 * Flag for use with {@link #createPackageContext}: ignore any security
5223 * restrictions on the Context being requested, allowing it to always
5224 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code
5225 * to be loaded into a process even when it isn't safe to do so. Use
5226 * with extreme care!
5227 */
5228 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002;
Scott Main4b5da682010-10-21 11:49:12 -07005229
Romain Guy870e09f2009-07-06 16:35:25 -07005230 /**
5231 * Flag for use with {@link #createPackageContext}: a restricted context may
5232 * disable specific features. For instance, a View associated with a restricted
5233 * context would ignore particular XML attributes.
5234 */
5235 public static final int CONTEXT_RESTRICTED = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005236
5237 /**
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005238 * Flag for use with {@link #createPackageContext}: point all file APIs at
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005239 * device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005240 *
5241 * @hide
5242 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005243 public static final int CONTEXT_DEVICE_PROTECTED_STORAGE = 0x00000008;
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005244
5245 /**
5246 * Flag for use with {@link #createPackageContext}: point all file APIs at
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005247 * credential-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005248 *
5249 * @hide
5250 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005251 public static final int CONTEXT_CREDENTIAL_PROTECTED_STORAGE = 0x00000010;
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005252
5253 /**
Dianne Hackbornfee756f2014-07-16 17:31:10 -07005254 * @hide Used to indicate we should tell the activity manager about the process
5255 * loading this code.
5256 */
5257 public static final int CONTEXT_REGISTER_PACKAGE = 0x40000000;
5258
5259 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005260 * Return a new Context object for the given application name. This
5261 * Context is the same as what the named application gets when it is
5262 * launched, containing the same resources and class loader. Each call to
5263 * this method returns a new instance of a Context object; Context objects
5264 * are not shared, however they share common state (Resources, ClassLoader,
5265 * etc) so the Context instance itself is fairly lightweight.
5266 *
Jeff Brown6e539312015-02-24 18:53:21 -08005267 * <p>Throws {@link android.content.pm.PackageManager.NameNotFoundException} if there is no
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005268 * application with the given package name.
5269 *
5270 * <p>Throws {@link java.lang.SecurityException} if the Context requested
5271 * can not be loaded into the caller's process for security reasons (see
5272 * {@link #CONTEXT_INCLUDE_CODE} for more information}.
5273 *
5274 * @param packageName Name of the application's package.
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005275 * @param flags Option flags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005276 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005277 * @return A {@link Context} for the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005278 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005279 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005280 * @throws PackageManager.NameNotFoundException if there is no application with
John Spurlock6098c5d2013-06-17 10:32:46 -04005281 * the given package name.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005282 */
5283 public abstract Context createPackageContext(String packageName,
Tor Norbyed9273d62013-05-30 15:59:53 -07005284 @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Romain Guy870e09f2009-07-06 16:35:25 -07005285
5286 /**
Jeff Sharkey6d515712012-09-20 16:06:08 -07005287 * Similar to {@link #createPackageContext(String, int)}, but with a
5288 * different {@link UserHandle}. For example, {@link #getContentResolver()}
5289 * will open any {@link Uri} as the given user.
5290 *
5291 * @hide
5292 */
Patrick Baumannef4c4072018-02-01 08:54:05 -08005293 @SystemApi
Jeff Sharkeyec5f7d12018-08-08 09:15:04 -06005294 @TestApi
Makoto Onukib8440012019-10-09 15:33:11 -07005295 @NonNull
Patrick Baumannef4c4072018-02-01 08:54:05 -08005296 public Context createPackageContextAsUser(
Makoto Onukib8440012019-10-09 15:33:11 -07005297 @NonNull String packageName, @CreatePackageOptions int flags, @NonNull UserHandle user)
Patrick Baumannef4c4072018-02-01 08:54:05 -08005298 throws PackageManager.NameNotFoundException {
5299 if (Build.IS_ENG) {
5300 throw new IllegalStateException("createPackageContextAsUser not overridden!");
5301 }
5302 return this;
5303 }
Jeff Sharkey6d515712012-09-20 16:06:08 -07005304
5305 /**
Makoto Onukib8440012019-10-09 15:33:11 -07005306 * Similar to {@link #createPackageContext(String, int)}, but for the own package with a
5307 * different {@link UserHandle}. For example, {@link #getContentResolver()}
5308 * will open any {@link Uri} as the given user.
5309 *
5310 * @hide
5311 */
5312 @SystemApi
5313 @TestApi
5314 @NonNull
Makoto Onukie5449f02019-10-11 20:19:58 -07005315 public Context createContextAsUser(@NonNull UserHandle user, @CreatePackageOptions int flags) {
Makoto Onukib8440012019-10-09 15:33:11 -07005316 if (Build.IS_ENG) {
5317 throw new IllegalStateException("createContextAsUser not overridden!");
5318 }
5319 return this;
5320 }
5321
5322 /**
Svetoslav976e8bd2014-07-16 15:12:03 -07005323 * Creates a context given an {@link android.content.pm.ApplicationInfo}.
5324 *
5325 * @hide
5326 */
Mathew Inwood5c0d3542018-08-14 13:54:31 +01005327 @UnsupportedAppUsage
Svetoslav976e8bd2014-07-16 15:12:03 -07005328 public abstract Context createApplicationContext(ApplicationInfo application,
Jeff Sharkey30e06bb2017-04-24 11:18:03 -06005329 @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Svetoslav976e8bd2014-07-16 15:12:03 -07005330
5331 /**
Adam Lesinski4e862812016-11-21 16:02:24 -08005332 * Return a new Context object for the given split name. The new Context has a ClassLoader and
5333 * Resources object that can access the split's and all of its dependencies' code/resources.
5334 * Each call to this method returns a new instance of a Context object;
5335 * Context objects are not shared, however common state (ClassLoader, other Resources for
5336 * the same split) may be so the Context itself can be fairly lightweight.
5337 *
5338 * @param splitName The name of the split to include, as declared in the split's
5339 * <code>AndroidManifest.xml</code>.
5340 * @return A {@link Context} with the given split's code and/or resources loaded.
5341 */
5342 public abstract Context createContextForSplit(String splitName)
5343 throws PackageManager.NameNotFoundException;
5344
5345 /**
Jeff Sharkeyad357d12018-02-02 13:25:31 -07005346 * Get the user associated with this context
Jim Millera75a8832013-02-07 16:53:32 -08005347 * @hide
5348 */
Jeff Sharkeya73b8fd2016-01-06 17:02:08 -07005349 @TestApi
Jeff Sharkeyad357d12018-02-02 13:25:31 -07005350 public UserHandle getUser() {
5351 return android.os.Process.myUserHandle();
5352 }
5353
5354 /**
5355 * Get the user associated with this context
5356 * @hide
5357 */
5358 @TestApi
5359 public @UserIdInt int getUserId() {
5360 return android.os.UserHandle.myUserId();
5361 }
Jim Millera75a8832013-02-07 16:53:32 -08005362
5363 /**
Dianne Hackborn756220b2012-08-14 16:45:30 -07005364 * Return a new Context object for the current Context but whose resources
5365 * are adjusted to match the given Configuration. Each call to this method
Jeff Browna492c3a2012-08-23 19:48:44 -07005366 * returns a new instance of a Context object; Context objects are not
Dianne Hackborn756220b2012-08-14 16:45:30 -07005367 * shared, however common state (ClassLoader, other Resources for the
5368 * same configuration) may be so the Context itself can be fairly lightweight.
5369 *
5370 * @param overrideConfiguration A {@link Configuration} specifying what
5371 * values to modify in the base Configuration of the original Context's
5372 * resources. If the base configuration changes (such as due to an
5373 * orientation change), the resources of this context will also change except
5374 * for those that have been explicitly overridden with a value here.
5375 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005376 * @return A {@link Context} with the given configuration override.
Dianne Hackborn756220b2012-08-14 16:45:30 -07005377 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005378 public abstract Context createConfigurationContext(
5379 @NonNull Configuration overrideConfiguration);
Dianne Hackborn756220b2012-08-14 16:45:30 -07005380
5381 /**
Jeff Browna492c3a2012-08-23 19:48:44 -07005382 * Return a new Context object for the current Context but whose resources
5383 * are adjusted to match the metrics of the given Display. Each call to this method
5384 * returns a new instance of a Context object; Context objects are not
5385 * shared, however common state (ClassLoader, other Resources for the
5386 * same configuration) may be so the Context itself can be fairly lightweight.
5387 *
5388 * The returned display Context provides a {@link WindowManager}
5389 * (see {@link #getSystemService(String)}) that is configured to show windows
5390 * on the given display. The WindowManager's {@link WindowManager#getDefaultDisplay}
5391 * method can be used to retrieve the Display from the returned Context.
5392 *
5393 * @param display A {@link Display} object specifying the display
5394 * for whose metrics the Context's resources should be tailored and upon which
5395 * new windows should be shown.
5396 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005397 * @return A {@link Context} for the display.
Jeff Browna492c3a2012-08-23 19:48:44 -07005398 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005399 public abstract Context createDisplayContext(@NonNull Display display);
Jeff Browna492c3a2012-08-23 19:48:44 -07005400
5401 /**
Philip P. Moltmann59076d82019-08-19 15:00:40 -07005402 * Return a new Context object for the current Context but for a different feature in the app.
5403 * Features can be used by complex apps to separate logical parts.
5404 *
5405 * @param featureId The feature id or {@code null} to create a context for the default feature.
5406 *
5407 * @return A {@link Context} for the feature
5408 *
5409 * @see #getFeatureId()
5410 */
5411 public @NonNull Context createFeatureContext(@Nullable String featureId) {
Philip P. Moltmannf1a634c2019-10-18 09:10:56 -07005412 throw new RuntimeException("Not implemented. Must override in a subclass.");
Philip P. Moltmann59076d82019-08-19 15:00:40 -07005413 }
5414
5415 /**
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005416 * Return a new Context object for the current Context but whose storage
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005417 * APIs are backed by device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005418 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06005419 * On devices with direct boot, data stored in this location is encrypted
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005420 * with a key tied to the physical device, and it can be accessed
5421 * immediately after the device has booted successfully, both
5422 * <em>before and after</em> the user has authenticated with their
5423 * credentials (such as a lock pattern or PIN).
5424 * <p>
5425 * Because device-protected data is available without user authentication,
5426 * you should carefully limit the data you store using this Context. For
5427 * example, storing sensitive authentication tokens or passwords in the
5428 * device-protected area is strongly discouraged.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005429 * <p>
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005430 * If the underlying device does not have the ability to store
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005431 * device-protected and credential-protected data using different keys, then
5432 * both storage areas will become available at the same time. They remain as
5433 * two distinct storage locations on disk, and only the window of
5434 * availability changes.
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005435 * <p>
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005436 * Each call to this method returns a new instance of a Context object;
5437 * Context objects are not shared, however common state (ClassLoader, other
5438 * Resources for the same configuration) may be so the Context itself can be
5439 * fairly lightweight.
5440 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005441 * @see #isDeviceProtectedStorage()
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005442 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005443 public abstract Context createDeviceProtectedStorageContext();
5444
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005445 /**
5446 * Return a new Context object for the current Context but whose storage
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005447 * APIs are backed by credential-protected storage. This is the default
5448 * storage area for apps unless
5449 * {@link android.R.attr#defaultToDeviceProtectedStorage} was requested.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005450 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06005451 * On devices with direct boot, data stored in this location is encrypted
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005452 * with a key tied to user credentials, which can be accessed
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005453 * <em>only after</em> the user has entered their credentials (such as a
5454 * lock pattern or PIN).
5455 * <p>
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005456 * If the underlying device does not have the ability to store
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005457 * device-protected and credential-protected data using different keys, then
5458 * both storage areas will become available at the same time. They remain as
5459 * two distinct storage locations on disk, and only the window of
5460 * availability changes.
Jeff Sharkey3ea44a52016-01-09 15:19:56 -07005461 * <p>
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005462 * Each call to this method returns a new instance of a Context object;
5463 * Context objects are not shared, however common state (ClassLoader, other
5464 * Resources for the same configuration) may be so the Context itself can be
5465 * fairly lightweight.
5466 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005467 * @see #isCredentialProtectedStorage()
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005468 * @hide
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005469 */
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005470 @SystemApi
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005471 public abstract Context createCredentialProtectedStorageContext();
5472
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005473 /**
Craig Mautner48d0d182013-06-11 07:53:06 -07005474 * Gets the display adjustments holder for this context. This information
5475 * is provided on a per-application or activity basis and is used to simulate lower density
5476 * display metrics for legacy applications and restricted screen sizes.
Jeff Brown98365d72012-08-19 20:30:52 -07005477 *
Jeff Browna492c3a2012-08-23 19:48:44 -07005478 * @param displayId The display id for which to get compatibility info.
Jeff Brown98365d72012-08-19 20:30:52 -07005479 * @return The compatibility info holder, or null if not required by the application.
5480 * @hide
5481 */
Craig Mautner48d0d182013-06-11 07:53:06 -07005482 public abstract DisplayAdjustments getDisplayAdjustments(int displayId);
Jeff Brown98365d72012-08-19 20:30:52 -07005483
5484 /**
Wale Ogunwale691af682019-02-11 03:09:10 -08005485 * @return Returns the {@link Display} object this context is associated with.
Adam Lesinski4ece3d62016-06-16 18:05:41 -07005486 * @hide
5487 */
Wale Ogunwale691af682019-02-11 03:09:10 -08005488 @TestApi
Adam Lesinski4ece3d62016-06-16 18:05:41 -07005489 public abstract Display getDisplay();
5490
5491 /**
Yohei Yukawa5281b6b2018-10-15 07:38:25 +08005492 * Gets the display ID.
5493 *
5494 * @return display ID associated with this {@link Context}.
5495 * @hide
5496 */
wilsonshih5db7b392019-02-20 23:08:45 +08005497 @TestApi
Yohei Yukawa5281b6b2018-10-15 07:38:25 +08005498 public abstract int getDisplayId();
5499
5500 /**
Andrii Kulianb047b8b2017-02-08 18:38:26 -08005501 * @hide
5502 */
5503 public abstract void updateDisplay(int displayId);
5504
5505 /**
Romain Guy870e09f2009-07-06 16:35:25 -07005506 * Indicates whether this Context is restricted.
Scott Main4b5da682010-10-21 11:49:12 -07005507 *
John Spurlock6098c5d2013-06-17 10:32:46 -04005508 * @return {@code true} if this Context is restricted, {@code false} otherwise.
Scott Main4b5da682010-10-21 11:49:12 -07005509 *
Romain Guy870e09f2009-07-06 16:35:25 -07005510 * @see #CONTEXT_RESTRICTED
5511 */
5512 public boolean isRestricted() {
5513 return false;
5514 }
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005515
5516 /**
5517 * Indicates if the storage APIs of this Context are backed by
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005518 * device-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005519 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005520 * @see #createDeviceProtectedStorageContext()
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005521 */
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005522 public abstract boolean isDeviceProtectedStorage();
5523
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005524 /**
5525 * Indicates if the storage APIs of this Context are backed by
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005526 * credential-protected storage.
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005527 *
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005528 * @see #createCredentialProtectedStorageContext()
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005529 * @hide
Jeff Sharkey7a30a302015-12-08 14:20:06 -07005530 */
Jeff Sharkeye13529a2015-12-09 14:15:27 -07005531 @SystemApi
Jeff Sharkey8a372a02016-03-16 16:25:45 -06005532 public abstract boolean isCredentialProtectedStorage();
5533
Tony Mak46aabe52016-11-14 12:53:06 +00005534 /**
Seigo Nonaka6d6cd682017-06-22 08:22:18 -07005535 * Returns true if the context can load unsafe resources, e.g. fonts.
5536 * @hide
5537 */
5538 public abstract boolean canLoadUnsafeResources();
5539
5540 /**
Tony Mak46aabe52016-11-14 12:53:06 +00005541 * @hide
5542 */
5543 public IBinder getActivityToken() {
5544 throw new RuntimeException("Not implemented. Must override in a subclass.");
5545 }
5546
5547 /**
5548 * @hide
5549 */
5550 @Nullable
5551 public IServiceConnection getServiceDispatcher(ServiceConnection conn, Handler handler,
5552 int flags) {
5553 throw new RuntimeException("Not implemented. Must override in a subclass.");
5554 }
5555
5556 /**
5557 * @hide
5558 */
5559 public IApplicationThread getIApplicationThread() {
5560 throw new RuntimeException("Not implemented. Must override in a subclass.");
5561 }
Tony Makbf9928d2016-12-22 11:02:45 +00005562
5563 /**
5564 * @hide
5565 */
5566 public Handler getMainThreadHandler() {
5567 throw new RuntimeException("Not implemented. Must override in a subclass.");
5568 }
Adam Lesinskia82b6262017-03-21 16:56:17 -07005569
5570 /**
Felipe Lemebb567ae2017-10-04 09:56:21 -07005571 * @hide
5572 */
5573 public AutofillClient getAutofillClient() {
5574 return null;
5575 }
5576
5577 /**
5578 * @hide
5579 */
Svet Ganov47b37aa2018-02-16 00:11:39 -08005580 public void setAutofillClient(@SuppressWarnings("unused") AutofillClient client) {
Felipe Lemebb567ae2017-10-04 09:56:21 -07005581 }
5582
5583 /**
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005584 * @hide
5585 */
Felipe Lemecbf7f262019-04-17 13:57:59 -07005586 @Nullable
5587 public ContentCaptureClient getContentCaptureClient() {
5588 return null;
5589 }
5590
5591 /**
5592 * @hide
5593 */
Felipe Lemea4f39cd2019-02-19 15:08:59 -08005594 public final boolean isAutofillCompatibilityEnabled() {
5595 final AutofillOptions options = getAutofillOptions();
5596 return options != null && options.compatModeEnabled;
5597 }
5598
5599 /**
5600 * @hide
5601 */
5602 @Nullable
5603 public AutofillOptions getAutofillOptions() {
5604 return null;
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005605 }
5606
5607 /**
5608 * @hide
5609 */
Svet Ganov47b37aa2018-02-16 00:11:39 -08005610 @TestApi
Felipe Lemea4f39cd2019-02-19 15:08:59 -08005611 public void setAutofillOptions(@SuppressWarnings("unused") @Nullable AutofillOptions options) {
Svetoslav Ganov24c90452017-12-27 15:17:14 -08005612 }
5613
5614 /**
Felipe Leme326f15a2019-02-19 09:42:24 -08005615 * Gets the Content Capture options for this context, or {@code null} if it's not whitelisted.
Felipe Lemeecb08be2018-11-27 15:48:47 -08005616 *
5617 * @hide
5618 */
Felipe Leme326f15a2019-02-19 09:42:24 -08005619 @Nullable
5620 public ContentCaptureOptions getContentCaptureOptions() {
5621 return null;
Felipe Lemeecb08be2018-11-27 15:48:47 -08005622 }
5623
5624 /**
5625 * @hide
5626 */
Felipe Leme326f15a2019-02-19 09:42:24 -08005627 @TestApi
5628 public void setContentCaptureOptions(
5629 @SuppressWarnings("unused") @Nullable ContentCaptureOptions options) {
Felipe Lemeecb08be2018-11-27 15:48:47 -08005630 }
5631
5632 /**
Adam Lesinskia82b6262017-03-21 16:56:17 -07005633 * Throws an exception if the Context is using system resources,
5634 * which are non-runtime-overlay-themable and may show inconsistent UI.
5635 * @hide
5636 */
5637 public void assertRuntimeOverlayThemable() {
5638 // Resources.getSystem() is a singleton and the only Resources not managed by
5639 // ResourcesManager; therefore Resources.getSystem() is not themable.
5640 if (getResources() == Resources.getSystem()) {
5641 throw new IllegalArgumentException("Non-UI context used to display UI; "
5642 + "get a UI context from ActivityThread#getSystemUiContext()");
5643 }
5644 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005645}