blob: aa326adb498f43b3aa9bfdf1405e9f6f68b188d4 [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
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -070019import android.content.pm.ApplicationInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080020import android.content.pm.PackageManager;
21import android.content.res.AssetManager;
Dianne Hackborn756220b2012-08-14 16:45:30 -070022import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080023import android.content.res.Resources;
24import android.content.res.TypedArray;
Vasu Nori74f170f2010-06-01 18:06:18 -070025import android.database.DatabaseErrorHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.database.sqlite.SQLiteDatabase;
27import android.database.sqlite.SQLiteDatabase.CursorFactory;
28import android.graphics.Bitmap;
29import android.graphics.drawable.Drawable;
Adam Powellac695c62010-07-20 18:19:27 -070030import android.media.MediaScannerConnection.OnScanCompletedListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080031import android.net.Uri;
32import android.os.Bundle;
33import android.os.Handler;
34import android.os.Looper;
Dianne Hackborn79af1dd2012-08-16 16:42:52 -070035import android.os.UserHandle;
Jeff Sharkey8c165792012-10-22 14:08:29 -070036import android.os.UserManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.util.AttributeSet;
Craig Mautner48d0d182013-06-11 07:53:06 -070038import android.view.DisplayAdjustments;
Jeff Browna492c3a2012-08-23 19:48:44 -070039import android.view.Display;
40import android.view.WindowManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041
42import java.io.File;
43import java.io.FileInputStream;
44import java.io.FileNotFoundException;
45import java.io.FileOutputStream;
46import java.io.IOException;
47import java.io.InputStream;
48
49/**
50 * Interface to global information about an application environment. This is
51 * an abstract class whose implementation is provided by
52 * the Android system. It
53 * allows access to application-specific resources and classes, as well as
54 * up-calls for application-level operations such as launching activities,
55 * broadcasting and receiving intents, etc.
56 */
57public abstract class Context {
58 /**
59 * File creation mode: the default mode, where the created file can only
60 * be accessed by the calling application (or all applications sharing the
61 * same user ID).
62 * @see #MODE_WORLD_READABLE
63 * @see #MODE_WORLD_WRITEABLE
64 */
65 public static final int MODE_PRIVATE = 0x0000;
66 /**
Nick Kralevich15069212013-01-09 15:54:56 -080067 * @deprecated Creating world-readable files is very dangerous, and likely
68 * to cause security holes in applications. It is strongly discouraged;
69 * instead, applications should use more formal mechanism for interactions
70 * such as {@link ContentProvider}, {@link BroadcastReceiver}, and
71 * {@link android.app.Service}. There are no guarantees that this
72 * access mode will remain on a file, such as when it goes through a
73 * backup and restore.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074 * File creation mode: allow all other applications to have read access
75 * to the created file.
76 * @see #MODE_PRIVATE
77 * @see #MODE_WORLD_WRITEABLE
78 */
Dianne Hackborn556b09e2012-09-23 17:46:53 -070079 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080080 public static final int MODE_WORLD_READABLE = 0x0001;
81 /**
Nick Kralevich15069212013-01-09 15:54:56 -080082 * @deprecated Creating world-writable files is very dangerous, and likely
83 * to cause security holes in applications. It is strongly discouraged;
84 * instead, applications should use more formal mechanism for interactions
85 * such as {@link ContentProvider}, {@link BroadcastReceiver}, and
86 * {@link android.app.Service}. There are no guarantees that this
87 * access mode will remain on a file, such as when it goes through a
88 * backup and restore.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089 * File creation mode: allow all other applications to have write access
90 * to the created file.
91 * @see #MODE_PRIVATE
92 * @see #MODE_WORLD_READABLE
93 */
Dianne Hackborn556b09e2012-09-23 17:46:53 -070094 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080095 public static final int MODE_WORLD_WRITEABLE = 0x0002;
96 /**
97 * File creation mode: for use with {@link #openFileOutput}, if the file
98 * already exists then write data to the end of the existing file
99 * instead of erasing it.
100 * @see #openFileOutput
101 */
102 public static final int MODE_APPEND = 0x8000;
103
104 /**
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800105 * SharedPreference loading flag: when set, the file on disk will
106 * be checked for modification even if the shared preferences
107 * instance is already loaded in this process. This behavior is
108 * sometimes desired in cases where the application has multiple
109 * processes, all writing to the same SharedPreferences file.
110 * Generally there are better forms of communication between
111 * processes, though.
112 *
113 * <p>This was the legacy (but undocumented) behavior in and
114 * before Gingerbread (Android 2.3) and this flag is implied when
115 * targetting such releases. For applications targetting SDK
116 * versions <em>greater than</em> Android 2.3, this flag must be
117 * explicitly set if desired.
118 *
119 * @see #getSharedPreferences
120 */
121 public static final int MODE_MULTI_PROCESS = 0x0004;
122
123 /**
Jeff Brown47847f32012-03-22 19:13:11 -0700124 * Database open flag: when set, the database is opened with write-ahead
125 * logging enabled by default.
126 *
127 * @see #openOrCreateDatabase(String, int, CursorFactory)
128 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
129 * @see SQLiteDatabase#enableWriteAheadLogging
130 */
131 public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008;
132
133 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800134 * Flag for {@link #bindService}: automatically create the service as long
135 * as the binding exists. Note that while this will create the service,
Scott Main4b5da682010-10-21 11:49:12 -0700136 * its {@link android.app.Service#onStartCommand}
137 * method will still only be called due to an
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800138 * explicit call to {@link #startService}. Even without that, though,
139 * this still provides you with access to the service object while the
140 * service is created.
141 *
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700142 * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH},
143 * not supplying this flag would also impact how important the system
144 * consider's the target service's process to be. When set, the only way
145 * for it to be raised was by binding from a service in which case it will
146 * only be important when that activity is in the foreground. Now to
147 * achieve this behavior you must explicitly supply the new flag
148 * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications
149 * that don't specify {@link #BIND_AUTO_CREATE} will automatically have
150 * the flags {@link #BIND_WAIVE_PRIORITY} and
151 * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve
152 * the same result.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800153 */
154 public static final int BIND_AUTO_CREATE = 0x0001;
155
156 /**
157 * Flag for {@link #bindService}: include debugging help for mismatched
158 * calls to unbind. When this flag is set, the callstack of the following
159 * {@link #unbindService} call is retained, to be printed if a later
160 * incorrect unbind call is made. Note that doing this requires retaining
161 * information about the binding that was made for the lifetime of the app,
162 * resulting in a leak -- this should only be used for debugging.
163 */
164 public static final int BIND_DEBUG_UNBIND = 0x0002;
165
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800166 /**
167 * Flag for {@link #bindService}: don't allow this binding to raise
168 * the target service's process to the foreground scheduling priority.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700169 * It will still be raised to at least the same memory priority
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800170 * as the client (so that its process will not be killable in any
171 * situation where the client is not killable), but for CPU scheduling
172 * purposes it may be left in the background. This only has an impact
173 * in the situation where the binding client is a foreground process
174 * and the target service is in a background process.
175 */
176 public static final int BIND_NOT_FOREGROUND = 0x0004;
177
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700178 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700179 * Flag for {@link #bindService}: indicates that the client application
180 * binding to this service considers the service to be more important than
181 * the app itself. When set, the platform will try to have the out of
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700182 * memory killer kill the app before it kills the service it is bound to, though
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700183 * this is not guaranteed to be the case.
184 */
185 public static final int BIND_ABOVE_CLIENT = 0x0008;
186
187 /**
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700188 * Flag for {@link #bindService}: allow the process hosting the bound
189 * service to go through its normal memory management. It will be
190 * treated more like a running service, allowing the system to
191 * (temporarily) expunge the process if low on memory or for some other
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700192 * whim it may have, and being more aggressive about making it a candidate
193 * to be killed (and restarted) if running for a long time.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700194 */
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700195 public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010;
196
197 /**
198 * Flag for {@link #bindService}: don't impact the scheduling or
199 * memory management priority of the target service's hosting process.
200 * Allows the service's process to be managed on the background LRU list
201 * just like a regular application process in the background.
202 */
203 public static final int BIND_WAIVE_PRIORITY = 0x0020;
204
205 /**
206 * Flag for {@link #bindService}: this service is very important to
207 * the client, so should be brought to the foreground process level
208 * when the client is. Normally a process can only be raised to the
209 * visibility level by a client, even if that client is in the foreground.
210 */
211 public static final int BIND_IMPORTANT = 0x0040;
212
213 /**
214 * Flag for {@link #bindService}: If binding from an activity, allow the
215 * target service's process importance to be raised based on whether the
216 * activity is visible to the user, regardless whether another flag is
217 * used to reduce the amount that the client process's overall importance
218 * is used to impact it.
219 */
Dianne Hackborn2c84cfc2011-10-31 15:39:59 -0700220 public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080;
221
222 /**
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700223 * @hide An idea that is not yet implemented.
224 * Flag for {@link #bindService}: If binding from an activity, consider
225 * this service to be visible like the binding activity is. That is,
226 * it will be treated as something more important to keep around than
227 * invisible background activities. This will impact the number of
228 * recent activities the user can switch between without having them
229 * restart. There is no guarantee this will be respected, as the system
230 * tries to balance such requests from one app vs. the importantance of
231 * keeping other apps around.
232 */
Dianne Hackbornc8230512013-07-13 21:32:12 -0700233 public static final int BIND_VISIBLE = 0x10000000;
234
235 /**
236 * @hide
237 * Flag for {@link #bindService}: Consider this binding to be causing the target
238 * process to be showing UI, so it will be do a UI_HIDDEN memory trim when it goes
239 * away.
240 */
241 public static final int BIND_SHOWING_UI = 0x20000000;
Dianne Hackbornb12e1352012-09-26 11:39:20 -0700242
243 /**
Dianne Hackborn2c84cfc2011-10-31 15:39:59 -0700244 * Flag for {@link #bindService}: Don't consider the bound service to be
245 * visible, even if the caller is visible.
246 * @hide
247 */
248 public static final int BIND_NOT_VISIBLE = 0x40000000;
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700249
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800250 /** Return an AssetManager instance for your application's package. */
251 public abstract AssetManager getAssets();
252
253 /** Return a Resources instance for your application's package. */
254 public abstract Resources getResources();
255
256 /** Return PackageManager instance to find global package information. */
257 public abstract PackageManager getPackageManager();
258
259 /** Return a ContentResolver instance for your application's package. */
260 public abstract ContentResolver getContentResolver();
261
262 /**
263 * Return the Looper for the main thread of the current process. This is
264 * the thread used to dispatch calls to application components (activities,
265 * services, etc).
Jeff Brownf9e989d2013-04-04 23:04:03 -0700266 * <p>
267 * By definition, this method returns the same result as would be obtained
268 * by calling {@link Looper#getMainLooper() Looper.getMainLooper()}.
269 * </p>
270 *
271 * @return The main looper.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800272 */
273 public abstract Looper getMainLooper();
Scott Main4b5da682010-10-21 11:49:12 -0700274
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800275 /**
276 * Return the context of the single, global Application object of the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800277 * current process. This generally should only be used if you need a
278 * Context whose lifecycle is separate from the current context, that is
279 * tied to the lifetime of the process rather than the current component.
Scott Main4b5da682010-10-21 11:49:12 -0700280 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800281 * <p>Consider for example how this interacts with
Brad Fitzpatrick36af7942010-12-08 11:31:07 -0800282 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}:
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800283 * <ul>
284 * <li> <p>If used from an Activity context, the receiver is being registered
285 * within that activity. This means that you are expected to unregister
286 * before the activity is done being destroyed; in fact if you do not do
287 * so, the framework will clean up your leaked registration as it removes
288 * the activity and log an error. Thus, if you use the Activity context
289 * to register a receiver that is static (global to the process, not
290 * associated with an Activity instance) then that registration will be
291 * removed on you at whatever point the activity you used is destroyed.
292 * <li> <p>If used from the Context returned here, the receiver is being
293 * registered with the global state associated with your application. Thus
294 * it will never be unregistered for you. This is necessary if the receiver
295 * is associated with static data, not a particular component. However
296 * using the ApplicationContext elsewhere can easily lead to serious leaks
297 * if you forget to unregister, unbind, etc.
298 * </ul>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800299 */
300 public abstract Context getApplicationContext();
301
302 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700303 * Add a new {@link ComponentCallbacks} to the base application of the
304 * Context, which will be called at the same times as the ComponentCallbacks
305 * methods of activities and other components are called. Note that you
306 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when
307 * appropriate in the future; this will not be removed for you.
Dianne Hackborn905577f2011-09-07 18:31:28 -0700308 *
309 * @param callback The interface to call. This can be either a
310 * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface.
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700311 */
312 public void registerComponentCallbacks(ComponentCallbacks callback) {
313 getApplicationContext().registerComponentCallbacks(callback);
314 }
315
316 /**
John Spurlock6098c5d2013-06-17 10:32:46 -0400317 * Remove a {@link ComponentCallbacks} object that was previously registered
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700318 * with {@link #registerComponentCallbacks(ComponentCallbacks)}.
319 */
320 public void unregisterComponentCallbacks(ComponentCallbacks callback) {
321 getApplicationContext().unregisterComponentCallbacks(callback);
322 }
323
324 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800325 * Return a localized, styled CharSequence from the application's package's
326 * default string table.
327 *
328 * @param resId Resource id for the CharSequence text
329 */
330 public final CharSequence getText(int resId) {
331 return getResources().getText(resId);
332 }
333
334 /**
335 * Return a localized string from the application's package's
336 * default string table.
337 *
338 * @param resId Resource id for the string
339 */
340 public final String getString(int resId) {
341 return getResources().getString(resId);
342 }
343
344 /**
345 * Return a localized formatted string from the application's package's
346 * default string table, substituting the format arguments as defined in
347 * {@link java.util.Formatter} and {@link java.lang.String#format}.
348 *
349 * @param resId Resource id for the format string
350 * @param formatArgs The format arguments that will be used for substitution.
351 */
352
353 public final String getString(int resId, Object... formatArgs) {
354 return getResources().getString(resId, formatArgs);
355 }
356
357 /**
358 * Set the base theme for this context. Note that this should be called
359 * before any views are instantiated in the Context (for example before
360 * calling {@link android.app.Activity#setContentView} or
361 * {@link android.view.LayoutInflater#inflate}).
362 *
363 * @param resid The style resource describing the theme.
364 */
365 public abstract void setTheme(int resid);
366
Dianne Hackborn247fe742011-01-08 17:25:57 -0800367 /** @hide Needed for some internal implementation... not public because
368 * you can't assume this actually means anything. */
369 public int getThemeResId() {
370 return 0;
371 }
372
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800373 /**
374 * Return the Theme object associated with this Context.
375 */
376 public abstract Resources.Theme getTheme();
377
378 /**
379 * Retrieve styled attribute information in this Context's theme. See
380 * {@link Resources.Theme#obtainStyledAttributes(int[])}
381 * for more information.
382 *
383 * @see Resources.Theme#obtainStyledAttributes(int[])
384 */
385 public final TypedArray obtainStyledAttributes(
386 int[] attrs) {
387 return getTheme().obtainStyledAttributes(attrs);
388 }
389
390 /**
391 * Retrieve styled attribute information in this Context's theme. See
392 * {@link Resources.Theme#obtainStyledAttributes(int, int[])}
393 * for more information.
394 *
395 * @see Resources.Theme#obtainStyledAttributes(int, int[])
396 */
397 public final TypedArray obtainStyledAttributes(
398 int resid, int[] attrs) throws Resources.NotFoundException {
399 return getTheme().obtainStyledAttributes(resid, attrs);
400 }
401
402 /**
403 * Retrieve styled attribute information in this Context's theme. See
404 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
405 * for more information.
406 *
407 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
408 */
409 public final TypedArray obtainStyledAttributes(
410 AttributeSet set, int[] attrs) {
411 return getTheme().obtainStyledAttributes(set, attrs, 0, 0);
412 }
413
414 /**
415 * Retrieve styled attribute information in this Context's theme. See
416 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
417 * for more information.
418 *
419 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
420 */
421 public final TypedArray obtainStyledAttributes(
422 AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) {
423 return getTheme().obtainStyledAttributes(
424 set, attrs, defStyleAttr, defStyleRes);
425 }
426
427 /**
428 * Return a class loader you can use to retrieve classes in this package.
429 */
430 public abstract ClassLoader getClassLoader();
431
432 /** Return the name of this application's package. */
433 public abstract String getPackageName();
434
Dianne Hackbornd8e1dbb2013-01-17 17:47:37 -0800435 /** @hide Return the name of the base context this context is derived from. */
436 public abstract String getBasePackageName();
437
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -0700438 /** Return the full application info for this context's package. */
439 public abstract ApplicationInfo getApplicationInfo();
Scott Main4b5da682010-10-21 11:49:12 -0700440
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800441 /**
Kenny Root32148392010-01-21 15:40:47 -0800442 * Return the full path to this context's primary Android package.
443 * The Android package is a ZIP file which contains the application's
444 * primary resources.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800445 *
446 * <p>Note: this is not generally useful for applications, since they should
447 * not be directly accessing the file system.
448 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800449 * @return String Path to the resources.
450 */
451 public abstract String getPackageResourcePath();
452
453 /**
Kenny Root32148392010-01-21 15:40:47 -0800454 * Return the full path to this context's primary Android package.
455 * The Android package is a ZIP file which contains application's
456 * primary code and assets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800457 *
458 * <p>Note: this is not generally useful for applications, since they should
459 * not be directly accessing the file system.
460 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800461 * @return String Path to the code and assets.
462 */
463 public abstract String getPackageCodePath();
464
465 /**
Joe Onorato23ecae32009-06-10 17:07:15 -0700466 * {@hide}
467 * Return the full path to the shared prefs file for the given prefs group name.
468 *
469 * <p>Note: this is not generally useful for applications, since they should
470 * not be directly accessing the file system.
471 */
472 public abstract File getSharedPrefsFile(String name);
473
474 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800475 * Retrieve and hold the contents of the preferences file 'name', returning
476 * a SharedPreferences through which you can retrieve and modify its
477 * values. Only one instance of the SharedPreferences object is returned
478 * to any callers for the same name, meaning they will see each other's
479 * edits as soon as they are made.
480 *
481 * @param name Desired preferences file. If a preferences file by this name
482 * does not exist, it will be created when you retrieve an
483 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
484 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
485 * default operation, {@link #MODE_WORLD_READABLE}
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800486 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. The bit
487 * {@link #MODE_MULTI_PROCESS} can also be used if multiple processes
488 * are mutating the same SharedPreferences file. {@link #MODE_MULTI_PROCESS}
489 * is always on in apps targetting Gingerbread (Android 2.3) and below, and
490 * off by default in later versions.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800491 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400492 * @return The single {@link SharedPreferences} instance that can be used
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800493 * to retrieve and modify the preference values.
494 *
495 * @see #MODE_PRIVATE
496 * @see #MODE_WORLD_READABLE
497 * @see #MODE_WORLD_WRITEABLE
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800498 * @see #MODE_MULTI_PROCESS
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800499 */
500 public abstract SharedPreferences getSharedPreferences(String name,
501 int mode);
502
503 /**
504 * Open a private file associated with this Context's application package
505 * for reading.
506 *
507 * @param name The name of the file to open; can not contain path
508 * separators.
509 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400510 * @return The resulting {@link FileInputStream}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800511 *
512 * @see #openFileOutput
513 * @see #fileList
514 * @see #deleteFile
515 * @see java.io.FileInputStream#FileInputStream(String)
516 */
517 public abstract FileInputStream openFileInput(String name)
518 throws FileNotFoundException;
519
520 /**
Nick Kralevich15069212013-01-09 15:54:56 -0800521 * Open a private file associated with this Context's application package
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800522 * for writing. Creates the file if it doesn't already exist.
523 *
Nick Kralevich15069212013-01-09 15:54:56 -0800524 * @param name The name of the file to open; can not contain path
525 * separators.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800526 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
Nick Kralevich15069212013-01-09 15:54:56 -0800527 * default operation, {@link #MODE_APPEND} to append to an existing file,
528 * {@link #MODE_WORLD_READABLE} and {@link #MODE_WORLD_WRITEABLE} to control
529 * permissions.
530 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400531 * @return The resulting {@link FileOutputStream}.
Nick Kralevich15069212013-01-09 15:54:56 -0800532 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800533 * @see #MODE_APPEND
534 * @see #MODE_PRIVATE
535 * @see #MODE_WORLD_READABLE
536 * @see #MODE_WORLD_WRITEABLE
537 * @see #openFileInput
538 * @see #fileList
539 * @see #deleteFile
540 * @see java.io.FileOutputStream#FileOutputStream(String)
541 */
542 public abstract FileOutputStream openFileOutput(String name, int mode)
543 throws FileNotFoundException;
544
545 /**
546 * Delete the given private file associated with this Context's
547 * application package.
548 *
549 * @param name The name of the file to delete; can not contain path
550 * separators.
551 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400552 * @return {@code true} if the file was successfully deleted; else
553 * {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800554 *
555 * @see #openFileInput
556 * @see #openFileOutput
557 * @see #fileList
558 * @see java.io.File#delete()
559 */
560 public abstract boolean deleteFile(String name);
561
562 /**
563 * Returns the absolute path on the filesystem where a file created with
564 * {@link #openFileOutput} is stored.
565 *
566 * @param name The name of the file for which you would like to get
567 * its path.
568 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400569 * @return An absolute path to the given file.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800570 *
571 * @see #openFileOutput
572 * @see #getFilesDir
573 * @see #getDir
574 */
575 public abstract File getFileStreamPath(String name);
576
577 /**
578 * Returns the absolute path to the directory on the filesystem where
579 * files created with {@link #openFileOutput} are stored.
580 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400581 * @return The path of the directory holding application files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800582 *
583 * @see #openFileOutput
584 * @see #getFileStreamPath
585 * @see #getDir
586 */
587 public abstract File getFilesDir();
Scott Main4b5da682010-10-21 11:49:12 -0700588
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800589 /**
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800590 * Returns the absolute path to the directory on the external filesystem
591 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory()
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700592 * Environment.getExternalStorageDirectory()}) where the application can
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800593 * place persistent files it owns. These files are private to the
594 * applications, and not typically visible to the user as media.
Scott Main4b5da682010-10-21 11:49:12 -0700595 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800596 * <p>This is like {@link #getFilesDir()} in that these
597 * files will be deleted when the application is uninstalled, however there
598 * are some important differences:
Scott Main4b5da682010-10-21 11:49:12 -0700599 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800600 * <ul>
601 * <li>External files are not always available: they will disappear if the
602 * user mounts the external storage on a computer or removes it. See the
603 * APIs on {@link android.os.Environment} for information in the storage state.
604 * <li>There is no security enforced with these files. All applications
605 * can read and write files placed here.
606 * </ul>
Scott Main4b5da682010-10-21 11:49:12 -0700607 *
Jeff Sharkey8c165792012-10-22 14:08:29 -0700608 * <p>On devices with multiple users (as described by {@link UserManager}),
609 * each user has their own isolated external storage. Applications only
610 * have access to the external storage for the user they're running as.</p>
611 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800612 * <p>Here is an example of typical code to manipulate a file in
613 * an application's private storage:</p>
Scott Main4b5da682010-10-21 11:49:12 -0700614 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800615 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
616 * private_file}
617 *
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700618 * <p>If you supply a non-null <var>type</var> to this function, the returned
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800619 * file will be a path to a sub-directory of the given type. Though these files
620 * are not automatically scanned by the media scanner, you can explicitly
621 * add them to the media database with
622 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[],
Ray Chenb7c8c762010-03-30 17:21:39 -0700623 * OnScanCompletedListener) MediaScannerConnection.scanFile}.
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800624 * Note that this is not the same as
625 * {@link android.os.Environment#getExternalStoragePublicDirectory
626 * Environment.getExternalStoragePublicDirectory()}, which provides
627 * directories of media shared by all applications. The
628 * directories returned here are
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700629 * owned by the application, and their contents will be removed when the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800630 * application is uninstalled. Unlike
631 * {@link android.os.Environment#getExternalStoragePublicDirectory
632 * Environment.getExternalStoragePublicDirectory()}, the directory
633 * returned here will be automatically created for you.
Scott Main4b5da682010-10-21 11:49:12 -0700634 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800635 * <p>Here is an example of typical code to manipulate a picture in
636 * an application's private storage and add it to the media database:</p>
Scott Main4b5da682010-10-21 11:49:12 -0700637 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800638 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
639 * private_picture}
Scott Main4b5da682010-10-21 11:49:12 -0700640 *
Jeff Sharkey8c165792012-10-22 14:08:29 -0700641 * <p>Writing to this path requires the
642 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission.</p>
643 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800644 * @param type The type of files directory to return. May be null for
645 * the root of the files directory or one of
646 * the following Environment constants for a subdirectory:
647 * {@link android.os.Environment#DIRECTORY_MUSIC},
648 * {@link android.os.Environment#DIRECTORY_PODCASTS},
649 * {@link android.os.Environment#DIRECTORY_RINGTONES},
650 * {@link android.os.Environment#DIRECTORY_ALARMS},
651 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
652 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
653 * {@link android.os.Environment#DIRECTORY_MOVIES}.
Scott Main4b5da682010-10-21 11:49:12 -0700654 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400655 * @return The path of the directory holding application files
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800656 * on external storage. Returns null if external storage is not currently
657 * mounted so it could not ensure the path exists; you will need to call
658 * this method again when it is available.
659 *
660 * @see #getFilesDir
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700661 * @see android.os.Environment#getExternalStoragePublicDirectory
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800662 */
663 public abstract File getExternalFilesDir(String type);
Scott Main4b5da682010-10-21 11:49:12 -0700664
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800665 /**
Dianne Hackborn805fd7e2011-01-16 18:30:29 -0800666 * Return the directory where this application's OBB files (if there
667 * are any) can be found. Note if the application does not have any OBB
668 * files, this directory may not exist.
Jeff Sharkey8c165792012-10-22 14:08:29 -0700669 *
670 * <p>On devices with multiple users (as described by {@link UserManager}),
671 * multiple users may share the same OBB storage location. Applications
672 * should ensure that multiple instances running under different users
673 * don't interfere with each other.</p>
Dianne Hackborn805fd7e2011-01-16 18:30:29 -0800674 */
675 public abstract File getObbDir();
676
677 /**
Scott Main4b5da682010-10-21 11:49:12 -0700678 * Returns the absolute path to the application specific cache directory
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800679 * on the filesystem. These files will be ones that get deleted first when the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800680 * device runs low on storage.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800681 * There is no guarantee when these files will be deleted.
Scott Main4b5da682010-10-21 11:49:12 -0700682 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800683 * <strong>Note: you should not <em>rely</em> on the system deleting these
684 * files for you; you should always have a reasonable maximum, such as 1 MB,
685 * for the amount of space you consume with cache files, and prune those
686 * files when exceeding that space.</strong>
Scott Main4b5da682010-10-21 11:49:12 -0700687 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400688 * @return The path of the directory holding application cache files.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800689 *
690 * @see #openFileOutput
691 * @see #getFileStreamPath
692 * @see #getDir
693 */
694 public abstract File getCacheDir();
695
696 /**
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800697 * Returns the absolute path to the directory on the external filesystem
698 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory()
699 * Environment.getExternalStorageDirectory()} where the application can
700 * place cache files it owns.
Scott Main4b5da682010-10-21 11:49:12 -0700701 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800702 * <p>This is like {@link #getCacheDir()} in that these
703 * files will be deleted when the application is uninstalled, however there
704 * are some important differences:
Scott Main4b5da682010-10-21 11:49:12 -0700705 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800706 * <ul>
Dianne Hackborn556b09e2012-09-23 17:46:53 -0700707 * <li>The platform does not always monitor the space available in external
708 * storage, and thus may not automatically delete these files. Currently
709 * the only time files here will be deleted by the platform is when running
710 * on {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and
711 * {@link android.os.Environment#isExternalStorageEmulated()
712 * Environment.isExternalStorageEmulated()} returns true. Note that you should
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800713 * be managing the maximum space you will use for these anyway, just like
714 * with {@link #getCacheDir()}.
715 * <li>External files are not always available: they will disappear if the
716 * user mounts the external storage on a computer or removes it. See the
717 * APIs on {@link android.os.Environment} for information in the storage state.
718 * <li>There is no security enforced with these files. All applications
719 * can read and write files placed here.
720 * </ul>
721 *
Jeff Sharkey8c165792012-10-22 14:08:29 -0700722 * <p>On devices with multiple users (as described by {@link UserManager}),
723 * each user has their own isolated external storage. Applications only
724 * have access to the external storage for the user they're running as.</p>
725 *
726 * <p>Writing to this path requires the
727 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} permission.</p>
728 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400729 * @return The path of the directory holding application cache files
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800730 * on external storage. Returns null if external storage is not currently
731 * mounted so it could not ensure the path exists; you will need to call
732 * this method again when it is available.
733 *
734 * @see #getCacheDir
735 */
736 public abstract File getExternalCacheDir();
Scott Main4b5da682010-10-21 11:49:12 -0700737
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800738 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800739 * Returns an array of strings naming the private files associated with
740 * this Context's application package.
741 *
742 * @return Array of strings naming the private files.
743 *
744 * @see #openFileInput
745 * @see #openFileOutput
746 * @see #deleteFile
747 */
748 public abstract String[] fileList();
749
750 /**
751 * Retrieve, creating if needed, a new directory in which the application
752 * can place its own custom data files. You can use the returned File
753 * object to create and access files in this directory. Note that files
754 * created through a File object will only be accessible by your own
755 * application; you can only set the mode of the entire directory, not
756 * of individual files.
757 *
Nick Kralevich92091fa2012-12-12 16:24:31 -0800758 * @param name Name of the directory to retrieve. This is a directory
Nick Kralevich15069212013-01-09 15:54:56 -0800759 * that is created as part of your application data.
Nick Kralevich92091fa2012-12-12 16:24:31 -0800760 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
Nick Kralevich15069212013-01-09 15:54:56 -0800761 * default operation, {@link #MODE_WORLD_READABLE} and
762 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
763 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400764 * @return A {@link File} object for the requested directory. The directory
Nick Kralevich15069212013-01-09 15:54:56 -0800765 * will have been created if it does not already exist.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800766 *
767 * @see #openFileOutput(String, int)
768 */
769 public abstract File getDir(String name, int mode);
770
771 /**
772 * Open a new private SQLiteDatabase associated with this Context's
773 * application package. Create the database file if it doesn't exist.
774 *
775 * @param name The name (unique in the application package) of the database.
776 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
777 * default operation, {@link #MODE_WORLD_READABLE}
778 * and {@link #MODE_WORLD_WRITEABLE} to control permissions.
Jeff Brown47847f32012-03-22 19:13:11 -0700779 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800780 * @param factory An optional factory class that is called to instantiate a
781 * cursor when query is called.
Nick Kralevich15069212013-01-09 15:54:56 -0800782 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800783 * @return The contents of a newly created database with the given name.
784 * @throws android.database.sqlite.SQLiteException if the database file could not be opened.
Nick Kralevich15069212013-01-09 15:54:56 -0800785 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800786 * @see #MODE_PRIVATE
787 * @see #MODE_WORLD_READABLE
788 * @see #MODE_WORLD_WRITEABLE
Jeff Brown47847f32012-03-22 19:13:11 -0700789 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800790 * @see #deleteDatabase
791 */
792 public abstract SQLiteDatabase openOrCreateDatabase(String name,
793 int mode, CursorFactory factory);
794
795 /**
Vasu Nori74f170f2010-06-01 18:06:18 -0700796 * Open a new private SQLiteDatabase associated with this Context's
797 * application package. Creates the database file if it doesn't exist.
798 *
799 * <p>Accepts input param: a concrete instance of {@link DatabaseErrorHandler} to be
800 * used to handle corruption when sqlite reports database corruption.</p>
801 *
802 * @param name The name (unique in the application package) of the database.
803 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
804 * default operation, {@link #MODE_WORLD_READABLE}
805 * and {@link #MODE_WORLD_WRITEABLE} to control permissions.
Jeff Brown47847f32012-03-22 19:13:11 -0700806 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default.
Vasu Nori74f170f2010-06-01 18:06:18 -0700807 * @param factory An optional factory class that is called to instantiate a
808 * cursor when query is called.
809 * @param errorHandler the {@link DatabaseErrorHandler} to be used when sqlite reports database
Nick Kralevich15069212013-01-09 15:54:56 -0800810 * corruption. if null, {@link android.database.DefaultDatabaseErrorHandler} is assumed.
Vasu Nori74f170f2010-06-01 18:06:18 -0700811 * @return The contents of a newly created database with the given name.
812 * @throws android.database.sqlite.SQLiteException if the database file could not be opened.
Nick Kralevich15069212013-01-09 15:54:56 -0800813 *
Vasu Nori74f170f2010-06-01 18:06:18 -0700814 * @see #MODE_PRIVATE
815 * @see #MODE_WORLD_READABLE
816 * @see #MODE_WORLD_WRITEABLE
Jeff Brown47847f32012-03-22 19:13:11 -0700817 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Vasu Nori74f170f2010-06-01 18:06:18 -0700818 * @see #deleteDatabase
819 */
820 public abstract SQLiteDatabase openOrCreateDatabase(String name,
821 int mode, CursorFactory factory, DatabaseErrorHandler errorHandler);
822
823 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800824 * Delete an existing private SQLiteDatabase associated with this Context's
825 * application package.
826 *
827 * @param name The name (unique in the application package) of the
828 * database.
829 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400830 * @return {@code true} if the database was successfully deleted; else {@code false}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800831 *
832 * @see #openOrCreateDatabase
833 */
834 public abstract boolean deleteDatabase(String name);
835
836 /**
837 * Returns the absolute path on the filesystem where a database created with
838 * {@link #openOrCreateDatabase} is stored.
839 *
840 * @param name The name of the database for which you would like to get
841 * its path.
842 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400843 * @return An absolute path to the given database.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800844 *
845 * @see #openOrCreateDatabase
846 */
847 public abstract File getDatabasePath(String name);
848
849 /**
850 * Returns an array of strings naming the private databases associated with
851 * this Context's application package.
852 *
853 * @return Array of strings naming the private databases.
854 *
855 * @see #openOrCreateDatabase
856 * @see #deleteDatabase
857 */
858 public abstract String[] databaseList();
859
860 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700861 * @deprecated Use {@link android.app.WallpaperManager#getDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700862 * WallpaperManager.get()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800863 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700864 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800865 public abstract Drawable getWallpaper();
866
867 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700868 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700869 * WallpaperManager.peek()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800870 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700871 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800872 public abstract Drawable peekWallpaper();
873
874 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700875 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth()
876 * WallpaperManager.getDesiredMinimumWidth()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800877 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700878 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800879 public abstract int getWallpaperDesiredMinimumWidth();
880
881 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700882 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight()
883 * WallpaperManager.getDesiredMinimumHeight()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800884 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700885 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800886 public abstract int getWallpaperDesiredMinimumHeight();
887
888 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700889 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700890 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700891 * <p>This method requires the caller to hold the permission
892 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800893 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700894 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800895 public abstract void setWallpaper(Bitmap bitmap) throws IOException;
896
897 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700898 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700899 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700900 * <p>This method requires the caller to hold the permission
901 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800902 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700903 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800904 public abstract void setWallpaper(InputStream data) throws IOException;
905
906 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700907 * @deprecated Use {@link android.app.WallpaperManager#clear
908 * WallpaperManager.clear()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700909 * <p>This method requires the caller to hold the permission
910 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800911 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700912 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800913 public abstract void clearWallpaper() throws IOException;
914
915 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -0700916 * Same as {@link #startActivity(Intent, Bundle)} with no options
917 * specified.
918 *
919 * @param intent The description of the activity to start.
920 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400921 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborna4972e92012-03-14 10:38:05 -0700922 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400923 * @see #startActivity(Intent, Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -0700924 * @see PackageManager#resolveActivity
925 */
926 public abstract void startActivity(Intent intent);
927
928 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -0700929 * Version of {@link #startActivity(Intent)} that allows you to specify the
930 * user the activity will be started for. This is not available to applications
931 * that are not pre-installed on the system image. Using it requires holding
932 * the INTERACT_ACROSS_USERS_FULL permission.
Amith Yamasani82644082012-08-03 13:09:11 -0700933 * @param intent The description of the activity to start.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -0700934 * @param user The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -0400935 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani82644082012-08-03 13:09:11 -0700936 * @hide
937 */
Dianne Hackborn79af1dd2012-08-16 16:42:52 -0700938 public void startActivityAsUser(Intent intent, UserHandle user) {
Amith Yamasani82644082012-08-03 13:09:11 -0700939 throw new RuntimeException("Not implemented. Must override in a subclass.");
940 }
941
942 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800943 * Launch a new activity. You will not receive any information about when
944 * the activity exits.
945 *
946 * <p>Note that if this method is being called from outside of an
947 * {@link android.app.Activity} Context, then the Intent must include
948 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because,
949 * without being started from an existing Activity, there is no existing
950 * task in which to place the new activity and thus it needs to be placed
951 * in its own separate task.
952 *
953 * <p>This method throws {@link ActivityNotFoundException}
954 * if there was no Activity found to run the given Intent.
955 *
956 * @param intent The description of the activity to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -0700957 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -0700958 * May be null if there are no options. See {@link android.app.ActivityOptions}
959 * for how to build the Bundle supplied here; there are no supported definitions
960 * for building it manually.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800961 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400962 * @throws ActivityNotFoundException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800963 *
Scott Main60dd5202012-06-23 00:01:22 -0700964 * @see #startActivity(Intent)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800965 * @see PackageManager#resolveActivity
966 */
Dianne Hackborna4972e92012-03-14 10:38:05 -0700967 public abstract void startActivity(Intent intent, Bundle options);
968
969 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -0700970 * Version of {@link #startActivity(Intent, Bundle)} that allows you to specify the
971 * user the activity will be started for. This is not available to applications
972 * that are not pre-installed on the system image. Using it requires holding
973 * the INTERACT_ACROSS_USERS_FULL permission.
Amith Yamasani258848d2012-08-10 17:06:33 -0700974 * @param intent The description of the activity to start.
975 * @param options Additional options for how the Activity should be started.
976 * May be null if there are no options. See {@link android.app.ActivityOptions}
977 * for how to build the Bundle supplied here; there are no supported definitions
978 * for building it manually.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -0700979 * @param user The UserHandle of the user to start this activity for.
John Spurlock6098c5d2013-06-17 10:32:46 -0400980 * @throws ActivityNotFoundException &nbsp;
Amith Yamasani258848d2012-08-10 17:06:33 -0700981 * @hide
982 */
Dianne Hackborn79af1dd2012-08-16 16:42:52 -0700983 public void startActivityAsUser(Intent intent, Bundle options, UserHandle userId) {
Amith Yamasani258848d2012-08-10 17:06:33 -0700984 throw new RuntimeException("Not implemented. Must override in a subclass.");
985 }
986
987 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -0700988 * Same as {@link #startActivities(Intent[], Bundle)} with no options
989 * specified.
990 *
991 * @param intents An array of Intents to be started.
992 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400993 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborna4972e92012-03-14 10:38:05 -0700994 *
John Spurlock6098c5d2013-06-17 10:32:46 -0400995 * @see #startActivities(Intent[], Bundle)
Dianne Hackborna4972e92012-03-14 10:38:05 -0700996 * @see PackageManager#resolveActivity
997 */
998 public abstract void startActivities(Intent[] intents);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800999
1000 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001001 * Launch multiple new activities. This is generally the same as calling
1002 * {@link #startActivity(Intent)} for the first Intent in the array,
1003 * that activity during its creation calling {@link #startActivity(Intent)}
1004 * for the second entry, etc. Note that unlike that approach, generally
1005 * none of the activities except the last in the array will be created
1006 * at this point, but rather will be created when the user first visits
1007 * them (due to pressing back from the activity on top).
1008 *
1009 * <p>This method throws {@link ActivityNotFoundException}
1010 * if there was no Activity found for <em>any</em> given Intent. In this
1011 * case the state of the activity stack is undefined (some Intents in the
1012 * list may be on it, some not), so you probably want to avoid such situations.
1013 *
1014 * @param intents An array of Intents to be started.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001015 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001016 * See {@link android.content.Context#startActivity(Intent, Bundle)
1017 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001018 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001019 * @throws ActivityNotFoundException &nbsp;
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001020 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001021 * @see #startActivities(Intent[])
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001022 * @see PackageManager#resolveActivity
1023 */
Dianne Hackborna4972e92012-03-14 10:38:05 -07001024 public abstract void startActivities(Intent[] intents, Bundle options);
Dianne Hackborn621e17d2010-11-22 15:59:56 -08001025
1026 /**
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001027 * @hide
1028 * Launch multiple new activities. This is generally the same as calling
1029 * {@link #startActivity(Intent)} for the first Intent in the array,
1030 * that activity during its creation calling {@link #startActivity(Intent)}
1031 * for the second entry, etc. Note that unlike that approach, generally
1032 * none of the activities except the last in the array will be created
1033 * at this point, but rather will be created when the user first visits
1034 * them (due to pressing back from the activity on top).
1035 *
1036 * <p>This method throws {@link ActivityNotFoundException}
1037 * if there was no Activity found for <em>any</em> given Intent. In this
1038 * case the state of the activity stack is undefined (some Intents in the
1039 * list may be on it, some not), so you probably want to avoid such situations.
1040 *
1041 * @param intents An array of Intents to be started.
1042 * @param options Additional options for how the Activity should be started.
1043 * @param userHandle The user for whom to launch the activities
1044 * See {@link android.content.Context#startActivity(Intent, Bundle)
1045 * Context.startActivity(Intent, Bundle)} for more details.
1046 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001047 * @throws ActivityNotFoundException &nbsp;
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001048 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001049 * @see #startActivities(Intent[])
Amith Yamasaniea7e9152012-09-24 16:11:18 -07001050 * @see PackageManager#resolveActivity
1051 */
1052 public void startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle) {
1053 throw new RuntimeException("Not implemented. Must override in a subclass.");
1054 }
1055
1056 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07001057 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)}
1058 * with no options specified.
1059 *
1060 * @param intent The IntentSender to launch.
1061 * @param fillInIntent If non-null, this will be provided as the
1062 * intent parameter to {@link IntentSender#sendIntent}.
1063 * @param flagsMask Intent flags in the original IntentSender that you
1064 * would like to change.
1065 * @param flagsValues Desired values for any bits set in
1066 * <var>flagsMask</var>
1067 * @param extraFlags Always set to 0.
1068 *
1069 * @see #startActivity(Intent)
1070 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle)
1071 */
1072 public abstract void startIntentSender(IntentSender intent,
1073 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
1074 throws IntentSender.SendIntentException;
1075
1076 /**
1077 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001078 * to start. If the IntentSender is for an activity, that activity will be started
Dianne Hackbornae22c052009-09-17 18:46:22 -07001079 * as if you had called the regular {@link #startActivity(Intent)}
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001080 * here; otherwise, its associated action will be executed (such as
1081 * sending a broadcast) as if you had called
1082 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Scott Main4b5da682010-10-21 11:49:12 -07001083 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001084 * @param intent The IntentSender to launch.
1085 * @param fillInIntent If non-null, this will be provided as the
1086 * intent parameter to {@link IntentSender#sendIntent}.
1087 * @param flagsMask Intent flags in the original IntentSender that you
1088 * would like to change.
1089 * @param flagsValues Desired values for any bits set in
1090 * <var>flagsMask</var>
1091 * @param extraFlags Always set to 0.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001092 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07001093 * See {@link android.content.Context#startActivity(Intent, Bundle)
1094 * Context.startActivity(Intent, Bundle)} for more details. If options
1095 * have also been supplied by the IntentSender, options given here will
1096 * override any that conflict with those given by the IntentSender.
Dianne Hackborna4972e92012-03-14 10:38:05 -07001097 *
1098 * @see #startActivity(Intent, Bundle)
1099 * @see #startIntentSender(IntentSender, Intent, int, int, int)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001100 */
1101 public abstract void startIntentSender(IntentSender intent,
Dianne Hackborna4972e92012-03-14 10:38:05 -07001102 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags,
1103 Bundle options) throws IntentSender.SendIntentException;
Dianne Hackbornfa82f222009-09-17 15:14:12 -07001104
1105 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001106 * Broadcast the given intent to all interested BroadcastReceivers. This
1107 * call is asynchronous; it returns immediately, and you will continue
1108 * executing while the receivers are run. No results are propagated from
1109 * receivers and receivers can not abort the broadcast. If you want
1110 * to allow receivers to propagate results or abort the broadcast, you must
1111 * send an ordered broadcast using
1112 * {@link #sendOrderedBroadcast(Intent, String)}.
1113 *
1114 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1115 *
1116 * @param intent The Intent to broadcast; all receivers matching this
1117 * Intent will receive the broadcast.
1118 *
1119 * @see android.content.BroadcastReceiver
1120 * @see #registerReceiver
1121 * @see #sendBroadcast(Intent, String)
1122 * @see #sendOrderedBroadcast(Intent, String)
1123 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1124 */
1125 public abstract void sendBroadcast(Intent intent);
1126
1127 /**
1128 * Broadcast the given intent to all interested BroadcastReceivers, allowing
1129 * an optional required permission to be enforced. This
1130 * call is asynchronous; it returns immediately, and you will continue
1131 * executing while the receivers are run. No results are propagated from
1132 * receivers and receivers can not abort the broadcast. If you want
1133 * to allow receivers to propagate results or abort the broadcast, you must
1134 * send an ordered broadcast using
1135 * {@link #sendOrderedBroadcast(Intent, String)}.
1136 *
1137 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1138 *
1139 * @param intent The Intent to broadcast; all receivers matching this
1140 * Intent will receive the broadcast.
Brad Fitzpatrick26b71be2010-12-07 14:52:58 -08001141 * @param receiverPermission (optional) String naming a permission that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001142 * a receiver must hold in order to receive your broadcast.
1143 * If null, no permission is required.
1144 *
1145 * @see android.content.BroadcastReceiver
1146 * @see #registerReceiver
1147 * @see #sendBroadcast(Intent)
1148 * @see #sendOrderedBroadcast(Intent, String)
1149 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1150 */
1151 public abstract void sendBroadcast(Intent intent,
1152 String receiverPermission);
1153
1154 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08001155 * Like {@link #sendBroadcast(Intent, String)}, but also allows specification
1156 * of an assocated app op as per {@link android.app.AppOpsManager}.
1157 * @hide
1158 */
1159 public abstract void sendBroadcast(Intent intent,
1160 String receiverPermission, int appOp);
1161
1162 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001163 * Broadcast the given intent to all interested BroadcastReceivers, delivering
1164 * them one at a time to allow more preferred receivers to consume the
1165 * broadcast before it is delivered to less preferred receivers. This
1166 * call is asynchronous; it returns immediately, and you will continue
1167 * executing while the receivers are run.
1168 *
1169 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1170 *
1171 * @param intent The Intent to broadcast; all receivers matching this
1172 * Intent will receive the broadcast.
1173 * @param receiverPermission (optional) String naming a permissions that
1174 * a receiver must hold in order to receive your broadcast.
1175 * If null, no permission is required.
1176 *
1177 * @see android.content.BroadcastReceiver
1178 * @see #registerReceiver
1179 * @see #sendBroadcast(Intent)
1180 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1181 */
1182 public abstract void sendOrderedBroadcast(Intent intent,
1183 String receiverPermission);
1184
1185 /**
1186 * Version of {@link #sendBroadcast(Intent)} that allows you to
1187 * receive data back from the broadcast. This is accomplished by
1188 * supplying your own BroadcastReceiver when calling, which will be
1189 * treated as a final receiver at the end of the broadcast -- its
1190 * {@link BroadcastReceiver#onReceive} method will be called with
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001191 * the result values collected from the other receivers. The broadcast will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001192 * be serialized in the same way as calling
1193 * {@link #sendOrderedBroadcast(Intent, String)}.
1194 *
1195 * <p>Like {@link #sendBroadcast(Intent)}, this method is
1196 * asynchronous; it will return before
1197 * resultReceiver.onReceive() is called.
1198 *
1199 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1200 *
1201 * @param intent The Intent to broadcast; all receivers matching this
1202 * Intent will receive the broadcast.
1203 * @param receiverPermission String naming a permissions that
1204 * a receiver must hold in order to receive your broadcast.
1205 * If null, no permission is required.
1206 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1207 * receiver of the broadcast.
1208 * @param scheduler A custom Handler with which to schedule the
1209 * resultReceiver callback; if null it will be
1210 * scheduled in the Context's main thread.
1211 * @param initialCode An initial value for the result code. Often
1212 * Activity.RESULT_OK.
1213 * @param initialData An initial value for the result data. Often
1214 * null.
1215 * @param initialExtras An initial value for the result extras. Often
1216 * null.
1217 *
1218 * @see #sendBroadcast(Intent)
1219 * @see #sendBroadcast(Intent, String)
1220 * @see #sendOrderedBroadcast(Intent, String)
1221 * @see #sendStickyBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001222 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001223 * @see android.content.BroadcastReceiver
1224 * @see #registerReceiver
1225 * @see android.app.Activity#RESULT_OK
1226 */
1227 public abstract void sendOrderedBroadcast(Intent intent,
1228 String receiverPermission, BroadcastReceiver resultReceiver,
1229 Handler scheduler, int initialCode, String initialData,
1230 Bundle initialExtras);
1231
1232 /**
Dianne Hackbornf51f6122013-02-04 18:23:34 -08001233 * Like {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler,
1234 * int, String, android.os.Bundle)}, but also allows specification
1235 * of an assocated app op as per {@link android.app.AppOpsManager}.
1236 * @hide
1237 */
1238 public abstract void sendOrderedBroadcast(Intent intent,
1239 String receiverPermission, int appOp, BroadcastReceiver resultReceiver,
1240 Handler scheduler, int initialCode, String initialData,
1241 Bundle initialExtras);
1242
1243 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001244 * Version of {@link #sendBroadcast(Intent)} that allows you to specify the
1245 * user the broadcast will be sent to. This is not available to applications
1246 * that are not pre-installed on the system image. Using it requires holding
1247 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001248 * @param intent The intent to broadcast
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001249 * @param user UserHandle to send the intent to.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001250 * @see #sendBroadcast(Intent)
1251 */
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001252 public abstract void sendBroadcastAsUser(Intent intent, UserHandle user);
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001253
1254 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001255 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the
1256 * user the broadcast will be sent to. This is not available to applications
1257 * that are not pre-installed on the system image. Using it requires holding
1258 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001259 *
1260 * @param intent The Intent to broadcast; all receivers matching this
1261 * Intent will receive the broadcast.
1262 * @param user UserHandle to send the intent to.
1263 * @param receiverPermission (optional) String naming a permission that
1264 * a receiver must hold in order to receive your broadcast.
1265 * If null, no permission is required.
1266 *
1267 * @see #sendBroadcast(Intent, String)
1268 */
1269 public abstract void sendBroadcastAsUser(Intent intent, UserHandle user,
1270 String receiverPermission);
1271
1272 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001273 * Version of
1274 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)}
1275 * that allows you to specify the
1276 * user the broadcast will be sent to. This is not available to applications
1277 * that are not pre-installed on the system image. Using it requires holding
1278 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001279 *
1280 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1281 *
1282 * @param intent The Intent to broadcast; all receivers matching this
1283 * Intent will receive the broadcast.
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001284 * @param user UserHandle to send the intent to.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001285 * @param receiverPermission String naming a permissions that
1286 * a receiver must hold in order to receive your broadcast.
1287 * If null, no permission is required.
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001288 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1289 * receiver of the broadcast.
1290 * @param scheduler A custom Handler with which to schedule the
1291 * resultReceiver callback; if null it will be
1292 * scheduled in the Context's main thread.
1293 * @param initialCode An initial value for the result code. Often
1294 * Activity.RESULT_OK.
1295 * @param initialData An initial value for the result data. Often
1296 * null.
1297 * @param initialExtras An initial value for the result extras. Often
1298 * null.
1299 *
1300 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1301 */
Dianne Hackborn79af1dd2012-08-16 16:42:52 -07001302 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user,
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001303 String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler,
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001304 int initialCode, String initialData, Bundle initialExtras);
1305
1306 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001307 * Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the
1308 * Intent you are sending stays around after the broadcast is complete,
1309 * so that others can quickly retrieve that data through the return
1310 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In
1311 * all other ways, this behaves the same as
1312 * {@link #sendBroadcast(Intent)}.
1313 *
1314 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
1315 * permission in order to use this API. If you do not hold that
1316 * permission, {@link SecurityException} will be thrown.
1317 *
1318 * @param intent The Intent to broadcast; all receivers matching this
1319 * Intent will receive the broadcast, and the Intent will be held to
1320 * be re-broadcast to future receivers.
1321 *
1322 * @see #sendBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001323 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001324 */
1325 public abstract void sendStickyBroadcast(Intent intent);
Scott Main4b5da682010-10-21 11:49:12 -07001326
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001327 /**
1328 * Version of {@link #sendStickyBroadcast} that allows you to
1329 * receive data back from the broadcast. This is accomplished by
1330 * supplying your own BroadcastReceiver when calling, which will be
1331 * treated as a final receiver at the end of the broadcast -- its
1332 * {@link BroadcastReceiver#onReceive} method will be called with
1333 * the result values collected from the other receivers. The broadcast will
1334 * be serialized in the same way as calling
1335 * {@link #sendOrderedBroadcast(Intent, String)}.
1336 *
1337 * <p>Like {@link #sendBroadcast(Intent)}, this method is
1338 * asynchronous; it will return before
1339 * resultReceiver.onReceive() is called. Note that the sticky data
1340 * stored is only the data you initially supply to the broadcast, not
1341 * the result of any changes made by the receivers.
1342 *
1343 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1344 *
1345 * @param intent The Intent to broadcast; all receivers matching this
1346 * Intent will receive the broadcast.
1347 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1348 * receiver of the broadcast.
1349 * @param scheduler A custom Handler with which to schedule the
1350 * resultReceiver callback; if null it will be
1351 * scheduled in the Context's main thread.
1352 * @param initialCode An initial value for the result code. Often
1353 * Activity.RESULT_OK.
1354 * @param initialData An initial value for the result data. Often
1355 * null.
1356 * @param initialExtras An initial value for the result extras. Often
1357 * null.
1358 *
1359 * @see #sendBroadcast(Intent)
1360 * @see #sendBroadcast(Intent, String)
1361 * @see #sendOrderedBroadcast(Intent, String)
1362 * @see #sendStickyBroadcast(Intent)
1363 * @see android.content.BroadcastReceiver
1364 * @see #registerReceiver
1365 * @see android.app.Activity#RESULT_OK
1366 */
1367 public abstract void sendStickyOrderedBroadcast(Intent intent,
1368 BroadcastReceiver resultReceiver,
1369 Handler scheduler, int initialCode, String initialData,
1370 Bundle initialExtras);
1371
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001372 /**
1373 * Remove the data previously sent with {@link #sendStickyBroadcast},
1374 * so that it is as if the sticky broadcast had never happened.
1375 *
1376 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
1377 * permission in order to use this API. If you do not hold that
1378 * permission, {@link SecurityException} will be thrown.
1379 *
1380 * @param intent The Intent that was previously broadcast.
1381 *
1382 * @see #sendStickyBroadcast
1383 */
1384 public abstract void removeStickyBroadcast(Intent intent);
1385
1386 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001387 * Version of {@link #sendStickyBroadcast(Intent)} that allows you to specify the
1388 * user the broadcast will be sent to. This is not available to applications
1389 * that are not pre-installed on the system image. Using it requires holding
1390 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001391 *
1392 * @param intent The Intent to broadcast; all receivers matching this
1393 * Intent will receive the broadcast, and the Intent will be held to
1394 * be re-broadcast to future receivers.
1395 * @param user UserHandle to send the intent to.
1396 *
1397 * @see #sendBroadcast(Intent)
1398 */
1399 public abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user);
1400
1401 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001402 * Version of
1403 * {@link #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)}
1404 * that allows you to specify the
1405 * user the broadcast will be sent to. This is not available to applications
1406 * that are not pre-installed on the system image. Using it requires holding
1407 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001408 *
1409 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1410 *
1411 * @param intent The Intent to broadcast; all receivers matching this
1412 * Intent will receive the broadcast.
1413 * @param user UserHandle to send the intent to.
1414 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1415 * receiver of the broadcast.
1416 * @param scheduler A custom Handler with which to schedule the
1417 * resultReceiver callback; if null it will be
1418 * scheduled in the Context's main thread.
1419 * @param initialCode An initial value for the result code. Often
1420 * Activity.RESULT_OK.
1421 * @param initialData An initial value for the result data. Often
1422 * null.
1423 * @param initialExtras An initial value for the result extras. Often
1424 * null.
1425 *
1426 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
1427 */
1428 public abstract void sendStickyOrderedBroadcastAsUser(Intent intent,
1429 UserHandle user, BroadcastReceiver resultReceiver,
1430 Handler scheduler, int initialCode, String initialData,
1431 Bundle initialExtras);
1432
1433 /**
Dianne Hackborn8832c182012-09-17 17:20:24 -07001434 * Version of {@link #removeStickyBroadcast(Intent)} that allows you to specify the
1435 * user the broadcast will be sent to. This is not available to applications
1436 * that are not pre-installed on the system image. Using it requires holding
1437 * the INTERACT_ACROSS_USERS permission.
Dianne Hackborn5ac72a22012-08-29 18:32:08 -07001438 *
1439 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
1440 * permission in order to use this API. If you do not hold that
1441 * permission, {@link SecurityException} will be thrown.
1442 *
1443 * @param intent The Intent that was previously broadcast.
1444 * @param user UserHandle to remove the sticky broadcast from.
1445 *
1446 * @see #sendStickyBroadcastAsUser
1447 */
1448 public abstract void removeStickyBroadcastAsUser(Intent intent, UserHandle user);
1449
1450 /**
Chris Tatea34df8a22009-04-02 23:15:58 -07001451 * Register a BroadcastReceiver to be run in the main activity thread. The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001452 * <var>receiver</var> will be called with any broadcast Intent that
1453 * matches <var>filter</var>, in the main application thread.
1454 *
1455 * <p>The system may broadcast Intents that are "sticky" -- these stay
1456 * around after the broadcast as finished, to be sent to any later
1457 * registrations. If your IntentFilter matches one of these sticky
1458 * Intents, that Intent will be returned by this function
1459 * <strong>and</strong> sent to your <var>receiver</var> as if it had just
1460 * been broadcast.
1461 *
1462 * <p>There may be multiple sticky Intents that match <var>filter</var>,
1463 * in which case each of these will be sent to <var>receiver</var>. In
1464 * this case, only one of these can be returned directly by the function;
1465 * which of these that is returned is arbitrarily decided by the system.
1466 *
1467 * <p>If you know the Intent your are registering for is sticky, you can
1468 * supply null for your <var>receiver</var>. In this case, no receiver is
1469 * registered -- the function simply returns the sticky Intent that
1470 * matches <var>filter</var>. In the case of multiple matches, the same
1471 * rules as described above apply.
1472 *
1473 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1474 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07001475 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
1476 * registered with this method will correctly respect the
1477 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
1478 * Prior to that, it would be ignored and delivered to all matching registered
1479 * receivers. Be careful if using this for security.</p>
1480 *
Chris Tatea34df8a22009-04-02 23:15:58 -07001481 * <p class="note">Note: this method <em>cannot be called from a
1482 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver
1483 * that is declared in an application's manifest. It is okay, however, to call
1484 * this method from another BroadcastReceiver that has itself been registered
1485 * at run time with {@link #registerReceiver}, since the lifetime of such a
1486 * registered BroadcastReceiver is tied to the object that registered it.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001487 *
1488 * @param receiver The BroadcastReceiver to handle the broadcast.
1489 * @param filter Selects the Intent broadcasts to be received.
1490 *
1491 * @return The first sticky intent found that matches <var>filter</var>,
1492 * or null if there are none.
1493 *
1494 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
1495 * @see #sendBroadcast
1496 * @see #unregisterReceiver
1497 */
1498 public abstract Intent registerReceiver(BroadcastReceiver receiver,
1499 IntentFilter filter);
1500
1501 /**
1502 * Register to receive intent broadcasts, to run in the context of
1503 * <var>scheduler</var>. See
1504 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
1505 * information. This allows you to enforce permissions on who can
1506 * broadcast intents to your receiver, or have the receiver run in
1507 * a different thread than the main application thread.
1508 *
1509 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1510 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07001511 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
1512 * registered with this method will correctly respect the
1513 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
1514 * Prior to that, it would be ignored and delivered to all matching registered
1515 * receivers. Be careful if using this for security.</p>
1516 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 * @param receiver The BroadcastReceiver to handle the broadcast.
1518 * @param filter Selects the Intent broadcasts to be received.
1519 * @param broadcastPermission String naming a permissions that a
1520 * broadcaster must hold in order to send an Intent to you. If null,
1521 * no permission is required.
1522 * @param scheduler Handler identifying the thread that will receive
1523 * the Intent. If null, the main thread of the process will be used.
1524 *
1525 * @return The first sticky intent found that matches <var>filter</var>,
1526 * or null if there are none.
1527 *
1528 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
1529 * @see #sendBroadcast
1530 * @see #unregisterReceiver
1531 */
1532 public abstract Intent registerReceiver(BroadcastReceiver receiver,
Dianne Hackborn20e80982012-08-31 19:00:44 -07001533 IntentFilter filter, String broadcastPermission, Handler scheduler);
1534
1535 /**
1536 * @hide
1537 * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
1538 * but for a specific user. This receiver will receiver broadcasts that
1539 * are sent to the requested user. It
1540 * requires holding the {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL}
1541 * permission.
1542 *
1543 * @param receiver The BroadcastReceiver to handle the broadcast.
1544 * @param user UserHandle to send the intent to.
1545 * @param filter Selects the Intent broadcasts to be received.
1546 * @param broadcastPermission String naming a permissions that a
1547 * broadcaster must hold in order to send an Intent to you. If null,
1548 * no permission is required.
1549 * @param scheduler Handler identifying the thread that will receive
1550 * the Intent. If null, the main thread of the process will be used.
1551 *
1552 * @return The first sticky intent found that matches <var>filter</var>,
1553 * or null if there are none.
1554 *
1555 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler
1556 * @see #sendBroadcast
1557 * @see #unregisterReceiver
1558 */
1559 public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver,
1560 UserHandle user, IntentFilter filter, String broadcastPermission,
1561 Handler scheduler);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001562
1563 /**
1564 * Unregister a previously registered BroadcastReceiver. <em>All</em>
1565 * filters that have been registered for this BroadcastReceiver will be
1566 * removed.
1567 *
1568 * @param receiver The BroadcastReceiver to unregister.
1569 *
1570 * @see #registerReceiver
1571 */
1572 public abstract void unregisterReceiver(BroadcastReceiver receiver);
1573
1574 /**
1575 * Request that a given application service be started. The Intent
1576 * can either contain the complete class name of a specific service
1577 * implementation to start, or an abstract definition through the
1578 * action and other fields of the kind of service to start. If this service
1579 * is not already running, it will be instantiated and started (creating a
1580 * process for it if needed); if it is running then it remains running.
1581 *
1582 * <p>Every call to this method will result in a corresponding call to
Scott Main4b5da682010-10-21 11:49:12 -07001583 * the target service's {@link android.app.Service#onStartCommand} method,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 * with the <var>intent</var> given here. This provides a convenient way
1585 * to submit jobs to a service without having to bind and call on to its
1586 * interface.
1587 *
1588 * <p>Using startService() overrides the default service lifetime that is
1589 * managed by {@link #bindService}: it requires the service to remain
1590 * running until {@link #stopService} is called, regardless of whether
1591 * any clients are connected to it. Note that calls to startService()
1592 * are not nesting: no matter how many times you call startService(),
1593 * a single call to {@link #stopService} will stop it.
1594 *
1595 * <p>The system attempts to keep running services around as much as
1596 * possible. The only time they should be stopped is if the current
1597 * foreground application is using so many resources that the service needs
1598 * to be killed. If any errors happen in the service's process, it will
1599 * automatically be restarted.
1600 *
1601 * <p>This function will throw {@link SecurityException} if you do not
1602 * have permission to start the given service.
1603 *
1604 * @param service Identifies the service to be started. The Intent may
1605 * specify either an explicit component name to start, or a logical
1606 * description (action, category, etc) to match an
1607 * {@link IntentFilter} published by a service. Additional values
1608 * may be included in the Intent extras to supply arguments along with
1609 * this specific start call.
1610 *
1611 * @return If the service is being started or is already running, the
1612 * {@link ComponentName} of the actual service that was started is
1613 * returned; else if the service does not exist null is returned.
1614 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001615 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001616 *
1617 * @see #stopService
1618 * @see #bindService
1619 */
1620 public abstract ComponentName startService(Intent service);
1621
1622 /**
1623 * Request that a given application service be stopped. If the service is
1624 * not running, nothing happens. Otherwise it is stopped. Note that calls
1625 * to startService() are not counted -- this stops the service no matter
1626 * how many times it was started.
1627 *
1628 * <p>Note that if a stopped service still has {@link ServiceConnection}
1629 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will
1630 * not be destroyed until all of these bindings are removed. See
1631 * the {@link android.app.Service} documentation for more details on a
1632 * service's lifecycle.
1633 *
1634 * <p>This function will throw {@link SecurityException} if you do not
1635 * have permission to stop the given service.
1636 *
1637 * @param service Description of the service to be stopped. The Intent may
1638 * specify either an explicit component name to start, or a logical
1639 * description (action, category, etc) to match an
1640 * {@link IntentFilter} published by a service.
1641 *
1642 * @return If there is a service matching the given Intent that is already
John Spurlock6098c5d2013-06-17 10:32:46 -04001643 * 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 -08001644 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001645 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001646 *
1647 * @see #startService
1648 */
1649 public abstract boolean stopService(Intent service);
1650
1651 /**
Dianne Hackborn7767eac2012-08-23 18:25:40 -07001652 * @hide like {@link #startService(Intent)} but for a specific user.
1653 */
1654 public abstract ComponentName startServiceAsUser(Intent service, UserHandle user);
1655
1656 /**
1657 * @hide like {@link #stopService(Intent)} but for a specific user.
1658 */
1659 public abstract boolean stopServiceAsUser(Intent service, UserHandle user);
1660
1661 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001662 * Connect to an application service, creating it if needed. This defines
1663 * a dependency between your application and the service. The given
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001664 * <var>conn</var> will receive the service object when it is created and be
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001665 * told if it dies and restarts. The service will be considered required
1666 * by the system only for as long as the calling context exists. For
1667 * example, if this Context is an Activity that is stopped, the service will
1668 * not be required to continue running until the Activity is resumed.
1669 *
1670 * <p>This function will throw {@link SecurityException} if you do not
1671 * have permission to bind to the given service.
1672 *
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001673 * <p class="note">Note: this method <em>can not be called from a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001674 * {@link BroadcastReceiver} component</em>. A pattern you can use to
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001675 * communicate from a BroadcastReceiver to a Service is to call
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * {@link #startService} with the arguments containing the command to be
1677 * sent, with the service calling its
1678 * {@link android.app.Service#stopSelf(int)} method when done executing
1679 * that command. See the API demo App/Service/Service Start Arguments
1680 * Controller for an illustration of this. It is okay, however, to use
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001681 * this method from a BroadcastReceiver that has been registered with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver
1683 * is tied to another object (the one that registered it).</p>
1684 *
1685 * @param service Identifies the service to connect to. The Intent may
1686 * specify either an explicit component name, or a logical
1687 * description (action, category, etc) to match an
1688 * {@link IntentFilter} published by a service.
1689 * @param conn Receives information as the service is started and stopped.
Christopher Tate79b33172012-06-18 14:54:21 -07001690 * This must be a valid ServiceConnection object; it must not be null.
Scott Main4b5da682010-10-21 11:49:12 -07001691 * @param flags Operation options for the binding. May be 0,
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001692 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND},
1693 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT},
1694 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, or
1695 * {@link #BIND_WAIVE_PRIORITY}.
John Spurlock6098c5d2013-06-17 10:32:46 -04001696 * @return If you have successfully bound to the service, {@code true} is returned;
1697 * {@code false} is returned if the connection is not made so you will not
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 * receive the service object.
1699 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001700 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001701 *
1702 * @see #unbindService
1703 * @see #startService
1704 * @see #BIND_AUTO_CREATE
Scott Main4b5da682010-10-21 11:49:12 -07001705 * @see #BIND_DEBUG_UNBIND
1706 * @see #BIND_NOT_FOREGROUND
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001707 */
1708 public abstract boolean bindService(Intent service, ServiceConnection conn,
1709 int flags);
1710
1711 /**
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001712 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle
Amith Yamasani37ce3a82012-02-06 12:04:42 -08001713 * argument for use by system server and other multi-user aware code.
1714 * @hide
1715 */
Amith Yamasani27b89e62013-01-16 12:30:11 -08001716 public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user) {
Amith Yamasani37ce3a82012-02-06 12:04:42 -08001717 throw new RuntimeException("Not implemented. Must override in a subclass.");
1718 }
1719
1720 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001721 * Disconnect from an application service. You will no longer receive
1722 * calls as the service is restarted, and the service is now allowed to
1723 * stop at any time.
1724 *
1725 * @param conn The connection interface previously supplied to
Christopher Tate79b33172012-06-18 14:54:21 -07001726 * bindService(). This parameter must not be null.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001727 *
1728 * @see #bindService
1729 */
1730 public abstract void unbindService(ServiceConnection conn);
1731
1732 /**
1733 * Start executing an {@link android.app.Instrumentation} class. The given
1734 * Instrumentation component will be run by killing its target application
1735 * (if currently running), starting the target process, instantiating the
1736 * instrumentation component, and then letting it drive the application.
1737 *
1738 * <p>This function is not synchronous -- it returns as soon as the
1739 * instrumentation has started and while it is running.
1740 *
1741 * <p>Instrumentation is normally only allowed to run against a package
1742 * that is either unsigned or signed with a signature that the
1743 * the instrumentation package is also signed with (ensuring the target
1744 * trusts the instrumentation).
1745 *
1746 * @param className Name of the Instrumentation component to be run.
1747 * @param profileFile Optional path to write profiling data as the
1748 * instrumentation runs, or null for no profiling.
1749 * @param arguments Additional optional arguments to pass to the
1750 * instrumentation, or null.
1751 *
John Spurlock6098c5d2013-06-17 10:32:46 -04001752 * @return {@code true} if the instrumentation was successfully started,
1753 * else {@code false} if it could not be found.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001754 */
1755 public abstract boolean startInstrumentation(ComponentName className,
1756 String profileFile, Bundle arguments);
1757
1758 /**
1759 * Return the handle to a system-level service by name. The class of the
1760 * returned object varies by the requested name. Currently available names
1761 * are:
Scott Main4b5da682010-10-21 11:49:12 -07001762 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001763 * <dl>
1764 * <dt> {@link #WINDOW_SERVICE} ("window")
1765 * <dd> The top-level window manager in which you can place custom
1766 * windows. The returned object is a {@link android.view.WindowManager}.
1767 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater")
1768 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources
1769 * in this context.
1770 * <dt> {@link #ACTIVITY_SERVICE} ("activity")
1771 * <dd> A {@link android.app.ActivityManager} for interacting with the
1772 * global activity state of the system.
1773 * <dt> {@link #POWER_SERVICE} ("power")
1774 * <dd> A {@link android.os.PowerManager} for controlling power
1775 * management.
1776 * <dt> {@link #ALARM_SERVICE} ("alarm")
1777 * <dd> A {@link android.app.AlarmManager} for receiving intents at the
1778 * time of your choosing.
1779 * <dt> {@link #NOTIFICATION_SERVICE} ("notification")
1780 * <dd> A {@link android.app.NotificationManager} for informing the user
1781 * of background events.
1782 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard")
1783 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard.
1784 * <dt> {@link #LOCATION_SERVICE} ("location")
1785 * <dd> A {@link android.location.LocationManager} for controlling location
1786 * (e.g., GPS) updates.
1787 * <dt> {@link #SEARCH_SERVICE} ("search")
1788 * <dd> A {@link android.app.SearchManager} for handling search.
1789 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator")
1790 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator
1791 * hardware.
1792 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection")
1793 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for
1794 * handling management of network connections.
1795 * <dt> {@link #WIFI_SERVICE} ("wifi")
1796 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of
1797 * Wi-Fi connectivity.
1798 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method")
1799 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager}
1800 * for management of input methods.
Tobias Haamel53332882010-02-18 16:15:43 -08001801 * <dt> {@link #UI_MODE_SERVICE} ("uimode")
1802 * <dd> An {@link android.app.UiModeManager} for controlling UI modes.
Steve Howard7083c422010-07-28 16:01:23 -07001803 * <dt> {@link #DOWNLOAD_SERVICE} ("download")
Steve Howardd58429f2010-09-27 16:32:39 -07001804 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001805 * </dl>
Scott Main4b5da682010-10-21 11:49:12 -07001806 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001807 * <p>Note: System services obtained via this API may be closely associated with
1808 * the Context in which they are obtained from. In general, do not share the
1809 * service objects between various different contexts (Activities, Applications,
1810 * Services, Providers, etc.)
1811 *
1812 * @param name The name of the desired service.
Scott Main4b5da682010-10-21 11:49:12 -07001813 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001814 * @return The service or null if the name does not exist.
Scott Main4b5da682010-10-21 11:49:12 -07001815 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001816 * @see #WINDOW_SERVICE
1817 * @see android.view.WindowManager
1818 * @see #LAYOUT_INFLATER_SERVICE
1819 * @see android.view.LayoutInflater
1820 * @see #ACTIVITY_SERVICE
1821 * @see android.app.ActivityManager
1822 * @see #POWER_SERVICE
1823 * @see android.os.PowerManager
1824 * @see #ALARM_SERVICE
1825 * @see android.app.AlarmManager
1826 * @see #NOTIFICATION_SERVICE
1827 * @see android.app.NotificationManager
1828 * @see #KEYGUARD_SERVICE
1829 * @see android.app.KeyguardManager
1830 * @see #LOCATION_SERVICE
1831 * @see android.location.LocationManager
1832 * @see #SEARCH_SERVICE
1833 * @see android.app.SearchManager
1834 * @see #SENSOR_SERVICE
1835 * @see android.hardware.SensorManager
San Mehatc9d81752010-02-01 10:23:27 -08001836 * @see #STORAGE_SERVICE
San Mehatb1043402010-02-05 08:26:50 -08001837 * @see android.os.storage.StorageManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001838 * @see #VIBRATOR_SERVICE
1839 * @see android.os.Vibrator
1840 * @see #CONNECTIVITY_SERVICE
1841 * @see android.net.ConnectivityManager
1842 * @see #WIFI_SERVICE
1843 * @see android.net.wifi.WifiManager
1844 * @see #AUDIO_SERVICE
1845 * @see android.media.AudioManager
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07001846 * @see #MEDIA_ROUTER_SERVICE
1847 * @see android.media.MediaRouter
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001848 * @see #TELEPHONY_SERVICE
1849 * @see android.telephony.TelephonyManager
1850 * @see #INPUT_METHOD_SERVICE
1851 * @see android.view.inputmethod.InputMethodManager
Tobias Haamel53332882010-02-18 16:15:43 -08001852 * @see #UI_MODE_SERVICE
1853 * @see android.app.UiModeManager
Steve Howard7083c422010-07-28 16:01:23 -07001854 * @see #DOWNLOAD_SERVICE
Steve Howardd58429f2010-09-27 16:32:39 -07001855 * @see android.app.DownloadManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001856 */
1857 public abstract Object getSystemService(String name);
1858
1859 /**
1860 * Use with {@link #getSystemService} to retrieve a
1861 * {@link android.os.PowerManager} for controlling power management,
1862 * including "wake locks," which let you keep the device on while
1863 * you're running long tasks.
1864 */
1865 public static final String POWER_SERVICE = "power";
Scott Main4b5da682010-10-21 11:49:12 -07001866
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001867 /**
1868 * Use with {@link #getSystemService} to retrieve a
1869 * {@link android.view.WindowManager} for accessing the system's window
1870 * manager.
1871 *
1872 * @see #getSystemService
1873 * @see android.view.WindowManager
1874 */
1875 public static final String WINDOW_SERVICE = "window";
Scott Main4b5da682010-10-21 11:49:12 -07001876
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001877 /**
1878 * Use with {@link #getSystemService} to retrieve a
1879 * {@link android.view.LayoutInflater} for inflating layout resources in this
1880 * context.
1881 *
1882 * @see #getSystemService
1883 * @see android.view.LayoutInflater
1884 */
1885 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
Scott Main4b5da682010-10-21 11:49:12 -07001886
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001887 /**
1888 * Use with {@link #getSystemService} to retrieve a
Fred Quintana60307342009-03-24 22:48:12 -07001889 * {@link android.accounts.AccountManager} for receiving intents at a
1890 * time of your choosing.
Fred Quintana60307342009-03-24 22:48:12 -07001891 *
1892 * @see #getSystemService
1893 * @see android.accounts.AccountManager
1894 */
1895 public static final String ACCOUNT_SERVICE = "account";
Scott Main4b5da682010-10-21 11:49:12 -07001896
Fred Quintana60307342009-03-24 22:48:12 -07001897 /**
1898 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001899 * {@link android.app.ActivityManager} for interacting with the global
1900 * system state.
1901 *
1902 * @see #getSystemService
1903 * @see android.app.ActivityManager
1904 */
1905 public static final String ACTIVITY_SERVICE = "activity";
Scott Main4b5da682010-10-21 11:49:12 -07001906
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001907 /**
1908 * Use with {@link #getSystemService} to retrieve a
1909 * {@link android.app.AlarmManager} for receiving intents at a
1910 * time of your choosing.
1911 *
1912 * @see #getSystemService
1913 * @see android.app.AlarmManager
1914 */
1915 public static final String ALARM_SERVICE = "alarm";
Scott Main4b5da682010-10-21 11:49:12 -07001916
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001917 /**
1918 * Use with {@link #getSystemService} to retrieve a
1919 * {@link android.app.NotificationManager} for informing the user of
1920 * background events.
1921 *
1922 * @see #getSystemService
1923 * @see android.app.NotificationManager
1924 */
1925 public static final String NOTIFICATION_SERVICE = "notification";
Scott Main4b5da682010-10-21 11:49:12 -07001926
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001927 /**
1928 * Use with {@link #getSystemService} to retrieve a
svetoslavganov75986cf2009-05-14 22:28:01 -07001929 * {@link android.view.accessibility.AccessibilityManager} for giving the user
1930 * feedback for UI events through the registered event listeners.
1931 *
1932 * @see #getSystemService
1933 * @see android.view.accessibility.AccessibilityManager
1934 */
1935 public static final String ACCESSIBILITY_SERVICE = "accessibility";
Scott Main4b5da682010-10-21 11:49:12 -07001936
svetoslavganov75986cf2009-05-14 22:28:01 -07001937 /**
1938 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001939 * {@link android.app.NotificationManager} for controlling keyguard.
1940 *
1941 * @see #getSystemService
1942 * @see android.app.KeyguardManager
1943 */
1944 public static final String KEYGUARD_SERVICE = "keyguard";
Scott Main4b5da682010-10-21 11:49:12 -07001945
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001946 /**
1947 * Use with {@link #getSystemService} to retrieve a {@link
1948 * android.location.LocationManager} for controlling location
1949 * updates.
1950 *
1951 * @see #getSystemService
1952 * @see android.location.LocationManager
1953 */
1954 public static final String LOCATION_SERVICE = "location";
Bai Taoa58a8752010-07-13 15:32:16 +08001955
1956 /**
1957 * Use with {@link #getSystemService} to retrieve a
1958 * {@link android.location.CountryDetector} for detecting the country that
1959 * the user is in.
1960 *
1961 * @hide
1962 */
1963 public static final String COUNTRY_DETECTOR = "country_detector";
1964
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001965 /**
1966 * Use with {@link #getSystemService} to retrieve a {@link
1967 * android.app.SearchManager} for handling searches.
1968 *
1969 * @see #getSystemService
1970 * @see android.app.SearchManager
1971 */
1972 public static final String SEARCH_SERVICE = "search";
Scott Main4b5da682010-10-21 11:49:12 -07001973
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001974 /**
1975 * Use with {@link #getSystemService} to retrieve a {@link
1976 * android.hardware.SensorManager} for accessing sensors.
1977 *
1978 * @see #getSystemService
1979 * @see android.hardware.SensorManager
1980 */
1981 public static final String SENSOR_SERVICE = "sensor";
Scott Main4b5da682010-10-21 11:49:12 -07001982
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001983 /**
San Mehatc9d81752010-02-01 10:23:27 -08001984 * Use with {@link #getSystemService} to retrieve a {@link
Kenny Root02c87302010-07-01 08:10:18 -07001985 * android.os.storage.StorageManager} for accessing system storage
San Mehatc9d81752010-02-01 10:23:27 -08001986 * functions.
1987 *
1988 * @see #getSystemService
San Mehatb1043402010-02-05 08:26:50 -08001989 * @see android.os.storage.StorageManager
San Mehatc9d81752010-02-01 10:23:27 -08001990 */
1991 public static final String STORAGE_SERVICE = "storage";
1992
1993 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001994 * Use with {@link #getSystemService} to retrieve a
1995 * com.android.server.WallpaperService for accessing wallpapers.
1996 *
1997 * @see #getSystemService
1998 */
1999 public static final String WALLPAPER_SERVICE = "wallpaper";
Scott Main4b5da682010-10-21 11:49:12 -07002000
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002001 /**
2002 * Use with {@link #getSystemService} to retrieve a {@link
2003 * android.os.Vibrator} for interacting with the vibration hardware.
2004 *
2005 * @see #getSystemService
2006 * @see android.os.Vibrator
2007 */
2008 public static final String VIBRATOR_SERVICE = "vibrator";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07002009
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002010 /**
2011 * Use with {@link #getSystemService} to retrieve a {@link
2012 * android.app.StatusBarManager} for interacting with the status bar.
2013 *
2014 * @see #getSystemService
2015 * @see android.app.StatusBarManager
2016 * @hide
2017 */
2018 public static final String STATUS_BAR_SERVICE = "statusbar";
2019
2020 /**
2021 * Use with {@link #getSystemService} to retrieve a {@link
2022 * android.net.ConnectivityManager} for handling management of
2023 * network connections.
2024 *
2025 * @see #getSystemService
2026 * @see android.net.ConnectivityManager
2027 */
2028 public static final String CONNECTIVITY_SERVICE = "connectivity";
2029
2030 /**
2031 * Use with {@link #getSystemService} to retrieve a {@link
Christopher Tate8662cab52012-02-23 14:59:36 -08002032 * android.os.IUpdateLock} for managing runtime sequences that
2033 * must not be interrupted by headless OTA application or similar.
2034 *
2035 * @hide
2036 * @see #getSystemService
2037 * @see android.os.UpdateLock
2038 */
2039 public static final String UPDATE_LOCK_SERVICE = "updatelock";
2040
2041 /**
2042 * Use with {@link #getSystemService} to retrieve a {@link
San Mehatd1df8ac2010-01-26 06:17:26 -08002043 * android.net.NetworkManagementService} for handling management of
2044 * system network services
2045 *
2046 * @hide
2047 * @see #getSystemService
2048 * @see android.net.NetworkManagementService
2049 */
2050 public static final String NETWORKMANAGEMENT_SERVICE = "network_management";
2051
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07002052 /** {@hide} */
Jeff Sharkey75279902011-05-24 18:39:45 -07002053 public static final String NETWORK_STATS_SERVICE = "netstats";
2054 /** {@hide} */
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07002055 public static final String NETWORK_POLICY_SERVICE = "netpolicy";
2056
San Mehatd1df8ac2010-01-26 06:17:26 -08002057 /**
2058 * Use with {@link #getSystemService} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002059 * android.net.wifi.WifiManager} for handling management of
2060 * Wi-Fi access.
2061 *
2062 * @see #getSystemService
2063 * @see android.net.wifi.WifiManager
2064 */
2065 public static final String WIFI_SERVICE = "wifi";
Scott Main4b5da682010-10-21 11:49:12 -07002066
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002067 /**
repo sync55bc5f32011-06-24 14:23:07 -07002068 * Use with {@link #getSystemService} to retrieve a {@link
2069 * android.net.wifi.p2p.WifiP2pManager} for handling management of
Irfan Sheriff651cdfc2011-09-07 00:31:20 -07002070 * Wi-Fi peer-to-peer connections.
repo sync55bc5f32011-06-24 14:23:07 -07002071 *
2072 * @see #getSystemService
2073 * @see android.net.wifi.p2p.WifiP2pManager
repo sync55bc5f32011-06-24 14:23:07 -07002074 */
2075 public static final String WIFI_P2P_SERVICE = "wifip2p";
2076
2077 /**
Irfan Sheriff7d024d32012-03-22 17:01:39 -07002078 * Use with {@link #getSystemService} to retrieve a {@link
Irfan Sheriff60309fc2012-04-24 14:52:37 -07002079 * android.net.nsd.NsdManager} for handling management of network service
Irfan Sheriff7d024d32012-03-22 17:01:39 -07002080 * discovery
2081 *
Irfan Sheriff7d024d32012-03-22 17:01:39 -07002082 * @see #getSystemService
Irfan Sheriff60309fc2012-04-24 14:52:37 -07002083 * @see android.net.nsd.NsdManager
Irfan Sheriff7d024d32012-03-22 17:01:39 -07002084 */
2085 public static final String NSD_SERVICE = "servicediscovery";
2086
Irfan Sheriff7d024d32012-03-22 17:01:39 -07002087 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 * Use with {@link #getSystemService} to retrieve a
2089 * {@link android.media.AudioManager} for handling management of volume,
2090 * ringer modes and audio routing.
Scott Main4b5da682010-10-21 11:49:12 -07002091 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002092 * @see #getSystemService
2093 * @see android.media.AudioManager
2094 */
2095 public static final String AUDIO_SERVICE = "audio";
Scott Main4b5da682010-10-21 11:49:12 -07002096
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002097 /**
2098 * Use with {@link #getSystemService} to retrieve a
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07002099 * {@link android.media.MediaRouter} for controlling and managing
2100 * routing of media.
2101 *
2102 * @see #getSystemService
2103 * @see android.media.MediaRouter
2104 */
2105 public static final String MEDIA_ROUTER_SERVICE = "media_router";
2106
2107 /**
2108 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 * {@link android.telephony.TelephonyManager} for handling management the
2110 * telephony features of the device.
Scott Main4b5da682010-10-21 11:49:12 -07002111 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002112 * @see #getSystemService
2113 * @see android.telephony.TelephonyManager
2114 */
2115 public static final String TELEPHONY_SERVICE = "phone";
2116
2117 /**
2118 * Use with {@link #getSystemService} to retrieve a
2119 * {@link android.text.ClipboardManager} for accessing and modifying
2120 * the contents of the global clipboard.
Scott Main4b5da682010-10-21 11:49:12 -07002121 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002122 * @see #getSystemService
2123 * @see android.text.ClipboardManager
2124 */
2125 public static final String CLIPBOARD_SERVICE = "clipboard";
2126
2127 /**
Scott Main4b5da682010-10-21 11:49:12 -07002128 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002129 * {@link android.view.inputmethod.InputMethodManager} for accessing input
2130 * methods.
2131 *
2132 * @see #getSystemService
2133 */
2134 public static final String INPUT_METHOD_SERVICE = "input_method";
2135
2136 /**
2137 * Use with {@link #getSystemService} to retrieve a
satok988323c2011-06-22 16:38:13 +09002138 * {@link android.view.textservice.TextServicesManager} for accessing
2139 * text services.
2140 *
2141 * @see #getSystemService
2142 */
2143 public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices";
2144
2145 /**
2146 * Use with {@link #getSystemService} to retrieve a
Dan Egnore38d58b2009-12-30 19:29:03 -08002147 * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 *
2149 * @hide
2150 * @see #getSystemService
2151 */
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002152 public static final String APPWIDGET_SERVICE = "appwidget";
Dan Egnor95240272009-10-27 18:23:39 -07002153
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002154 /**
Christopher Tate487529a2009-04-29 14:03:25 -07002155 * Use with {@link #getSystemService} to retrieve an
Christopher Tate45281862010-03-05 15:46:30 -08002156 * {@link android.app.backup.IBackupManager IBackupManager} for communicating
Christopher Tate487529a2009-04-29 14:03:25 -07002157 * with the backup mechanism.
Dianne Hackborn7f205432009-07-28 00:13:47 -07002158 * @hide
Scott Main4b5da682010-10-21 11:49:12 -07002159 *
Christopher Tate487529a2009-04-29 14:03:25 -07002160 * @see #getSystemService
2161 */
2162 public static final String BACKUP_SERVICE = "backup";
Dan Egnor95240272009-10-27 18:23:39 -07002163
2164 /**
2165 * Use with {@link #getSystemService} to retrieve a
Dan Egnor1337b012010-01-04 11:01:44 -08002166 * {@link android.os.DropBoxManager} instance for recording
Dan Egnor95240272009-10-27 18:23:39 -07002167 * diagnostic logs.
Dan Egnor95240272009-10-27 18:23:39 -07002168 * @see #getSystemService
2169 */
2170 public static final String DROPBOX_SERVICE = "dropbox";
2171
Christopher Tate487529a2009-04-29 14:03:25 -07002172 /**
Scott Main4b5da682010-10-21 11:49:12 -07002173 * Use with {@link #getSystemService} to retrieve a
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08002174 * {@link android.app.admin.DevicePolicyManager} for working with global
Dianne Hackbornd6847842010-01-12 18:14:19 -08002175 * device policy management.
2176 *
2177 * @see #getSystemService
2178 */
2179 public static final String DEVICE_POLICY_SERVICE = "device_policy";
2180
2181 /**
Tobias Haamel53332882010-02-18 16:15:43 -08002182 * Use with {@link #getSystemService} to retrieve a
2183 * {@link android.app.UiModeManager} for controlling UI modes.
2184 *
2185 * @see #getSystemService
2186 */
2187 public static final String UI_MODE_SERVICE = "uimode";
2188
2189 /**
Steve Howarda2709362010-07-02 17:12:48 -07002190 * Use with {@link #getSystemService} to retrieve a
Steve Howardd58429f2010-09-27 16:32:39 -07002191 * {@link android.app.DownloadManager} for requesting HTTP downloads.
Steve Howarda2709362010-07-02 17:12:48 -07002192 *
2193 * @see #getSystemService
Steve Howarda2709362010-07-02 17:12:48 -07002194 */
2195 public static final String DOWNLOAD_SERVICE = "download";
2196
2197 /**
Chung-yih Wang2d942312010-08-05 12:17:37 +08002198 * Use with {@link #getSystemService} to retrieve a
Nick Pelly50b4d8f2010-12-07 22:40:28 -08002199 * {@link android.nfc.NfcManager} for using NFC.
2200 *
2201 * @see #getSystemService
2202 */
2203 public static final String NFC_SERVICE = "nfc";
2204
2205 /**
2206 * Use with {@link #getSystemService} to retrieve a
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08002207 * {@link android.bluetooth.BluetoothAdapter} for using Bluetooth.
2208 *
2209 * @see #getSystemService
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08002210 */
2211 public static final String BLUETOOTH_SERVICE = "bluetooth";
2212
2213 /**
2214 * Use with {@link #getSystemService} to retrieve a
Chung-yih Wang2d942312010-08-05 12:17:37 +08002215 * {@link android.net.sip.SipManager} for accessing the SIP related service.
2216 *
2217 * @see #getSystemService
2218 */
2219 /** @hide */
2220 public static final String SIP_SERVICE = "sip";
2221
2222 /**
Mike Lockwoode7d511e2010-12-30 13:39:37 -05002223 * Use with {@link #getSystemService} to retrieve a {@link
Mike Lockwoodc4308f02011-03-01 08:04:54 -08002224 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host)
Mike Lockwoode7d511e2010-12-30 13:39:37 -05002225 * and for controlling this device's behavior as a USB device.
2226 *
2227 * @see #getSystemService
John Spurlock6098c5d2013-06-17 10:32:46 -04002228 * @see android.hardware.usb.UsbManager
Mike Lockwoode7d511e2010-12-30 13:39:37 -05002229 */
2230 public static final String USB_SERVICE = "usb";
2231
2232 /**
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04002233 * Use with {@link #getSystemService} to retrieve a {@link
2234 * android.hardware.SerialManager} for access to serial ports.
2235 *
2236 * @see #getSystemService
2237 * @see android.harware.SerialManager
2238 *
2239 * @hide
2240 */
2241 public static final String SERIAL_SERVICE = "serial";
2242
2243 /**
Jeff Brown9df6e7a2012-04-05 11:49:26 -07002244 * Use with {@link #getSystemService} to retrieve a
2245 * {@link android.hardware.input.InputManager} for interacting with input devices.
2246 *
2247 * @see #getSystemService
2248 * @see android.hardware.input.InputManager
2249 */
2250 public static final String INPUT_SERVICE = "input";
2251
2252 /**
Glenn Kasten07b04652012-04-23 15:00:43 -07002253 * Use with {@link #getSystemService} to retrieve a
Jeff Brownfa25bf52012-07-23 19:26:30 -07002254 * {@link android.hardware.display.DisplayManager} for interacting with display devices.
2255 *
2256 * @see #getSystemService
2257 * @see android.hardware.display.DisplayManager
2258 */
2259 public static final String DISPLAY_SERVICE = "display";
2260
2261 /**
2262 * Use with {@link #getSystemService} to retrieve a
Glenn Kasten07b04652012-04-23 15:00:43 -07002263 * {@link android.os.SchedulingPolicyService} for managing scheduling policy.
2264 *
2265 * @see #getSystemService
2266 * @see android.os.SchedulingPolicyService
2267 *
2268 * @hide
2269 */
2270 public static final String SCHEDULING_POLICY_SERVICE = "scheduling_policy";
2271
2272 /**
Amith Yamasani258848d2012-08-10 17:06:33 -07002273 * Use with {@link #getSystemService} to retrieve a
2274 * {@link android.os.UserManager} for managing users on devices that support multiple users.
2275 *
2276 * @see #getSystemService
2277 * @see android.os.UserManager
2278 */
2279 public static final String USER_SERVICE = "user";
2280
2281 /**
Dianne Hackborna06de0f2012-12-11 16:34:47 -08002282 * Use with {@link #getSystemService} to retrieve a
2283 * {@link android.app.AppOpsManager} for tracking application operations
2284 * on the device.
2285 *
2286 * @see #getSystemService
2287 * @see android.app.AppOpsManager
2288 *
2289 * @hide
2290 */
2291 public static final String APP_OPS_SERVICE = "appops";
2292
2293 /**
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08002294 * Use with {@link #getSystemService} to retrieve a
2295 * {@link android.hardware.photography.CameraManager} for interacting with
2296 * camera devices.
2297 *
2298 * @see #getSystemService
2299 * @see android.hardware.camera.CameraManager
2300 */
2301 public static final String CAMERA_SERVICE = "camera";
2302
2303 /**
Svetoslav Ganov4b9a4d12013-06-11 15:20:06 -07002304 * {@link android.print.PrintManager} for printing and managing
2305 * printers and print taks.
2306 *
2307 * @see #getSystemService
2308 * @see android.print.PrintManager
2309 */
2310 public static final String PRINT_SERVICE = "print";
2311
2312 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002313 * Determine whether the given permission is allowed for a particular
2314 * process and user ID running in the system.
2315 *
2316 * @param permission The name of the permission being checked.
2317 * @param pid The process ID being checked against. Must be > 0.
2318 * @param uid The user ID being checked against. A uid of 0 is the root
2319 * user, which will pass every permission check.
2320 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002321 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 * pid/uid is allowed that permission, or
2323 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2324 *
2325 * @see PackageManager#checkPermission(String, String)
2326 * @see #checkCallingPermission
2327 */
2328 public abstract int checkPermission(String permission, int pid, int uid);
2329
2330 /**
2331 * Determine whether the calling process of an IPC you are handling has been
2332 * granted a particular permission. This is basically the same as calling
2333 * {@link #checkPermission(String, int, int)} with the pid and uid returned
2334 * by {@link android.os.Binder#getCallingPid} and
2335 * {@link android.os.Binder#getCallingUid}. One important difference
2336 * is that if you are not currently processing an IPC, this function
2337 * will always fail. This is done to protect against accidentally
2338 * leaking permissions; you can use {@link #checkCallingOrSelfPermission}
2339 * to avoid this protection.
2340 *
2341 * @param permission The name of the permission being checked.
2342 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002343 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002344 * pid/uid is allowed that permission, or
2345 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2346 *
2347 * @see PackageManager#checkPermission(String, String)
2348 * @see #checkPermission
2349 * @see #checkCallingOrSelfPermission
2350 */
2351 public abstract int checkCallingPermission(String permission);
2352
2353 /**
2354 * Determine whether the calling process of an IPC <em>or you</em> have been
2355 * granted a particular permission. This is the same as
2356 * {@link #checkCallingPermission}, except it grants your own permissions
2357 * if you are not currently processing an IPC. Use with care!
2358 *
2359 * @param permission The name of the permission being checked.
2360 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002361 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002362 * pid/uid is allowed that permission, or
2363 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2364 *
2365 * @see PackageManager#checkPermission(String, String)
2366 * @see #checkPermission
2367 * @see #checkCallingPermission
2368 */
2369 public abstract int checkCallingOrSelfPermission(String permission);
2370
2371 /**
2372 * If the given permission is not allowed for a particular process
2373 * and user ID running in the system, throw a {@link SecurityException}.
2374 *
2375 * @param permission The name of the permission being checked.
2376 * @param pid The process ID being checked against. Must be &gt; 0.
2377 * @param uid The user ID being checked against. A uid of 0 is the root
2378 * user, which will pass every permission check.
2379 * @param message A message to include in the exception if it is thrown.
2380 *
2381 * @see #checkPermission(String, int, int)
2382 */
2383 public abstract void enforcePermission(
2384 String permission, int pid, int uid, String message);
2385
2386 /**
2387 * If the calling process of an IPC you are handling has not been
2388 * granted a particular permission, throw a {@link
2389 * SecurityException}. This is basically the same as calling
2390 * {@link #enforcePermission(String, int, int, String)} with the
2391 * pid and uid returned by {@link android.os.Binder#getCallingPid}
2392 * and {@link android.os.Binder#getCallingUid}. One important
2393 * difference is that if you are not currently processing an IPC,
2394 * this function will always throw the SecurityException. This is
2395 * done to protect against accidentally leaking permissions; you
2396 * can use {@link #enforceCallingOrSelfPermission} to avoid this
2397 * protection.
2398 *
2399 * @param permission The name of the permission being checked.
2400 * @param message A message to include in the exception if it is thrown.
2401 *
2402 * @see #checkCallingPermission(String)
2403 */
2404 public abstract void enforceCallingPermission(
2405 String permission, String message);
2406
2407 /**
2408 * If neither you nor the calling process of an IPC you are
2409 * handling has been granted a particular permission, throw a
2410 * {@link SecurityException}. This is the same as {@link
2411 * #enforceCallingPermission}, except it grants your own
2412 * permissions if you are not currently processing an IPC. Use
2413 * with care!
2414 *
2415 * @param permission The name of the permission being checked.
2416 * @param message A message to include in the exception if it is thrown.
2417 *
2418 * @see #checkCallingOrSelfPermission(String)
2419 */
2420 public abstract void enforceCallingOrSelfPermission(
2421 String permission, String message);
2422
2423 /**
2424 * Grant permission to access a specific Uri to another package, regardless
2425 * of whether that package has general permission to access the Uri's
2426 * content provider. This can be used to grant specific, temporary
2427 * permissions, typically in response to user interaction (such as the
2428 * user opening an attachment that you would like someone else to
2429 * display).
2430 *
2431 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2432 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2433 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2434 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to
2435 * start an activity instead of this function directly. If you use this
2436 * function directly, you should be sure to call
2437 * {@link #revokeUriPermission} when the target should no longer be allowed
2438 * to access it.
2439 *
2440 * <p>To succeed, the content provider owning the Uri must have set the
2441 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions
2442 * grantUriPermissions} attribute in its manifest or included the
2443 * {@link android.R.styleable#AndroidManifestGrantUriPermission
2444 * &lt;grant-uri-permissions&gt;} tag.
2445 *
2446 * @param toPackage The package you would like to allow to access the Uri.
2447 * @param uri The Uri you would like to grant access to.
2448 * @param modeFlags The desired access modes. Any combination of
2449 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2450 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2451 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2452 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2453 *
2454 * @see #revokeUriPermission
2455 */
2456 public abstract void grantUriPermission(String toPackage, Uri uri,
2457 int modeFlags);
2458
2459 /**
2460 * Remove all permissions to access a particular content provider Uri
2461 * that were previously added with {@link #grantUriPermission}. The given
2462 * Uri will match all previously granted Uris that are the same or a
Jeff Sharkey328ebf22013-03-21 18:09:39 -07002463 * sub-path of the given Uri. That is, revoking "content://foo/target" will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002464 * revoke both "content://foo/target" and "content://foo/target/sub", but not
2465 * "content://foo".
2466 *
2467 * @param uri The Uri you would like to revoke access to.
2468 * @param modeFlags The desired access modes. Any combination of
2469 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2470 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2471 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2472 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2473 *
2474 * @see #grantUriPermission
2475 */
2476 public abstract void revokeUriPermission(Uri uri, int modeFlags);
2477
2478 /**
2479 * Determine whether a particular process and user ID has been granted
2480 * permission to access a specific URI. This only checks for permissions
2481 * that have been explicitly granted -- if the given process/uid has
2482 * more general access to the URI's content provider then this check will
2483 * always fail.
2484 *
2485 * @param uri The uri that is being checked.
2486 * @param pid The process ID being checked against. Must be &gt; 0.
2487 * @param uid The user ID being checked against. A uid of 0 is the root
2488 * user, which will pass every permission check.
2489 * @param modeFlags The type of access to grant. May be one or both of
2490 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2491 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2492 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002493 * @return {@link PackageManager#PERMISSION_GRANTED} if the given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002494 * pid/uid is allowed to access that uri, or
2495 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2496 *
2497 * @see #checkCallingUriPermission
2498 */
2499 public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags);
2500
2501 /**
2502 * Determine whether the calling process and user ID has been
2503 * granted permission to access a specific URI. This is basically
2504 * the same as calling {@link #checkUriPermission(Uri, int, int,
2505 * int)} with the pid and uid returned by {@link
2506 * android.os.Binder#getCallingPid} and {@link
2507 * android.os.Binder#getCallingUid}. One important difference is
2508 * that if you are not currently processing an IPC, this function
2509 * will always fail.
2510 *
2511 * @param uri The uri that is being checked.
2512 * @param modeFlags The type of access to grant. May be one or both of
2513 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2514 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2515 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002516 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002517 * is allowed to access that uri, or
2518 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2519 *
2520 * @see #checkUriPermission(Uri, int, int, int)
2521 */
2522 public abstract int checkCallingUriPermission(Uri uri, int modeFlags);
2523
2524 /**
2525 * Determine whether the calling process of an IPC <em>or you</em> has been granted
2526 * permission to access a specific URI. This is the same as
2527 * {@link #checkCallingUriPermission}, except it grants your own permissions
2528 * if you are not currently processing an IPC. Use with care!
2529 *
2530 * @param uri The uri that is being checked.
2531 * @param modeFlags The type of access to grant. May be one or both of
2532 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2533 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2534 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002535 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002536 * is allowed to access that uri, or
2537 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2538 *
2539 * @see #checkCallingUriPermission
2540 */
2541 public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags);
2542
2543 /**
2544 * Check both a Uri and normal permission. This allows you to perform
2545 * both {@link #checkPermission} and {@link #checkUriPermission} in one
2546 * call.
2547 *
2548 * @param uri The Uri whose permission is to be checked, or null to not
2549 * do this check.
2550 * @param readPermission The permission that provides overall read access,
2551 * or null to not do this check.
2552 * @param writePermission The permission that provides overall write
2553 * acess, or null to not do this check.
2554 * @param pid The process ID being checked against. Must be &gt; 0.
2555 * @param uid The user ID being checked against. A uid of 0 is the root
2556 * user, which will pass every permission check.
2557 * @param modeFlags The type of access to grant. May be one or both of
2558 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2559 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2560 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002561 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002562 * is allowed to access that uri or holds one of the given permissions, or
2563 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2564 */
2565 public abstract int checkUriPermission(Uri uri, String readPermission,
2566 String writePermission, int pid, int uid, int modeFlags);
2567
2568 /**
2569 * If a particular process and user ID has not been granted
2570 * permission to access a specific URI, throw {@link
2571 * SecurityException}. This only checks for permissions that have
2572 * been explicitly granted -- if the given process/uid has more
2573 * general access to the URI's content provider then this check
2574 * will always fail.
2575 *
2576 * @param uri The uri that is being checked.
2577 * @param pid The process ID being checked against. Must be &gt; 0.
2578 * @param uid The user ID being checked against. A uid of 0 is the root
2579 * user, which will pass every permission check.
2580 * @param modeFlags The type of access to grant. May be one or both of
2581 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2582 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2583 * @param message A message to include in the exception if it is thrown.
2584 *
2585 * @see #checkUriPermission(Uri, int, int, int)
2586 */
2587 public abstract void enforceUriPermission(
2588 Uri uri, int pid, int uid, int modeFlags, String message);
2589
2590 /**
2591 * If the calling process and user ID has not been granted
2592 * permission to access a specific URI, throw {@link
2593 * SecurityException}. This is basically the same as calling
2594 * {@link #enforceUriPermission(Uri, int, int, int, String)} with
2595 * the pid and uid returned by {@link
2596 * android.os.Binder#getCallingPid} and {@link
2597 * android.os.Binder#getCallingUid}. One important difference is
2598 * that if you are not currently processing an IPC, this function
2599 * will always throw a SecurityException.
2600 *
2601 * @param uri The uri that is being checked.
2602 * @param modeFlags The type of access to grant. May be one or both of
2603 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2604 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2605 * @param message A message to include in the exception if it is thrown.
2606 *
2607 * @see #checkCallingUriPermission(Uri, int)
2608 */
2609 public abstract void enforceCallingUriPermission(
2610 Uri uri, int modeFlags, String message);
2611
2612 /**
2613 * If the calling process of an IPC <em>or you</em> has not been
2614 * granted permission to access a specific URI, throw {@link
2615 * SecurityException}. This is the same as {@link
2616 * #enforceCallingUriPermission}, except it grants your own
2617 * permissions if you are not currently processing an IPC. Use
2618 * with care!
Scott Main4b5da682010-10-21 11:49:12 -07002619 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002620 * @param uri The uri that is being checked.
2621 * @param modeFlags The type of access to grant. May be one or both of
2622 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2623 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2624 * @param message A message to include in the exception if it is thrown.
2625 *
2626 * @see #checkCallingOrSelfUriPermission(Uri, int)
2627 */
2628 public abstract void enforceCallingOrSelfUriPermission(
2629 Uri uri, int modeFlags, String message);
2630
2631 /**
2632 * Enforce both a Uri and normal permission. This allows you to perform
2633 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one
2634 * call.
Scott Main4b5da682010-10-21 11:49:12 -07002635 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002636 * @param uri The Uri whose permission is to be checked, or null to not
2637 * do this check.
2638 * @param readPermission The permission that provides overall read access,
2639 * or null to not do this check.
2640 * @param writePermission The permission that provides overall write
2641 * acess, or null to not do this check.
2642 * @param pid The process ID being checked against. Must be &gt; 0.
2643 * @param uid The user ID being checked against. A uid of 0 is the root
2644 * user, which will pass every permission check.
2645 * @param modeFlags The type of access to grant. May be one or both of
2646 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2647 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2648 * @param message A message to include in the exception if it is thrown.
2649 *
2650 * @see #checkUriPermission(Uri, String, String, int, int, int)
2651 */
2652 public abstract void enforceUriPermission(
2653 Uri uri, String readPermission, String writePermission,
2654 int pid, int uid, int modeFlags, String message);
2655
2656 /**
2657 * Flag for use with {@link #createPackageContext}: include the application
2658 * code with the context. This means loading code into the caller's
2659 * process, so that {@link #getClassLoader()} can be used to instantiate
2660 * the application's classes. Setting this flags imposes security
2661 * restrictions on what application context you can access; if the
2662 * requested application can not be safely loaded into your process,
2663 * java.lang.SecurityException will be thrown. If this flag is not set,
2664 * there will be no restrictions on the packages that can be loaded,
2665 * but {@link #getClassLoader} will always return the default system
2666 * class loader.
2667 */
2668 public static final int CONTEXT_INCLUDE_CODE = 0x00000001;
2669
2670 /**
2671 * Flag for use with {@link #createPackageContext}: ignore any security
2672 * restrictions on the Context being requested, allowing it to always
2673 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code
2674 * to be loaded into a process even when it isn't safe to do so. Use
2675 * with extreme care!
2676 */
2677 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002;
Scott Main4b5da682010-10-21 11:49:12 -07002678
Romain Guy870e09f2009-07-06 16:35:25 -07002679 /**
2680 * Flag for use with {@link #createPackageContext}: a restricted context may
2681 * disable specific features. For instance, a View associated with a restricted
2682 * context would ignore particular XML attributes.
2683 */
2684 public static final int CONTEXT_RESTRICTED = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002685
2686 /**
2687 * Return a new Context object for the given application name. This
2688 * Context is the same as what the named application gets when it is
2689 * launched, containing the same resources and class loader. Each call to
2690 * this method returns a new instance of a Context object; Context objects
2691 * are not shared, however they share common state (Resources, ClassLoader,
2692 * etc) so the Context instance itself is fairly lightweight.
2693 *
2694 * <p>Throws {@link PackageManager.NameNotFoundException} if there is no
2695 * application with the given package name.
2696 *
2697 * <p>Throws {@link java.lang.SecurityException} if the Context requested
2698 * can not be loaded into the caller's process for security reasons (see
2699 * {@link #CONTEXT_INCLUDE_CODE} for more information}.
2700 *
2701 * @param packageName Name of the application's package.
2702 * @param flags Option flags, one of {@link #CONTEXT_INCLUDE_CODE}
2703 * or {@link #CONTEXT_IGNORE_SECURITY}.
2704 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002705 * @return A {@link Context} for the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002706 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002707 * @throws SecurityException &nbsp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002708 * @throws PackageManager.NameNotFoundException if there is no application with
John Spurlock6098c5d2013-06-17 10:32:46 -04002709 * the given package name.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002710 */
2711 public abstract Context createPackageContext(String packageName,
2712 int flags) throws PackageManager.NameNotFoundException;
Romain Guy870e09f2009-07-06 16:35:25 -07002713
2714 /**
Jeff Sharkey6d515712012-09-20 16:06:08 -07002715 * Similar to {@link #createPackageContext(String, int)}, but with a
2716 * different {@link UserHandle}. For example, {@link #getContentResolver()}
2717 * will open any {@link Uri} as the given user.
2718 *
2719 * @hide
2720 */
2721 public abstract Context createPackageContextAsUser(
2722 String packageName, int flags, UserHandle user)
2723 throws PackageManager.NameNotFoundException;
2724
2725 /**
Jim Millera75a8832013-02-07 16:53:32 -08002726 * Get the userId associated with this context
2727 * @return user id
2728 *
2729 * @hide
2730 */
2731 public abstract int getUserId();
2732
2733 /**
Dianne Hackborn756220b2012-08-14 16:45:30 -07002734 * Return a new Context object for the current Context but whose resources
2735 * are adjusted to match the given Configuration. Each call to this method
Jeff Browna492c3a2012-08-23 19:48:44 -07002736 * returns a new instance of a Context object; Context objects are not
Dianne Hackborn756220b2012-08-14 16:45:30 -07002737 * shared, however common state (ClassLoader, other Resources for the
2738 * same configuration) may be so the Context itself can be fairly lightweight.
2739 *
2740 * @param overrideConfiguration A {@link Configuration} specifying what
2741 * values to modify in the base Configuration of the original Context's
2742 * resources. If the base configuration changes (such as due to an
2743 * orientation change), the resources of this context will also change except
2744 * for those that have been explicitly overridden with a value here.
2745 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002746 * @return A {@link Context} with the given configuration override.
Dianne Hackborn756220b2012-08-14 16:45:30 -07002747 */
2748 public abstract Context createConfigurationContext(Configuration overrideConfiguration);
2749
2750 /**
Jeff Browna492c3a2012-08-23 19:48:44 -07002751 * Return a new Context object for the current Context but whose resources
2752 * are adjusted to match the metrics of the given Display. Each call to this method
2753 * returns a new instance of a Context object; Context objects are not
2754 * shared, however common state (ClassLoader, other Resources for the
2755 * same configuration) may be so the Context itself can be fairly lightweight.
2756 *
2757 * The returned display Context provides a {@link WindowManager}
2758 * (see {@link #getSystemService(String)}) that is configured to show windows
2759 * on the given display. The WindowManager's {@link WindowManager#getDefaultDisplay}
2760 * method can be used to retrieve the Display from the returned Context.
2761 *
2762 * @param display A {@link Display} object specifying the display
2763 * for whose metrics the Context's resources should be tailored and upon which
2764 * new windows should be shown.
2765 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002766 * @return A {@link Context} for the display.
Jeff Browna492c3a2012-08-23 19:48:44 -07002767 */
2768 public abstract Context createDisplayContext(Display display);
2769
2770 /**
Craig Mautner48d0d182013-06-11 07:53:06 -07002771 * Gets the display adjustments holder for this context. This information
2772 * is provided on a per-application or activity basis and is used to simulate lower density
2773 * display metrics for legacy applications and restricted screen sizes.
Jeff Brown98365d72012-08-19 20:30:52 -07002774 *
Jeff Browna492c3a2012-08-23 19:48:44 -07002775 * @param displayId The display id for which to get compatibility info.
Jeff Brown98365d72012-08-19 20:30:52 -07002776 * @return The compatibility info holder, or null if not required by the application.
2777 * @hide
2778 */
Craig Mautner48d0d182013-06-11 07:53:06 -07002779 public abstract DisplayAdjustments getDisplayAdjustments(int displayId);
Jeff Brown98365d72012-08-19 20:30:52 -07002780
2781 /**
Romain Guy870e09f2009-07-06 16:35:25 -07002782 * Indicates whether this Context is restricted.
Scott Main4b5da682010-10-21 11:49:12 -07002783 *
John Spurlock6098c5d2013-06-17 10:32:46 -04002784 * @return {@code true} if this Context is restricted, {@code false} otherwise.
Scott Main4b5da682010-10-21 11:49:12 -07002785 *
Romain Guy870e09f2009-07-06 16:35:25 -07002786 * @see #CONTEXT_RESTRICTED
2787 */
2788 public boolean isRestricted() {
2789 return false;
2790 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002791}