blob: fca1d55f4462ad20ca40b0cc3c7d4ab207edc4a7 [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;
22import android.content.res.Resources;
23import android.content.res.TypedArray;
Vasu Nori74f170f2010-06-01 18:06:18 -070024import android.database.DatabaseErrorHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.database.sqlite.SQLiteDatabase;
26import android.database.sqlite.SQLiteDatabase.CursorFactory;
27import android.graphics.Bitmap;
28import android.graphics.drawable.Drawable;
Adam Powellac695c62010-07-20 18:19:27 -070029import android.media.MediaScannerConnection.OnScanCompletedListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.net.Uri;
31import android.os.Bundle;
32import android.os.Handler;
33import android.os.Looper;
34import android.util.AttributeSet;
35
36import java.io.File;
37import java.io.FileInputStream;
38import java.io.FileNotFoundException;
39import java.io.FileOutputStream;
40import java.io.IOException;
41import java.io.InputStream;
42
43/**
44 * Interface to global information about an application environment. This is
45 * an abstract class whose implementation is provided by
46 * the Android system. It
47 * allows access to application-specific resources and classes, as well as
48 * up-calls for application-level operations such as launching activities,
49 * broadcasting and receiving intents, etc.
50 */
51public abstract class Context {
52 /**
53 * File creation mode: the default mode, where the created file can only
54 * be accessed by the calling application (or all applications sharing the
55 * same user ID).
56 * @see #MODE_WORLD_READABLE
57 * @see #MODE_WORLD_WRITEABLE
58 */
59 public static final int MODE_PRIVATE = 0x0000;
60 /**
61 * File creation mode: allow all other applications to have read access
62 * to the created file.
63 * @see #MODE_PRIVATE
64 * @see #MODE_WORLD_WRITEABLE
65 */
66 public static final int MODE_WORLD_READABLE = 0x0001;
67 /**
68 * File creation mode: allow all other applications to have write access
69 * to the created file.
70 * @see #MODE_PRIVATE
71 * @see #MODE_WORLD_READABLE
72 */
73 public static final int MODE_WORLD_WRITEABLE = 0x0002;
74 /**
75 * File creation mode: for use with {@link #openFileOutput}, if the file
76 * already exists then write data to the end of the existing file
77 * instead of erasing it.
78 * @see #openFileOutput
79 */
80 public static final int MODE_APPEND = 0x8000;
81
82 /**
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -080083 * SharedPreference loading flag: when set, the file on disk will
84 * be checked for modification even if the shared preferences
85 * instance is already loaded in this process. This behavior is
86 * sometimes desired in cases where the application has multiple
87 * processes, all writing to the same SharedPreferences file.
88 * Generally there are better forms of communication between
89 * processes, though.
90 *
91 * <p>This was the legacy (but undocumented) behavior in and
92 * before Gingerbread (Android 2.3) and this flag is implied when
93 * targetting such releases. For applications targetting SDK
94 * versions <em>greater than</em> Android 2.3, this flag must be
95 * explicitly set if desired.
96 *
97 * @see #getSharedPreferences
98 */
99 public static final int MODE_MULTI_PROCESS = 0x0004;
100
101 /**
Jeff Brown47847f32012-03-22 19:13:11 -0700102 * Database open flag: when set, the database is opened with write-ahead
103 * logging enabled by default.
104 *
105 * @see #openOrCreateDatabase(String, int, CursorFactory)
106 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
107 * @see SQLiteDatabase#enableWriteAheadLogging
108 */
109 public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008;
110
111 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800112 * Flag for {@link #bindService}: automatically create the service as long
113 * as the binding exists. Note that while this will create the service,
Scott Main4b5da682010-10-21 11:49:12 -0700114 * its {@link android.app.Service#onStartCommand}
115 * method will still only be called due to an
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800116 * explicit call to {@link #startService}. Even without that, though,
117 * this still provides you with access to the service object while the
118 * service is created.
119 *
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700120 * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH},
121 * not supplying this flag would also impact how important the system
122 * consider's the target service's process to be. When set, the only way
123 * for it to be raised was by binding from a service in which case it will
124 * only be important when that activity is in the foreground. Now to
125 * achieve this behavior you must explicitly supply the new flag
126 * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications
127 * that don't specify {@link #BIND_AUTO_CREATE} will automatically have
128 * the flags {@link #BIND_WAIVE_PRIORITY} and
129 * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve
130 * the same result.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800131 */
132 public static final int BIND_AUTO_CREATE = 0x0001;
133
134 /**
135 * Flag for {@link #bindService}: include debugging help for mismatched
136 * calls to unbind. When this flag is set, the callstack of the following
137 * {@link #unbindService} call is retained, to be printed if a later
138 * incorrect unbind call is made. Note that doing this requires retaining
139 * information about the binding that was made for the lifetime of the app,
140 * resulting in a leak -- this should only be used for debugging.
141 */
142 public static final int BIND_DEBUG_UNBIND = 0x0002;
143
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800144 /**
145 * Flag for {@link #bindService}: don't allow this binding to raise
146 * the target service's process to the foreground scheduling priority.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700147 * It will still be raised to at least the same memory priority
Dianne Hackborn09c916b2009-12-08 14:50:51 -0800148 * as the client (so that its process will not be killable in any
149 * situation where the client is not killable), but for CPU scheduling
150 * purposes it may be left in the background. This only has an impact
151 * in the situation where the binding client is a foreground process
152 * and the target service is in a background process.
153 */
154 public static final int BIND_NOT_FOREGROUND = 0x0004;
155
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700156 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700157 * Flag for {@link #bindService}: indicates that the client application
158 * binding to this service considers the service to be more important than
159 * the app itself. When set, the platform will try to have the out of
160 * memory kill the app before it kills the service it is bound to, though
161 * this is not guaranteed to be the case.
162 */
163 public static final int BIND_ABOVE_CLIENT = 0x0008;
164
165 /**
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700166 * Flag for {@link #bindService}: allow the process hosting the bound
167 * service to go through its normal memory management. It will be
168 * treated more like a running service, allowing the system to
169 * (temporarily) expunge the process if low on memory or for some other
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700170 * whim it may have, and being more aggressive about making it a candidate
171 * to be killed (and restarted) if running for a long time.
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700172 */
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700173 public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010;
174
175 /**
176 * Flag for {@link #bindService}: don't impact the scheduling or
177 * memory management priority of the target service's hosting process.
178 * Allows the service's process to be managed on the background LRU list
179 * just like a regular application process in the background.
180 */
181 public static final int BIND_WAIVE_PRIORITY = 0x0020;
182
183 /**
184 * Flag for {@link #bindService}: this service is very important to
185 * the client, so should be brought to the foreground process level
186 * when the client is. Normally a process can only be raised to the
187 * visibility level by a client, even if that client is in the foreground.
188 */
189 public static final int BIND_IMPORTANT = 0x0040;
190
191 /**
192 * Flag for {@link #bindService}: If binding from an activity, allow the
193 * target service's process importance to be raised based on whether the
194 * activity is visible to the user, regardless whether another flag is
195 * used to reduce the amount that the client process's overall importance
196 * is used to impact it.
197 */
Dianne Hackborn2c84cfc2011-10-31 15:39:59 -0700198 public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080;
199
200 /**
201 * Flag for {@link #bindService}: Don't consider the bound service to be
202 * visible, even if the caller is visible.
203 * @hide
204 */
205 public static final int BIND_NOT_VISIBLE = 0x40000000;
Dianne Hackborn130b0d22011-07-26 22:07:48 -0700206
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800207 /** Return an AssetManager instance for your application's package. */
208 public abstract AssetManager getAssets();
209
210 /** Return a Resources instance for your application's package. */
211 public abstract Resources getResources();
212
213 /** Return PackageManager instance to find global package information. */
214 public abstract PackageManager getPackageManager();
215
216 /** Return a ContentResolver instance for your application's package. */
217 public abstract ContentResolver getContentResolver();
218
219 /**
220 * Return the Looper for the main thread of the current process. This is
221 * the thread used to dispatch calls to application components (activities,
222 * services, etc).
223 */
224 public abstract Looper getMainLooper();
Scott Main4b5da682010-10-21 11:49:12 -0700225
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226 /**
227 * Return the context of the single, global Application object of the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800228 * current process. This generally should only be used if you need a
229 * Context whose lifecycle is separate from the current context, that is
230 * tied to the lifetime of the process rather than the current component.
Scott Main4b5da682010-10-21 11:49:12 -0700231 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800232 * <p>Consider for example how this interacts with
Brad Fitzpatrick36af7942010-12-08 11:31:07 -0800233 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}:
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800234 * <ul>
235 * <li> <p>If used from an Activity context, the receiver is being registered
236 * within that activity. This means that you are expected to unregister
237 * before the activity is done being destroyed; in fact if you do not do
238 * so, the framework will clean up your leaked registration as it removes
239 * the activity and log an error. Thus, if you use the Activity context
240 * to register a receiver that is static (global to the process, not
241 * associated with an Activity instance) then that registration will be
242 * removed on you at whatever point the activity you used is destroyed.
243 * <li> <p>If used from the Context returned here, the receiver is being
244 * registered with the global state associated with your application. Thus
245 * it will never be unregistered for you. This is necessary if the receiver
246 * is associated with static data, not a particular component. However
247 * using the ApplicationContext elsewhere can easily lead to serious leaks
248 * if you forget to unregister, unbind, etc.
249 * </ul>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800250 */
251 public abstract Context getApplicationContext();
252
253 /**
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700254 * Add a new {@link ComponentCallbacks} to the base application of the
255 * Context, which will be called at the same times as the ComponentCallbacks
256 * methods of activities and other components are called. Note that you
257 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when
258 * appropriate in the future; this will not be removed for you.
Dianne Hackborn905577f2011-09-07 18:31:28 -0700259 *
260 * @param callback The interface to call. This can be either a
261 * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface.
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700262 */
263 public void registerComponentCallbacks(ComponentCallbacks callback) {
264 getApplicationContext().registerComponentCallbacks(callback);
265 }
266
267 /**
268 * Remove a {@link ComponentCallbacks} objec that was previously registered
269 * with {@link #registerComponentCallbacks(ComponentCallbacks)}.
270 */
271 public void unregisterComponentCallbacks(ComponentCallbacks callback) {
272 getApplicationContext().unregisterComponentCallbacks(callback);
273 }
274
275 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800276 * Return a localized, styled CharSequence from the application's package's
277 * default string table.
278 *
279 * @param resId Resource id for the CharSequence text
280 */
281 public final CharSequence getText(int resId) {
282 return getResources().getText(resId);
283 }
284
285 /**
286 * Return a localized string from the application's package's
287 * default string table.
288 *
289 * @param resId Resource id for the string
290 */
291 public final String getString(int resId) {
292 return getResources().getString(resId);
293 }
294
295 /**
296 * Return a localized formatted string from the application's package's
297 * default string table, substituting the format arguments as defined in
298 * {@link java.util.Formatter} and {@link java.lang.String#format}.
299 *
300 * @param resId Resource id for the format string
301 * @param formatArgs The format arguments that will be used for substitution.
302 */
303
304 public final String getString(int resId, Object... formatArgs) {
305 return getResources().getString(resId, formatArgs);
306 }
307
308 /**
309 * Set the base theme for this context. Note that this should be called
310 * before any views are instantiated in the Context (for example before
311 * calling {@link android.app.Activity#setContentView} or
312 * {@link android.view.LayoutInflater#inflate}).
313 *
314 * @param resid The style resource describing the theme.
315 */
316 public abstract void setTheme(int resid);
317
Dianne Hackborn247fe742011-01-08 17:25:57 -0800318 /** @hide Needed for some internal implementation... not public because
319 * you can't assume this actually means anything. */
320 public int getThemeResId() {
321 return 0;
322 }
323
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800324 /**
325 * Return the Theme object associated with this Context.
326 */
327 public abstract Resources.Theme getTheme();
328
329 /**
330 * Retrieve styled attribute information in this Context's theme. See
331 * {@link Resources.Theme#obtainStyledAttributes(int[])}
332 * for more information.
333 *
334 * @see Resources.Theme#obtainStyledAttributes(int[])
335 */
336 public final TypedArray obtainStyledAttributes(
337 int[] attrs) {
338 return getTheme().obtainStyledAttributes(attrs);
339 }
340
341 /**
342 * Retrieve styled attribute information in this Context's theme. See
343 * {@link Resources.Theme#obtainStyledAttributes(int, int[])}
344 * for more information.
345 *
346 * @see Resources.Theme#obtainStyledAttributes(int, int[])
347 */
348 public final TypedArray obtainStyledAttributes(
349 int resid, int[] attrs) throws Resources.NotFoundException {
350 return getTheme().obtainStyledAttributes(resid, attrs);
351 }
352
353 /**
354 * Retrieve styled attribute information in this Context's theme. See
355 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
356 * for more information.
357 *
358 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
359 */
360 public final TypedArray obtainStyledAttributes(
361 AttributeSet set, int[] attrs) {
362 return getTheme().obtainStyledAttributes(set, attrs, 0, 0);
363 }
364
365 /**
366 * Retrieve styled attribute information in this Context's theme. See
367 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)}
368 * for more information.
369 *
370 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
371 */
372 public final TypedArray obtainStyledAttributes(
373 AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) {
374 return getTheme().obtainStyledAttributes(
375 set, attrs, defStyleAttr, defStyleRes);
376 }
377
378 /**
379 * Return a class loader you can use to retrieve classes in this package.
380 */
381 public abstract ClassLoader getClassLoader();
382
383 /** Return the name of this application's package. */
384 public abstract String getPackageName();
385
Dianne Hackborn5c1e00b2009-06-18 17:10:57 -0700386 /** Return the full application info for this context's package. */
387 public abstract ApplicationInfo getApplicationInfo();
Scott Main4b5da682010-10-21 11:49:12 -0700388
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800389 /**
Kenny Root32148392010-01-21 15:40:47 -0800390 * Return the full path to this context's primary Android package.
391 * The Android package is a ZIP file which contains the application's
392 * primary resources.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800393 *
394 * <p>Note: this is not generally useful for applications, since they should
395 * not be directly accessing the file system.
396 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800397 * @return String Path to the resources.
398 */
399 public abstract String getPackageResourcePath();
400
401 /**
Kenny Root32148392010-01-21 15:40:47 -0800402 * Return the full path to this context's primary Android package.
403 * The Android package is a ZIP file which contains application's
404 * primary code and assets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800405 *
406 * <p>Note: this is not generally useful for applications, since they should
407 * not be directly accessing the file system.
408 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800409 * @return String Path to the code and assets.
410 */
411 public abstract String getPackageCodePath();
412
413 /**
Joe Onorato23ecae32009-06-10 17:07:15 -0700414 * {@hide}
415 * Return the full path to the shared prefs file for the given prefs group name.
416 *
417 * <p>Note: this is not generally useful for applications, since they should
418 * not be directly accessing the file system.
419 */
420 public abstract File getSharedPrefsFile(String name);
421
422 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800423 * Retrieve and hold the contents of the preferences file 'name', returning
424 * a SharedPreferences through which you can retrieve and modify its
425 * values. Only one instance of the SharedPreferences object is returned
426 * to any callers for the same name, meaning they will see each other's
427 * edits as soon as they are made.
428 *
429 * @param name Desired preferences file. If a preferences file by this name
430 * does not exist, it will be created when you retrieve an
431 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
432 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
433 * default operation, {@link #MODE_WORLD_READABLE}
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800434 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. The bit
435 * {@link #MODE_MULTI_PROCESS} can also be used if multiple processes
436 * are mutating the same SharedPreferences file. {@link #MODE_MULTI_PROCESS}
437 * is always on in apps targetting Gingerbread (Android 2.3) and below, and
438 * off by default in later versions.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800439 *
440 * @return Returns the single SharedPreferences instance that can be used
441 * to retrieve and modify the preference values.
442 *
443 * @see #MODE_PRIVATE
444 * @see #MODE_WORLD_READABLE
445 * @see #MODE_WORLD_WRITEABLE
Brad Fitzpatrick4e920f72010-12-14 11:52:13 -0800446 * @see #MODE_MULTI_PROCESS
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800447 */
448 public abstract SharedPreferences getSharedPreferences(String name,
449 int mode);
450
451 /**
452 * Open a private file associated with this Context's application package
453 * for reading.
454 *
455 * @param name The name of the file to open; can not contain path
456 * separators.
457 *
458 * @return FileInputStream Resulting input stream.
459 *
460 * @see #openFileOutput
461 * @see #fileList
462 * @see #deleteFile
463 * @see java.io.FileInputStream#FileInputStream(String)
464 */
465 public abstract FileInputStream openFileInput(String name)
466 throws FileNotFoundException;
467
468 /**
469 * Open a private file associated with this Context's application package
470 * for writing. Creates the file if it doesn't already exist.
471 *
472 * @param name The name of the file to open; can not contain path
473 * separators.
474 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
475 * default operation, {@link #MODE_APPEND} to append to an existing file,
476 * {@link #MODE_WORLD_READABLE} and {@link #MODE_WORLD_WRITEABLE} to control
477 * permissions.
478 *
479 * @return FileOutputStream Resulting output stream.
480 *
481 * @see #MODE_APPEND
482 * @see #MODE_PRIVATE
483 * @see #MODE_WORLD_READABLE
484 * @see #MODE_WORLD_WRITEABLE
485 * @see #openFileInput
486 * @see #fileList
487 * @see #deleteFile
488 * @see java.io.FileOutputStream#FileOutputStream(String)
489 */
490 public abstract FileOutputStream openFileOutput(String name, int mode)
491 throws FileNotFoundException;
492
493 /**
494 * Delete the given private file associated with this Context's
495 * application package.
496 *
497 * @param name The name of the file to delete; can not contain path
498 * separators.
499 *
500 * @return True if the file was successfully deleted; else
501 * false.
502 *
503 * @see #openFileInput
504 * @see #openFileOutput
505 * @see #fileList
506 * @see java.io.File#delete()
507 */
508 public abstract boolean deleteFile(String name);
509
510 /**
511 * Returns the absolute path on the filesystem where a file created with
512 * {@link #openFileOutput} is stored.
513 *
514 * @param name The name of the file for which you would like to get
515 * its path.
516 *
517 * @return Returns an absolute path to the given file.
518 *
519 * @see #openFileOutput
520 * @see #getFilesDir
521 * @see #getDir
522 */
523 public abstract File getFileStreamPath(String name);
524
525 /**
526 * Returns the absolute path to the directory on the filesystem where
527 * files created with {@link #openFileOutput} are stored.
528 *
529 * @return Returns the path of the directory holding application files.
530 *
531 * @see #openFileOutput
532 * @see #getFileStreamPath
533 * @see #getDir
534 */
535 public abstract File getFilesDir();
Scott Main4b5da682010-10-21 11:49:12 -0700536
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 /**
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800538 * Returns the absolute path to the directory on the external filesystem
539 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory()
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700540 * Environment.getExternalStorageDirectory()}) where the application can
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800541 * place persistent files it owns. These files are private to the
542 * applications, and not typically visible to the user as media.
Scott Main4b5da682010-10-21 11:49:12 -0700543 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800544 * <p>This is like {@link #getFilesDir()} in that these
545 * files will be deleted when the application is uninstalled, however there
546 * are some important differences:
Scott Main4b5da682010-10-21 11:49:12 -0700547 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800548 * <ul>
549 * <li>External files are not always available: they will disappear if the
550 * user mounts the external storage on a computer or removes it. See the
551 * APIs on {@link android.os.Environment} for information in the storage state.
552 * <li>There is no security enforced with these files. All applications
553 * can read and write files placed here.
554 * </ul>
Scott Main4b5da682010-10-21 11:49:12 -0700555 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800556 * <p>Here is an example of typical code to manipulate a file in
557 * an application's private storage:</p>
Scott Main4b5da682010-10-21 11:49:12 -0700558 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800559 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
560 * private_file}
561 *
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700562 * <p>If you supply a non-null <var>type</var> to this function, the returned
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800563 * file will be a path to a sub-directory of the given type. Though these files
564 * are not automatically scanned by the media scanner, you can explicitly
565 * add them to the media database with
566 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[],
Ray Chenb7c8c762010-03-30 17:21:39 -0700567 * OnScanCompletedListener) MediaScannerConnection.scanFile}.
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800568 * Note that this is not the same as
569 * {@link android.os.Environment#getExternalStoragePublicDirectory
570 * Environment.getExternalStoragePublicDirectory()}, which provides
571 * directories of media shared by all applications. The
572 * directories returned here are
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700573 * owned by the application, and their contents will be removed when the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800574 * application is uninstalled. Unlike
575 * {@link android.os.Environment#getExternalStoragePublicDirectory
576 * Environment.getExternalStoragePublicDirectory()}, the directory
577 * returned here will be automatically created for you.
Scott Main4b5da682010-10-21 11:49:12 -0700578 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800579 * <p>Here is an example of typical code to manipulate a picture in
580 * an application's private storage and add it to the media database:</p>
Scott Main4b5da682010-10-21 11:49:12 -0700581 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800582 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java
583 * private_picture}
Scott Main4b5da682010-10-21 11:49:12 -0700584 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800585 * @param type The type of files directory to return. May be null for
586 * the root of the files directory or one of
587 * the following Environment constants for a subdirectory:
588 * {@link android.os.Environment#DIRECTORY_MUSIC},
589 * {@link android.os.Environment#DIRECTORY_PODCASTS},
590 * {@link android.os.Environment#DIRECTORY_RINGTONES},
591 * {@link android.os.Environment#DIRECTORY_ALARMS},
592 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS},
593 * {@link android.os.Environment#DIRECTORY_PICTURES}, or
594 * {@link android.os.Environment#DIRECTORY_MOVIES}.
Scott Main4b5da682010-10-21 11:49:12 -0700595 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800596 * @return Returns the path of the directory holding application files
597 * on external storage. Returns null if external storage is not currently
598 * mounted so it could not ensure the path exists; you will need to call
599 * this method again when it is available.
600 *
601 * @see #getFilesDir
Dianne Hackbornacaf0282010-03-30 14:39:35 -0700602 * @see android.os.Environment#getExternalStoragePublicDirectory
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800603 */
604 public abstract File getExternalFilesDir(String type);
Scott Main4b5da682010-10-21 11:49:12 -0700605
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800606 /**
Dianne Hackborn805fd7e2011-01-16 18:30:29 -0800607 * Return the directory where this application's OBB files (if there
608 * are any) can be found. Note if the application does not have any OBB
609 * files, this directory may not exist.
610 */
611 public abstract File getObbDir();
612
613 /**
Scott Main4b5da682010-10-21 11:49:12 -0700614 * Returns the absolute path to the application specific cache directory
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800615 * on the filesystem. These files will be ones that get deleted first when the
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800616 * device runs low on storage.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800617 * There is no guarantee when these files will be deleted.
Scott Main4b5da682010-10-21 11:49:12 -0700618 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800619 * <strong>Note: you should not <em>rely</em> on the system deleting these
620 * files for you; you should always have a reasonable maximum, such as 1 MB,
621 * for the amount of space you consume with cache files, and prune those
622 * files when exceeding that space.</strong>
Scott Main4b5da682010-10-21 11:49:12 -0700623 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800624 * @return Returns the path of the directory holding application cache files.
625 *
626 * @see #openFileOutput
627 * @see #getFileStreamPath
628 * @see #getDir
629 */
630 public abstract File getCacheDir();
631
632 /**
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800633 * Returns the absolute path to the directory on the external filesystem
634 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory()
635 * Environment.getExternalStorageDirectory()} where the application can
636 * place cache files it owns.
Scott Main4b5da682010-10-21 11:49:12 -0700637 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800638 * <p>This is like {@link #getCacheDir()} in that these
639 * files will be deleted when the application is uninstalled, however there
640 * are some important differences:
Scott Main4b5da682010-10-21 11:49:12 -0700641 *
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800642 * <ul>
643 * <li>The platform does not monitor the space available in external storage,
644 * and thus will not automatically delete these files. Note that you should
645 * be managing the maximum space you will use for these anyway, just like
646 * with {@link #getCacheDir()}.
647 * <li>External files are not always available: they will disappear if the
648 * user mounts the external storage on a computer or removes it. See the
649 * APIs on {@link android.os.Environment} for information in the storage state.
650 * <li>There is no security enforced with these files. All applications
651 * can read and write files placed here.
652 * </ul>
653 *
654 * @return Returns the path of the directory holding application cache files
655 * on external storage. Returns null if external storage is not currently
656 * mounted so it could not ensure the path exists; you will need to call
657 * this method again when it is available.
658 *
659 * @see #getCacheDir
660 */
661 public abstract File getExternalCacheDir();
Scott Main4b5da682010-10-21 11:49:12 -0700662
Dianne Hackborne83cefce2010-02-04 17:38:14 -0800663 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800664 * Returns an array of strings naming the private files associated with
665 * this Context's application package.
666 *
667 * @return Array of strings naming the private files.
668 *
669 * @see #openFileInput
670 * @see #openFileOutput
671 * @see #deleteFile
672 */
673 public abstract String[] fileList();
674
675 /**
676 * Retrieve, creating if needed, a new directory in which the application
677 * can place its own custom data files. You can use the returned File
678 * object to create and access files in this directory. Note that files
679 * created through a File object will only be accessible by your own
680 * application; you can only set the mode of the entire directory, not
681 * of individual files.
682 *
683 * @param name Name of the directory to retrieve. This is a directory
684 * that is created as part of your application data.
685 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
686 * default operation, {@link #MODE_WORLD_READABLE} and
687 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
688 *
689 * @return Returns a File object for the requested directory. The directory
690 * will have been created if it does not already exist.
691 *
692 * @see #openFileOutput(String, int)
693 */
694 public abstract File getDir(String name, int mode);
695
696 /**
697 * Open a new private SQLiteDatabase associated with this Context's
698 * application package. Create the database file if it doesn't exist.
699 *
700 * @param name The name (unique in the application package) of the database.
701 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
702 * default operation, {@link #MODE_WORLD_READABLE}
703 * and {@link #MODE_WORLD_WRITEABLE} to control permissions.
Jeff Brown47847f32012-03-22 19:13:11 -0700704 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800705 * @param factory An optional factory class that is called to instantiate a
706 * cursor when query is called.
707 *
708 * @return The contents of a newly created database with the given name.
709 * @throws android.database.sqlite.SQLiteException if the database file could not be opened.
710 *
711 * @see #MODE_PRIVATE
712 * @see #MODE_WORLD_READABLE
713 * @see #MODE_WORLD_WRITEABLE
Jeff Brown47847f32012-03-22 19:13:11 -0700714 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800715 * @see #deleteDatabase
716 */
717 public abstract SQLiteDatabase openOrCreateDatabase(String name,
718 int mode, CursorFactory factory);
719
720 /**
Vasu Nori74f170f2010-06-01 18:06:18 -0700721 * Open a new private SQLiteDatabase associated with this Context's
722 * application package. Creates the database file if it doesn't exist.
723 *
724 * <p>Accepts input param: a concrete instance of {@link DatabaseErrorHandler} to be
725 * used to handle corruption when sqlite reports database corruption.</p>
726 *
727 * @param name The name (unique in the application package) of the database.
728 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the
729 * default operation, {@link #MODE_WORLD_READABLE}
730 * and {@link #MODE_WORLD_WRITEABLE} to control permissions.
Jeff Brown47847f32012-03-22 19:13:11 -0700731 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default.
Vasu Nori74f170f2010-06-01 18:06:18 -0700732 * @param factory An optional factory class that is called to instantiate a
733 * cursor when query is called.
734 * @param errorHandler the {@link DatabaseErrorHandler} to be used when sqlite reports database
Vasu Nori03acd512010-06-03 14:39:40 -0700735 * corruption. if null, {@link android.database.DefaultDatabaseErrorHandler} is assumed.
Vasu Nori74f170f2010-06-01 18:06:18 -0700736 * @return The contents of a newly created database with the given name.
737 * @throws android.database.sqlite.SQLiteException if the database file could not be opened.
738 *
739 * @see #MODE_PRIVATE
740 * @see #MODE_WORLD_READABLE
741 * @see #MODE_WORLD_WRITEABLE
Jeff Brown47847f32012-03-22 19:13:11 -0700742 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING
Vasu Nori74f170f2010-06-01 18:06:18 -0700743 * @see #deleteDatabase
744 */
745 public abstract SQLiteDatabase openOrCreateDatabase(String name,
746 int mode, CursorFactory factory, DatabaseErrorHandler errorHandler);
747
748 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800749 * Delete an existing private SQLiteDatabase associated with this Context's
750 * application package.
751 *
752 * @param name The name (unique in the application package) of the
753 * database.
754 *
755 * @return True if the database was successfully deleted; else false.
756 *
757 * @see #openOrCreateDatabase
758 */
759 public abstract boolean deleteDatabase(String name);
760
761 /**
762 * Returns the absolute path on the filesystem where a database created with
763 * {@link #openOrCreateDatabase} is stored.
764 *
765 * @param name The name of the database for which you would like to get
766 * its path.
767 *
768 * @return Returns an absolute path to the given database.
769 *
770 * @see #openOrCreateDatabase
771 */
772 public abstract File getDatabasePath(String name);
773
774 /**
775 * Returns an array of strings naming the private databases associated with
776 * this Context's application package.
777 *
778 * @return Array of strings naming the private databases.
779 *
780 * @see #openOrCreateDatabase
781 * @see #deleteDatabase
782 */
783 public abstract String[] databaseList();
784
785 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700786 * @deprecated Use {@link android.app.WallpaperManager#getDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700787 * WallpaperManager.get()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800788 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700789 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800790 public abstract Drawable getWallpaper();
791
792 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700793 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700794 * WallpaperManager.peek()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800795 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700796 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800797 public abstract Drawable peekWallpaper();
798
799 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700800 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth()
801 * WallpaperManager.getDesiredMinimumWidth()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800802 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700803 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800804 public abstract int getWallpaperDesiredMinimumWidth();
805
806 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700807 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight()
808 * WallpaperManager.getDesiredMinimumHeight()} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800809 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700810 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800811 public abstract int getWallpaperDesiredMinimumHeight();
812
813 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700814 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700815 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700816 * <p>This method requires the caller to hold the permission
817 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800818 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700819 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800820 public abstract void setWallpaper(Bitmap bitmap) throws IOException;
821
822 /**
Dianne Hackborn4c62fc02009-08-08 20:40:27 -0700823 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream)
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700824 * WallpaperManager.set()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700825 * <p>This method requires the caller to hold the permission
826 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800827 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700828 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800829 public abstract void setWallpaper(InputStream data) throws IOException;
830
831 /**
Dianne Hackborn8cc6a502009-08-05 21:29:42 -0700832 * @deprecated Use {@link android.app.WallpaperManager#clear
833 * WallpaperManager.clear()} instead.
Nicolas Falliere9530e3a2012-06-18 17:21:06 -0700834 * <p>This method requires the caller to hold the permission
835 * {@link android.Manifest.permission#SET_WALLPAPER}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800836 */
Dianne Hackborn4a51c202009-08-21 15:14:02 -0700837 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800838 public abstract void clearWallpaper() throws IOException;
839
840 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -0700841 * Same as {@link #startActivity(Intent, Bundle)} with no options
842 * specified.
843 *
844 * @param intent The description of the activity to start.
845 *
846 * @throws ActivityNotFoundException
847 *
848 * @see {@link #startActivity(Intent, Bundle)}
849 * @see PackageManager#resolveActivity
850 */
851 public abstract void startActivity(Intent intent);
852
853 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800854 * Launch a new activity. You will not receive any information about when
855 * the activity exits.
856 *
857 * <p>Note that if this method is being called from outside of an
858 * {@link android.app.Activity} Context, then the Intent must include
859 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because,
860 * without being started from an existing Activity, there is no existing
861 * task in which to place the new activity and thus it needs to be placed
862 * in its own separate task.
863 *
864 * <p>This method throws {@link ActivityNotFoundException}
865 * if there was no Activity found to run the given Intent.
866 *
867 * @param intent The description of the activity to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -0700868 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -0700869 * May be null if there are no options. See {@link android.app.ActivityOptions}
870 * for how to build the Bundle supplied here; there are no supported definitions
871 * for building it manually.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800872 *
873 * @throws ActivityNotFoundException
874 *
Scott Main60dd5202012-06-23 00:01:22 -0700875 * @see #startActivity(Intent)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800876 * @see PackageManager#resolveActivity
877 */
Dianne Hackborna4972e92012-03-14 10:38:05 -0700878 public abstract void startActivity(Intent intent, Bundle options);
879
880 /**
881 * Same as {@link #startActivities(Intent[], Bundle)} with no options
882 * specified.
883 *
884 * @param intents An array of Intents to be started.
885 *
886 * @throws ActivityNotFoundException
887 *
888 * @see {@link #startActivities(Intent[], Bundle)}
889 * @see PackageManager#resolveActivity
890 */
891 public abstract void startActivities(Intent[] intents);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800892
893 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -0800894 * Launch multiple new activities. This is generally the same as calling
895 * {@link #startActivity(Intent)} for the first Intent in the array,
896 * that activity during its creation calling {@link #startActivity(Intent)}
897 * for the second entry, etc. Note that unlike that approach, generally
898 * none of the activities except the last in the array will be created
899 * at this point, but rather will be created when the user first visits
900 * them (due to pressing back from the activity on top).
901 *
902 * <p>This method throws {@link ActivityNotFoundException}
903 * if there was no Activity found for <em>any</em> given Intent. In this
904 * case the state of the activity stack is undefined (some Intents in the
905 * list may be on it, some not), so you probably want to avoid such situations.
906 *
907 * @param intents An array of Intents to be started.
Dianne Hackborna4972e92012-03-14 10:38:05 -0700908 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -0700909 * See {@link android.content.Context#startActivity(Intent, Bundle)
910 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborn621e17d2010-11-22 15:59:56 -0800911 *
912 * @throws ActivityNotFoundException
913 *
Dianne Hackborna4972e92012-03-14 10:38:05 -0700914 * @see {@link #startActivities(Intent[])}
Dianne Hackborn621e17d2010-11-22 15:59:56 -0800915 * @see PackageManager#resolveActivity
916 */
Dianne Hackborna4972e92012-03-14 10:38:05 -0700917 public abstract void startActivities(Intent[] intents, Bundle options);
Dianne Hackborn621e17d2010-11-22 15:59:56 -0800918
919 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -0700920 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)}
921 * with no options specified.
922 *
923 * @param intent The IntentSender to launch.
924 * @param fillInIntent If non-null, this will be provided as the
925 * intent parameter to {@link IntentSender#sendIntent}.
926 * @param flagsMask Intent flags in the original IntentSender that you
927 * would like to change.
928 * @param flagsValues Desired values for any bits set in
929 * <var>flagsMask</var>
930 * @param extraFlags Always set to 0.
931 *
932 * @see #startActivity(Intent)
933 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle)
934 */
935 public abstract void startIntentSender(IntentSender intent,
936 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
937 throws IntentSender.SendIntentException;
938
939 /**
940 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender
Dianne Hackbornfa82f222009-09-17 15:14:12 -0700941 * to start. If the IntentSender is for an activity, that activity will be started
Dianne Hackbornae22c052009-09-17 18:46:22 -0700942 * as if you had called the regular {@link #startActivity(Intent)}
Dianne Hackbornfa82f222009-09-17 15:14:12 -0700943 * here; otherwise, its associated action will be executed (such as
944 * sending a broadcast) as if you had called
945 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Scott Main4b5da682010-10-21 11:49:12 -0700946 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -0700947 * @param intent The IntentSender to launch.
948 * @param fillInIntent If non-null, this will be provided as the
949 * intent parameter to {@link IntentSender#sendIntent}.
950 * @param flagsMask Intent flags in the original IntentSender that you
951 * would like to change.
952 * @param flagsValues Desired values for any bits set in
953 * <var>flagsMask</var>
954 * @param extraFlags Always set to 0.
Dianne Hackborna4972e92012-03-14 10:38:05 -0700955 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -0700956 * See {@link android.content.Context#startActivity(Intent, Bundle)
957 * Context.startActivity(Intent, Bundle)} for more details. If options
958 * have also been supplied by the IntentSender, options given here will
959 * override any that conflict with those given by the IntentSender.
Dianne Hackborna4972e92012-03-14 10:38:05 -0700960 *
961 * @see #startActivity(Intent, Bundle)
962 * @see #startIntentSender(IntentSender, Intent, int, int, int)
Dianne Hackbornfa82f222009-09-17 15:14:12 -0700963 */
964 public abstract void startIntentSender(IntentSender intent,
Dianne Hackborna4972e92012-03-14 10:38:05 -0700965 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags,
966 Bundle options) throws IntentSender.SendIntentException;
Dianne Hackbornfa82f222009-09-17 15:14:12 -0700967
968 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800969 * Broadcast the given intent to all interested BroadcastReceivers. This
970 * call is asynchronous; it returns immediately, and you will continue
971 * executing while the receivers are run. No results are propagated from
972 * receivers and receivers can not abort the broadcast. If you want
973 * to allow receivers to propagate results or abort the broadcast, you must
974 * send an ordered broadcast using
975 * {@link #sendOrderedBroadcast(Intent, String)}.
976 *
977 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
978 *
979 * @param intent The Intent to broadcast; all receivers matching this
980 * Intent will receive the broadcast.
981 *
982 * @see android.content.BroadcastReceiver
983 * @see #registerReceiver
984 * @see #sendBroadcast(Intent, String)
985 * @see #sendOrderedBroadcast(Intent, String)
986 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
987 */
988 public abstract void sendBroadcast(Intent intent);
989
990 /**
991 * Broadcast the given intent to all interested BroadcastReceivers, allowing
992 * an optional required permission to be enforced. This
993 * call is asynchronous; it returns immediately, and you will continue
994 * executing while the receivers are run. No results are propagated from
995 * receivers and receivers can not abort the broadcast. If you want
996 * to allow receivers to propagate results or abort the broadcast, you must
997 * send an ordered broadcast using
998 * {@link #sendOrderedBroadcast(Intent, String)}.
999 *
1000 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1001 *
1002 * @param intent The Intent to broadcast; all receivers matching this
1003 * Intent will receive the broadcast.
Brad Fitzpatrick26b71be2010-12-07 14:52:58 -08001004 * @param receiverPermission (optional) String naming a permission that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001005 * a receiver must hold in order to receive your broadcast.
1006 * If null, no permission is required.
1007 *
1008 * @see android.content.BroadcastReceiver
1009 * @see #registerReceiver
1010 * @see #sendBroadcast(Intent)
1011 * @see #sendOrderedBroadcast(Intent, String)
1012 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1013 */
1014 public abstract void sendBroadcast(Intent intent,
1015 String receiverPermission);
1016
1017 /**
1018 * Broadcast the given intent to all interested BroadcastReceivers, delivering
1019 * them one at a time to allow more preferred receivers to consume the
1020 * broadcast before it is delivered to less preferred receivers. This
1021 * call is asynchronous; it returns immediately, and you will continue
1022 * executing while the receivers are run.
1023 *
1024 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1025 *
1026 * @param intent The Intent to broadcast; all receivers matching this
1027 * Intent will receive the broadcast.
1028 * @param receiverPermission (optional) String naming a permissions that
1029 * a receiver must hold in order to receive your broadcast.
1030 * If null, no permission is required.
1031 *
1032 * @see android.content.BroadcastReceiver
1033 * @see #registerReceiver
1034 * @see #sendBroadcast(Intent)
1035 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1036 */
1037 public abstract void sendOrderedBroadcast(Intent intent,
1038 String receiverPermission);
1039
1040 /**
1041 * Version of {@link #sendBroadcast(Intent)} that allows you to
1042 * receive data back from the broadcast. This is accomplished by
1043 * supplying your own BroadcastReceiver when calling, which will be
1044 * treated as a final receiver at the end of the broadcast -- its
1045 * {@link BroadcastReceiver#onReceive} method will be called with
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001046 * the result values collected from the other receivers. The broadcast will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001047 * be serialized in the same way as calling
1048 * {@link #sendOrderedBroadcast(Intent, String)}.
1049 *
1050 * <p>Like {@link #sendBroadcast(Intent)}, this method is
1051 * asynchronous; it will return before
1052 * resultReceiver.onReceive() is called.
1053 *
1054 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1055 *
1056 * @param intent The Intent to broadcast; all receivers matching this
1057 * Intent will receive the broadcast.
1058 * @param receiverPermission String naming a permissions that
1059 * a receiver must hold in order to receive your broadcast.
1060 * If null, no permission is required.
1061 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1062 * receiver of the broadcast.
1063 * @param scheduler A custom Handler with which to schedule the
1064 * resultReceiver callback; if null it will be
1065 * scheduled in the Context's main thread.
1066 * @param initialCode An initial value for the result code. Often
1067 * Activity.RESULT_OK.
1068 * @param initialData An initial value for the result data. Often
1069 * null.
1070 * @param initialExtras An initial value for the result extras. Often
1071 * null.
1072 *
1073 * @see #sendBroadcast(Intent)
1074 * @see #sendBroadcast(Intent, String)
1075 * @see #sendOrderedBroadcast(Intent, String)
1076 * @see #sendStickyBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001077 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001078 * @see android.content.BroadcastReceiver
1079 * @see #registerReceiver
1080 * @see android.app.Activity#RESULT_OK
1081 */
1082 public abstract void sendOrderedBroadcast(Intent intent,
1083 String receiverPermission, BroadcastReceiver resultReceiver,
1084 Handler scheduler, int initialCode, String initialData,
1085 Bundle initialExtras);
1086
1087 /**
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001088 * Same as {@link #sendBroadcast(Intent)}, but for a specific user. This broadcast
1089 * can only be sent to receivers that are part of the calling application. It
1090 * requires holding the {@link android.Manifest.permission#INTERACT_ACROSS_USERS}
1091 * permission.
1092 * @param intent The intent to broadcast
1093 * @param userHandle User to send the intent to.
1094 * @see #sendBroadcast(Intent)
1095 */
1096 public abstract void sendBroadcastToUser(Intent intent, int userHandle);
1097
1098 /**
1099 * Same as
1100 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)},
1101 * but for a specific user. This broadcast
1102 * can only be sent to receivers that are part of the calling application. It
1103 * requires holding the {@link android.Manifest.permission#INTERACT_ACROSS_USERS}
1104 * permission.
1105 *
1106 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1107 *
1108 * @param intent The Intent to broadcast; all receivers matching this
1109 * Intent will receive the broadcast.
1110 * @param userHandle User to send the intent to.
1111 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1112 * receiver of the broadcast.
1113 * @param scheduler A custom Handler with which to schedule the
1114 * resultReceiver callback; if null it will be
1115 * scheduled in the Context's main thread.
1116 * @param initialCode An initial value for the result code. Often
1117 * Activity.RESULT_OK.
1118 * @param initialData An initial value for the result data. Often
1119 * null.
1120 * @param initialExtras An initial value for the result extras. Often
1121 * null.
1122 *
1123 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
1124 */
1125 public abstract void sendOrderedBroadcastToUser(Intent intent, int userHandle,
1126 BroadcastReceiver resultReceiver, Handler scheduler,
1127 int initialCode, String initialData, Bundle initialExtras);
1128
1129 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001130 * Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the
1131 * Intent you are sending stays around after the broadcast is complete,
1132 * so that others can quickly retrieve that data through the return
1133 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In
1134 * all other ways, this behaves the same as
1135 * {@link #sendBroadcast(Intent)}.
1136 *
1137 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
1138 * permission in order to use this API. If you do not hold that
1139 * permission, {@link SecurityException} will be thrown.
1140 *
1141 * @param intent The Intent to broadcast; all receivers matching this
1142 * Intent will receive the broadcast, and the Intent will be held to
1143 * be re-broadcast to future receivers.
1144 *
1145 * @see #sendBroadcast(Intent)
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001146 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001147 */
1148 public abstract void sendStickyBroadcast(Intent intent);
Scott Main4b5da682010-10-21 11:49:12 -07001149
Dianne Hackbornefa199f2009-09-19 12:03:15 -07001150 /**
1151 * Version of {@link #sendStickyBroadcast} that allows you to
1152 * receive data back from the broadcast. This is accomplished by
1153 * supplying your own BroadcastReceiver when calling, which will be
1154 * treated as a final receiver at the end of the broadcast -- its
1155 * {@link BroadcastReceiver#onReceive} method will be called with
1156 * the result values collected from the other receivers. The broadcast will
1157 * be serialized in the same way as calling
1158 * {@link #sendOrderedBroadcast(Intent, String)}.
1159 *
1160 * <p>Like {@link #sendBroadcast(Intent)}, this method is
1161 * asynchronous; it will return before
1162 * resultReceiver.onReceive() is called. Note that the sticky data
1163 * stored is only the data you initially supply to the broadcast, not
1164 * the result of any changes made by the receivers.
1165 *
1166 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1167 *
1168 * @param intent The Intent to broadcast; all receivers matching this
1169 * Intent will receive the broadcast.
1170 * @param resultReceiver Your own BroadcastReceiver to treat as the final
1171 * receiver of the broadcast.
1172 * @param scheduler A custom Handler with which to schedule the
1173 * resultReceiver callback; if null it will be
1174 * scheduled in the Context's main thread.
1175 * @param initialCode An initial value for the result code. Often
1176 * Activity.RESULT_OK.
1177 * @param initialData An initial value for the result data. Often
1178 * null.
1179 * @param initialExtras An initial value for the result extras. Often
1180 * null.
1181 *
1182 * @see #sendBroadcast(Intent)
1183 * @see #sendBroadcast(Intent, String)
1184 * @see #sendOrderedBroadcast(Intent, String)
1185 * @see #sendStickyBroadcast(Intent)
1186 * @see android.content.BroadcastReceiver
1187 * @see #registerReceiver
1188 * @see android.app.Activity#RESULT_OK
1189 */
1190 public abstract void sendStickyOrderedBroadcast(Intent intent,
1191 BroadcastReceiver resultReceiver,
1192 Handler scheduler, int initialCode, String initialData,
1193 Bundle initialExtras);
1194
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001195
1196 /**
1197 * Remove the data previously sent with {@link #sendStickyBroadcast},
1198 * so that it is as if the sticky broadcast had never happened.
1199 *
1200 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY}
1201 * permission in order to use this API. If you do not hold that
1202 * permission, {@link SecurityException} will be thrown.
1203 *
1204 * @param intent The Intent that was previously broadcast.
1205 *
1206 * @see #sendStickyBroadcast
1207 */
1208 public abstract void removeStickyBroadcast(Intent intent);
1209
1210 /**
Chris Tatea34df8a22009-04-02 23:15:58 -07001211 * Register a BroadcastReceiver to be run in the main activity thread. The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001212 * <var>receiver</var> will be called with any broadcast Intent that
1213 * matches <var>filter</var>, in the main application thread.
1214 *
1215 * <p>The system may broadcast Intents that are "sticky" -- these stay
1216 * around after the broadcast as finished, to be sent to any later
1217 * registrations. If your IntentFilter matches one of these sticky
1218 * Intents, that Intent will be returned by this function
1219 * <strong>and</strong> sent to your <var>receiver</var> as if it had just
1220 * been broadcast.
1221 *
1222 * <p>There may be multiple sticky Intents that match <var>filter</var>,
1223 * in which case each of these will be sent to <var>receiver</var>. In
1224 * this case, only one of these can be returned directly by the function;
1225 * which of these that is returned is arbitrarily decided by the system.
1226 *
1227 * <p>If you know the Intent your are registering for is sticky, you can
1228 * supply null for your <var>receiver</var>. In this case, no receiver is
1229 * registered -- the function simply returns the sticky Intent that
1230 * matches <var>filter</var>. In the case of multiple matches, the same
1231 * rules as described above apply.
1232 *
1233 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1234 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07001235 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
1236 * registered with this method will correctly respect the
1237 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
1238 * Prior to that, it would be ignored and delivered to all matching registered
1239 * receivers. Be careful if using this for security.</p>
1240 *
Chris Tatea34df8a22009-04-02 23:15:58 -07001241 * <p class="note">Note: this method <em>cannot be called from a
1242 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver
1243 * that is declared in an application's manifest. It is okay, however, to call
1244 * this method from another BroadcastReceiver that has itself been registered
1245 * at run time with {@link #registerReceiver}, since the lifetime of such a
1246 * registered BroadcastReceiver is tied to the object that registered it.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001247 *
1248 * @param receiver The BroadcastReceiver to handle the broadcast.
1249 * @param filter Selects the Intent broadcasts to be received.
1250 *
1251 * @return The first sticky intent found that matches <var>filter</var>,
1252 * or null if there are none.
1253 *
1254 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
1255 * @see #sendBroadcast
1256 * @see #unregisterReceiver
1257 */
1258 public abstract Intent registerReceiver(BroadcastReceiver receiver,
1259 IntentFilter filter);
1260
1261 /**
1262 * Register to receive intent broadcasts, to run in the context of
1263 * <var>scheduler</var>. See
1264 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more
1265 * information. This allows you to enforce permissions on who can
1266 * broadcast intents to your receiver, or have the receiver run in
1267 * a different thread than the main application thread.
1268 *
1269 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts.
1270 *
Dianne Hackborn6c418d52011-06-29 14:05:33 -07001271 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers
1272 * registered with this method will correctly respect the
1273 * {@link Intent#setPackage(String)} specified for an Intent being broadcast.
1274 * Prior to that, it would be ignored and delivered to all matching registered
1275 * receivers. Be careful if using this for security.</p>
1276 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001277 * @param receiver The BroadcastReceiver to handle the broadcast.
1278 * @param filter Selects the Intent broadcasts to be received.
1279 * @param broadcastPermission String naming a permissions that a
1280 * broadcaster must hold in order to send an Intent to you. If null,
1281 * no permission is required.
1282 * @param scheduler Handler identifying the thread that will receive
1283 * the Intent. If null, the main thread of the process will be used.
1284 *
1285 * @return The first sticky intent found that matches <var>filter</var>,
1286 * or null if there are none.
1287 *
1288 * @see #registerReceiver(BroadcastReceiver, IntentFilter)
1289 * @see #sendBroadcast
1290 * @see #unregisterReceiver
1291 */
1292 public abstract Intent registerReceiver(BroadcastReceiver receiver,
1293 IntentFilter filter,
1294 String broadcastPermission,
1295 Handler scheduler);
1296
1297 /**
1298 * Unregister a previously registered BroadcastReceiver. <em>All</em>
1299 * filters that have been registered for this BroadcastReceiver will be
1300 * removed.
1301 *
1302 * @param receiver The BroadcastReceiver to unregister.
1303 *
1304 * @see #registerReceiver
1305 */
1306 public abstract void unregisterReceiver(BroadcastReceiver receiver);
1307
1308 /**
1309 * Request that a given application service be started. The Intent
1310 * can either contain the complete class name of a specific service
1311 * implementation to start, or an abstract definition through the
1312 * action and other fields of the kind of service to start. If this service
1313 * is not already running, it will be instantiated and started (creating a
1314 * process for it if needed); if it is running then it remains running.
1315 *
1316 * <p>Every call to this method will result in a corresponding call to
Scott Main4b5da682010-10-21 11:49:12 -07001317 * the target service's {@link android.app.Service#onStartCommand} method,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001318 * with the <var>intent</var> given here. This provides a convenient way
1319 * to submit jobs to a service without having to bind and call on to its
1320 * interface.
1321 *
1322 * <p>Using startService() overrides the default service lifetime that is
1323 * managed by {@link #bindService}: it requires the service to remain
1324 * running until {@link #stopService} is called, regardless of whether
1325 * any clients are connected to it. Note that calls to startService()
1326 * are not nesting: no matter how many times you call startService(),
1327 * a single call to {@link #stopService} will stop it.
1328 *
1329 * <p>The system attempts to keep running services around as much as
1330 * possible. The only time they should be stopped is if the current
1331 * foreground application is using so many resources that the service needs
1332 * to be killed. If any errors happen in the service's process, it will
1333 * automatically be restarted.
1334 *
1335 * <p>This function will throw {@link SecurityException} if you do not
1336 * have permission to start the given service.
1337 *
1338 * @param service Identifies the service to be started. The Intent may
1339 * specify either an explicit component name to start, or a logical
1340 * description (action, category, etc) to match an
1341 * {@link IntentFilter} published by a service. Additional values
1342 * may be included in the Intent extras to supply arguments along with
1343 * this specific start call.
1344 *
1345 * @return If the service is being started or is already running, the
1346 * {@link ComponentName} of the actual service that was started is
1347 * returned; else if the service does not exist null is returned.
1348 *
1349 * @throws SecurityException
1350 *
1351 * @see #stopService
1352 * @see #bindService
1353 */
1354 public abstract ComponentName startService(Intent service);
1355
1356 /**
1357 * Request that a given application service be stopped. If the service is
1358 * not running, nothing happens. Otherwise it is stopped. Note that calls
1359 * to startService() are not counted -- this stops the service no matter
1360 * how many times it was started.
1361 *
1362 * <p>Note that if a stopped service still has {@link ServiceConnection}
1363 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will
1364 * not be destroyed until all of these bindings are removed. See
1365 * the {@link android.app.Service} documentation for more details on a
1366 * service's lifecycle.
1367 *
1368 * <p>This function will throw {@link SecurityException} if you do not
1369 * have permission to stop the given service.
1370 *
1371 * @param service Description of the service to be stopped. The Intent may
1372 * specify either an explicit component name to start, or a logical
1373 * description (action, category, etc) to match an
1374 * {@link IntentFilter} published by a service.
1375 *
1376 * @return If there is a service matching the given Intent that is already
1377 * running, then it is stopped and true is returned; else false is returned.
1378 *
1379 * @throws SecurityException
1380 *
1381 * @see #startService
1382 */
1383 public abstract boolean stopService(Intent service);
1384
1385 /**
1386 * Connect to an application service, creating it if needed. This defines
1387 * a dependency between your application and the service. The given
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001388 * <var>conn</var> will receive the service object when it is created and be
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001389 * told if it dies and restarts. The service will be considered required
1390 * by the system only for as long as the calling context exists. For
1391 * example, if this Context is an Activity that is stopped, the service will
1392 * not be required to continue running until the Activity is resumed.
1393 *
1394 * <p>This function will throw {@link SecurityException} if you do not
1395 * have permission to bind to the given service.
1396 *
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001397 * <p class="note">Note: this method <em>can not be called from a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001398 * {@link BroadcastReceiver} component</em>. A pattern you can use to
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001399 * communicate from a BroadcastReceiver to a Service is to call
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001400 * {@link #startService} with the arguments containing the command to be
1401 * sent, with the service calling its
1402 * {@link android.app.Service#stopSelf(int)} method when done executing
1403 * that command. See the API demo App/Service/Service Start Arguments
1404 * Controller for an illustration of this. It is okay, however, to use
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001405 * this method from a BroadcastReceiver that has been registered with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001406 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver
1407 * is tied to another object (the one that registered it).</p>
1408 *
1409 * @param service Identifies the service to connect to. The Intent may
1410 * specify either an explicit component name, or a logical
1411 * description (action, category, etc) to match an
1412 * {@link IntentFilter} published by a service.
1413 * @param conn Receives information as the service is started and stopped.
Christopher Tate79b33172012-06-18 14:54:21 -07001414 * This must be a valid ServiceConnection object; it must not be null.
Scott Main4b5da682010-10-21 11:49:12 -07001415 * @param flags Operation options for the binding. May be 0,
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001416 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND},
1417 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT},
1418 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, or
1419 * {@link #BIND_WAIVE_PRIORITY}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001420 * @return If you have successfully bound to the service, true is returned;
1421 * false is returned if the connection is not made so you will not
1422 * receive the service object.
1423 *
1424 * @throws SecurityException
1425 *
1426 * @see #unbindService
1427 * @see #startService
1428 * @see #BIND_AUTO_CREATE
Scott Main4b5da682010-10-21 11:49:12 -07001429 * @see #BIND_DEBUG_UNBIND
1430 * @see #BIND_NOT_FOREGROUND
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001431 */
1432 public abstract boolean bindService(Intent service, ServiceConnection conn,
1433 int flags);
1434
1435 /**
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001436 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle
Amith Yamasani37ce3a82012-02-06 12:04:42 -08001437 * argument for use by system server and other multi-user aware code.
1438 * @hide
1439 */
Dianne Hackborn7d19e022012-08-07 19:12:33 -07001440 public boolean bindService(Intent service, ServiceConnection conn, int flags, int userHandle) {
Amith Yamasani37ce3a82012-02-06 12:04:42 -08001441 throw new RuntimeException("Not implemented. Must override in a subclass.");
1442 }
1443
1444 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001445 * Disconnect from an application service. You will no longer receive
1446 * calls as the service is restarted, and the service is now allowed to
1447 * stop at any time.
1448 *
1449 * @param conn The connection interface previously supplied to
Christopher Tate79b33172012-06-18 14:54:21 -07001450 * bindService(). This parameter must not be null.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001451 *
1452 * @see #bindService
1453 */
1454 public abstract void unbindService(ServiceConnection conn);
1455
1456 /**
1457 * Start executing an {@link android.app.Instrumentation} class. The given
1458 * Instrumentation component will be run by killing its target application
1459 * (if currently running), starting the target process, instantiating the
1460 * instrumentation component, and then letting it drive the application.
1461 *
1462 * <p>This function is not synchronous -- it returns as soon as the
1463 * instrumentation has started and while it is running.
1464 *
1465 * <p>Instrumentation is normally only allowed to run against a package
1466 * that is either unsigned or signed with a signature that the
1467 * the instrumentation package is also signed with (ensuring the target
1468 * trusts the instrumentation).
1469 *
1470 * @param className Name of the Instrumentation component to be run.
1471 * @param profileFile Optional path to write profiling data as the
1472 * instrumentation runs, or null for no profiling.
1473 * @param arguments Additional optional arguments to pass to the
1474 * instrumentation, or null.
1475 *
1476 * @return Returns true if the instrumentation was successfully started,
1477 * else false if it could not be found.
1478 */
1479 public abstract boolean startInstrumentation(ComponentName className,
1480 String profileFile, Bundle arguments);
1481
1482 /**
1483 * Return the handle to a system-level service by name. The class of the
1484 * returned object varies by the requested name. Currently available names
1485 * are:
Scott Main4b5da682010-10-21 11:49:12 -07001486 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001487 * <dl>
1488 * <dt> {@link #WINDOW_SERVICE} ("window")
1489 * <dd> The top-level window manager in which you can place custom
1490 * windows. The returned object is a {@link android.view.WindowManager}.
1491 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater")
1492 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources
1493 * in this context.
1494 * <dt> {@link #ACTIVITY_SERVICE} ("activity")
1495 * <dd> A {@link android.app.ActivityManager} for interacting with the
1496 * global activity state of the system.
1497 * <dt> {@link #POWER_SERVICE} ("power")
1498 * <dd> A {@link android.os.PowerManager} for controlling power
1499 * management.
1500 * <dt> {@link #ALARM_SERVICE} ("alarm")
1501 * <dd> A {@link android.app.AlarmManager} for receiving intents at the
1502 * time of your choosing.
1503 * <dt> {@link #NOTIFICATION_SERVICE} ("notification")
1504 * <dd> A {@link android.app.NotificationManager} for informing the user
1505 * of background events.
1506 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard")
1507 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard.
1508 * <dt> {@link #LOCATION_SERVICE} ("location")
1509 * <dd> A {@link android.location.LocationManager} for controlling location
1510 * (e.g., GPS) updates.
1511 * <dt> {@link #SEARCH_SERVICE} ("search")
1512 * <dd> A {@link android.app.SearchManager} for handling search.
1513 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator")
1514 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator
1515 * hardware.
1516 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection")
1517 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for
1518 * handling management of network connections.
1519 * <dt> {@link #WIFI_SERVICE} ("wifi")
1520 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of
1521 * Wi-Fi connectivity.
1522 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method")
1523 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager}
1524 * for management of input methods.
Tobias Haamel53332882010-02-18 16:15:43 -08001525 * <dt> {@link #UI_MODE_SERVICE} ("uimode")
1526 * <dd> An {@link android.app.UiModeManager} for controlling UI modes.
Steve Howard7083c422010-07-28 16:01:23 -07001527 * <dt> {@link #DOWNLOAD_SERVICE} ("download")
Steve Howardd58429f2010-09-27 16:32:39 -07001528 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001529 * </dl>
Scott Main4b5da682010-10-21 11:49:12 -07001530 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001531 * <p>Note: System services obtained via this API may be closely associated with
1532 * the Context in which they are obtained from. In general, do not share the
1533 * service objects between various different contexts (Activities, Applications,
1534 * Services, Providers, etc.)
1535 *
1536 * @param name The name of the desired service.
Scott Main4b5da682010-10-21 11:49:12 -07001537 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001538 * @return The service or null if the name does not exist.
Scott Main4b5da682010-10-21 11:49:12 -07001539 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001540 * @see #WINDOW_SERVICE
1541 * @see android.view.WindowManager
1542 * @see #LAYOUT_INFLATER_SERVICE
1543 * @see android.view.LayoutInflater
1544 * @see #ACTIVITY_SERVICE
1545 * @see android.app.ActivityManager
1546 * @see #POWER_SERVICE
1547 * @see android.os.PowerManager
1548 * @see #ALARM_SERVICE
1549 * @see android.app.AlarmManager
1550 * @see #NOTIFICATION_SERVICE
1551 * @see android.app.NotificationManager
1552 * @see #KEYGUARD_SERVICE
1553 * @see android.app.KeyguardManager
1554 * @see #LOCATION_SERVICE
1555 * @see android.location.LocationManager
1556 * @see #SEARCH_SERVICE
1557 * @see android.app.SearchManager
1558 * @see #SENSOR_SERVICE
1559 * @see android.hardware.SensorManager
San Mehatc9d81752010-02-01 10:23:27 -08001560 * @see #STORAGE_SERVICE
San Mehatb1043402010-02-05 08:26:50 -08001561 * @see android.os.storage.StorageManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001562 * @see #VIBRATOR_SERVICE
1563 * @see android.os.Vibrator
1564 * @see #CONNECTIVITY_SERVICE
1565 * @see android.net.ConnectivityManager
1566 * @see #WIFI_SERVICE
1567 * @see android.net.wifi.WifiManager
1568 * @see #AUDIO_SERVICE
1569 * @see android.media.AudioManager
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07001570 * @see #MEDIA_ROUTER_SERVICE
1571 * @see android.media.MediaRouter
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001572 * @see #TELEPHONY_SERVICE
1573 * @see android.telephony.TelephonyManager
1574 * @see #INPUT_METHOD_SERVICE
1575 * @see android.view.inputmethod.InputMethodManager
Tobias Haamel53332882010-02-18 16:15:43 -08001576 * @see #UI_MODE_SERVICE
1577 * @see android.app.UiModeManager
Steve Howard7083c422010-07-28 16:01:23 -07001578 * @see #DOWNLOAD_SERVICE
Steve Howardd58429f2010-09-27 16:32:39 -07001579 * @see android.app.DownloadManager
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001580 */
1581 public abstract Object getSystemService(String name);
1582
1583 /**
1584 * Use with {@link #getSystemService} to retrieve a
1585 * {@link android.os.PowerManager} for controlling power management,
1586 * including "wake locks," which let you keep the device on while
1587 * you're running long tasks.
1588 */
1589 public static final String POWER_SERVICE = "power";
Scott Main4b5da682010-10-21 11:49:12 -07001590
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 /**
1592 * Use with {@link #getSystemService} to retrieve a
1593 * {@link android.view.WindowManager} for accessing the system's window
1594 * manager.
1595 *
1596 * @see #getSystemService
1597 * @see android.view.WindowManager
1598 */
1599 public static final String WINDOW_SERVICE = "window";
Scott Main4b5da682010-10-21 11:49:12 -07001600
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001601 /**
1602 * Use with {@link #getSystemService} to retrieve a
1603 * {@link android.view.LayoutInflater} for inflating layout resources in this
1604 * context.
1605 *
1606 * @see #getSystemService
1607 * @see android.view.LayoutInflater
1608 */
1609 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
Scott Main4b5da682010-10-21 11:49:12 -07001610
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001611 /**
1612 * Use with {@link #getSystemService} to retrieve a
Fred Quintana60307342009-03-24 22:48:12 -07001613 * {@link android.accounts.AccountManager} for receiving intents at a
1614 * time of your choosing.
Fred Quintana60307342009-03-24 22:48:12 -07001615 *
1616 * @see #getSystemService
1617 * @see android.accounts.AccountManager
1618 */
1619 public static final String ACCOUNT_SERVICE = "account";
Scott Main4b5da682010-10-21 11:49:12 -07001620
Fred Quintana60307342009-03-24 22:48:12 -07001621 /**
1622 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001623 * {@link android.app.ActivityManager} for interacting with the global
1624 * system state.
1625 *
1626 * @see #getSystemService
1627 * @see android.app.ActivityManager
1628 */
1629 public static final String ACTIVITY_SERVICE = "activity";
Scott Main4b5da682010-10-21 11:49:12 -07001630
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001631 /**
1632 * Use with {@link #getSystemService} to retrieve a
1633 * {@link android.app.AlarmManager} for receiving intents at a
1634 * time of your choosing.
1635 *
1636 * @see #getSystemService
1637 * @see android.app.AlarmManager
1638 */
1639 public static final String ALARM_SERVICE = "alarm";
Scott Main4b5da682010-10-21 11:49:12 -07001640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001641 /**
1642 * Use with {@link #getSystemService} to retrieve a
1643 * {@link android.app.NotificationManager} for informing the user of
1644 * background events.
1645 *
1646 * @see #getSystemService
1647 * @see android.app.NotificationManager
1648 */
1649 public static final String NOTIFICATION_SERVICE = "notification";
Scott Main4b5da682010-10-21 11:49:12 -07001650
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001651 /**
1652 * Use with {@link #getSystemService} to retrieve a
svetoslavganov75986cf2009-05-14 22:28:01 -07001653 * {@link android.view.accessibility.AccessibilityManager} for giving the user
1654 * feedback for UI events through the registered event listeners.
1655 *
1656 * @see #getSystemService
1657 * @see android.view.accessibility.AccessibilityManager
1658 */
1659 public static final String ACCESSIBILITY_SERVICE = "accessibility";
Scott Main4b5da682010-10-21 11:49:12 -07001660
svetoslavganov75986cf2009-05-14 22:28:01 -07001661 /**
1662 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 * {@link android.app.NotificationManager} for controlling keyguard.
1664 *
1665 * @see #getSystemService
1666 * @see android.app.KeyguardManager
1667 */
1668 public static final String KEYGUARD_SERVICE = "keyguard";
Scott Main4b5da682010-10-21 11:49:12 -07001669
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001670 /**
1671 * Use with {@link #getSystemService} to retrieve a {@link
1672 * android.location.LocationManager} for controlling location
1673 * updates.
1674 *
1675 * @see #getSystemService
1676 * @see android.location.LocationManager
1677 */
1678 public static final String LOCATION_SERVICE = "location";
Bai Taoa58a8752010-07-13 15:32:16 +08001679
1680 /**
1681 * Use with {@link #getSystemService} to retrieve a
1682 * {@link android.location.CountryDetector} for detecting the country that
1683 * the user is in.
1684 *
1685 * @hide
1686 */
1687 public static final String COUNTRY_DETECTOR = "country_detector";
1688
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001689 /**
1690 * Use with {@link #getSystemService} to retrieve a {@link
1691 * android.app.SearchManager} for handling searches.
1692 *
1693 * @see #getSystemService
1694 * @see android.app.SearchManager
1695 */
1696 public static final String SEARCH_SERVICE = "search";
Scott Main4b5da682010-10-21 11:49:12 -07001697
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 /**
1699 * Use with {@link #getSystemService} to retrieve a {@link
1700 * android.hardware.SensorManager} for accessing sensors.
1701 *
1702 * @see #getSystemService
1703 * @see android.hardware.SensorManager
1704 */
1705 public static final String SENSOR_SERVICE = "sensor";
Scott Main4b5da682010-10-21 11:49:12 -07001706
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001707 /**
San Mehatc9d81752010-02-01 10:23:27 -08001708 * Use with {@link #getSystemService} to retrieve a {@link
Kenny Root02c87302010-07-01 08:10:18 -07001709 * android.os.storage.StorageManager} for accessing system storage
San Mehatc9d81752010-02-01 10:23:27 -08001710 * functions.
1711 *
1712 * @see #getSystemService
San Mehatb1043402010-02-05 08:26:50 -08001713 * @see android.os.storage.StorageManager
San Mehatc9d81752010-02-01 10:23:27 -08001714 */
1715 public static final String STORAGE_SERVICE = "storage";
1716
1717 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001718 * Use with {@link #getSystemService} to retrieve a
1719 * com.android.server.WallpaperService for accessing wallpapers.
1720 *
1721 * @see #getSystemService
1722 */
1723 public static final String WALLPAPER_SERVICE = "wallpaper";
Scott Main4b5da682010-10-21 11:49:12 -07001724
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001725 /**
1726 * Use with {@link #getSystemService} to retrieve a {@link
1727 * android.os.Vibrator} for interacting with the vibration hardware.
1728 *
1729 * @see #getSystemService
1730 * @see android.os.Vibrator
1731 */
1732 public static final String VIBRATOR_SERVICE = "vibrator";
Robert Greenwalt9e696c22010-04-01 14:45:18 -07001733
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001734 /**
1735 * Use with {@link #getSystemService} to retrieve a {@link
1736 * android.app.StatusBarManager} for interacting with the status bar.
1737 *
1738 * @see #getSystemService
1739 * @see android.app.StatusBarManager
1740 * @hide
1741 */
1742 public static final String STATUS_BAR_SERVICE = "statusbar";
1743
1744 /**
1745 * Use with {@link #getSystemService} to retrieve a {@link
1746 * android.net.ConnectivityManager} for handling management of
1747 * network connections.
1748 *
1749 * @see #getSystemService
1750 * @see android.net.ConnectivityManager
1751 */
1752 public static final String CONNECTIVITY_SERVICE = "connectivity";
1753
1754 /**
1755 * Use with {@link #getSystemService} to retrieve a {@link
Robert Greenwalt9e696c22010-04-01 14:45:18 -07001756 * android.net.ThrottleManager} for handling management of
1757 * throttling.
1758 *
1759 * @hide
1760 * @see #getSystemService
1761 * @see android.net.ThrottleManager
1762 */
1763 public static final String THROTTLE_SERVICE = "throttle";
1764
1765 /**
1766 * Use with {@link #getSystemService} to retrieve a {@link
Christopher Tate8662cab52012-02-23 14:59:36 -08001767 * android.os.IUpdateLock} for managing runtime sequences that
1768 * must not be interrupted by headless OTA application or similar.
1769 *
1770 * @hide
1771 * @see #getSystemService
1772 * @see android.os.UpdateLock
1773 */
1774 public static final String UPDATE_LOCK_SERVICE = "updatelock";
1775
1776 /**
1777 * Use with {@link #getSystemService} to retrieve a {@link
San Mehatd1df8ac2010-01-26 06:17:26 -08001778 * android.net.NetworkManagementService} for handling management of
1779 * system network services
1780 *
1781 * @hide
1782 * @see #getSystemService
1783 * @see android.net.NetworkManagementService
1784 */
1785 public static final String NETWORKMANAGEMENT_SERVICE = "network_management";
1786
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07001787 /** {@hide} */
Jeff Sharkey75279902011-05-24 18:39:45 -07001788 public static final String NETWORK_STATS_SERVICE = "netstats";
1789 /** {@hide} */
Jeff Sharkeyeedcb952011-05-17 14:55:15 -07001790 public static final String NETWORK_POLICY_SERVICE = "netpolicy";
1791
San Mehatd1df8ac2010-01-26 06:17:26 -08001792 /**
1793 * Use with {@link #getSystemService} to retrieve a {@link
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001794 * android.net.wifi.WifiManager} for handling management of
1795 * Wi-Fi access.
1796 *
1797 * @see #getSystemService
1798 * @see android.net.wifi.WifiManager
1799 */
1800 public static final String WIFI_SERVICE = "wifi";
Scott Main4b5da682010-10-21 11:49:12 -07001801
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001802 /**
repo sync55bc5f32011-06-24 14:23:07 -07001803 * Use with {@link #getSystemService} to retrieve a {@link
1804 * android.net.wifi.p2p.WifiP2pManager} for handling management of
Irfan Sheriff651cdfc2011-09-07 00:31:20 -07001805 * Wi-Fi peer-to-peer connections.
repo sync55bc5f32011-06-24 14:23:07 -07001806 *
1807 * @see #getSystemService
1808 * @see android.net.wifi.p2p.WifiP2pManager
repo sync55bc5f32011-06-24 14:23:07 -07001809 */
1810 public static final String WIFI_P2P_SERVICE = "wifip2p";
1811
1812 /**
Irfan Sheriff7d024d32012-03-22 17:01:39 -07001813 * Use with {@link #getSystemService} to retrieve a {@link
Irfan Sheriff60309fc2012-04-24 14:52:37 -07001814 * android.net.nsd.NsdManager} for handling management of network service
Irfan Sheriff7d024d32012-03-22 17:01:39 -07001815 * discovery
1816 *
Irfan Sheriff7d024d32012-03-22 17:01:39 -07001817 * @see #getSystemService
Irfan Sheriff60309fc2012-04-24 14:52:37 -07001818 * @see android.net.nsd.NsdManager
Irfan Sheriff7d024d32012-03-22 17:01:39 -07001819 */
1820 public static final String NSD_SERVICE = "servicediscovery";
1821
Irfan Sheriff7d024d32012-03-22 17:01:39 -07001822 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001823 * Use with {@link #getSystemService} to retrieve a
1824 * {@link android.media.AudioManager} for handling management of volume,
1825 * ringer modes and audio routing.
Scott Main4b5da682010-10-21 11:49:12 -07001826 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001827 * @see #getSystemService
1828 * @see android.media.AudioManager
1829 */
1830 public static final String AUDIO_SERVICE = "audio";
Scott Main4b5da682010-10-21 11:49:12 -07001831
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001832 /**
1833 * Use with {@link #getSystemService} to retrieve a
Dianne Hackbornb58b8f82012-06-11 15:08:39 -07001834 * {@link android.media.MediaRouter} for controlling and managing
1835 * routing of media.
1836 *
1837 * @see #getSystemService
1838 * @see android.media.MediaRouter
1839 */
1840 public static final String MEDIA_ROUTER_SERVICE = "media_router";
1841
1842 /**
1843 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001844 * {@link android.telephony.TelephonyManager} for handling management the
1845 * telephony features of the device.
Scott Main4b5da682010-10-21 11:49:12 -07001846 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001847 * @see #getSystemService
1848 * @see android.telephony.TelephonyManager
1849 */
1850 public static final String TELEPHONY_SERVICE = "phone";
1851
1852 /**
1853 * Use with {@link #getSystemService} to retrieve a
1854 * {@link android.text.ClipboardManager} for accessing and modifying
1855 * the contents of the global clipboard.
Scott Main4b5da682010-10-21 11:49:12 -07001856 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001857 * @see #getSystemService
1858 * @see android.text.ClipboardManager
1859 */
1860 public static final String CLIPBOARD_SERVICE = "clipboard";
1861
1862 /**
Scott Main4b5da682010-10-21 11:49:12 -07001863 * Use with {@link #getSystemService} to retrieve a
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001864 * {@link android.view.inputmethod.InputMethodManager} for accessing input
1865 * methods.
1866 *
1867 * @see #getSystemService
1868 */
1869 public static final String INPUT_METHOD_SERVICE = "input_method";
1870
1871 /**
1872 * Use with {@link #getSystemService} to retrieve a
satok988323c2011-06-22 16:38:13 +09001873 * {@link android.view.textservice.TextServicesManager} for accessing
1874 * text services.
1875 *
1876 * @see #getSystemService
1877 */
1878 public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices";
1879
1880 /**
1881 * Use with {@link #getSystemService} to retrieve a
Dan Egnore38d58b2009-12-30 19:29:03 -08001882 * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001883 *
1884 * @hide
1885 * @see #getSystemService
1886 */
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001887 public static final String APPWIDGET_SERVICE = "appwidget";
Dan Egnor95240272009-10-27 18:23:39 -07001888
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001889 /**
Christopher Tate487529a2009-04-29 14:03:25 -07001890 * Use with {@link #getSystemService} to retrieve an
Christopher Tate45281862010-03-05 15:46:30 -08001891 * {@link android.app.backup.IBackupManager IBackupManager} for communicating
Christopher Tate487529a2009-04-29 14:03:25 -07001892 * with the backup mechanism.
Dianne Hackborn7f205432009-07-28 00:13:47 -07001893 * @hide
Scott Main4b5da682010-10-21 11:49:12 -07001894 *
Christopher Tate487529a2009-04-29 14:03:25 -07001895 * @see #getSystemService
1896 */
1897 public static final String BACKUP_SERVICE = "backup";
Dan Egnor95240272009-10-27 18:23:39 -07001898
1899 /**
1900 * Use with {@link #getSystemService} to retrieve a
Dan Egnor1337b012010-01-04 11:01:44 -08001901 * {@link android.os.DropBoxManager} instance for recording
Dan Egnor95240272009-10-27 18:23:39 -07001902 * diagnostic logs.
Dan Egnor95240272009-10-27 18:23:39 -07001903 * @see #getSystemService
1904 */
1905 public static final String DROPBOX_SERVICE = "dropbox";
1906
Christopher Tate487529a2009-04-29 14:03:25 -07001907 /**
Scott Main4b5da682010-10-21 11:49:12 -07001908 * Use with {@link #getSystemService} to retrieve a
Dianne Hackborn87bba1e2010-02-26 17:25:54 -08001909 * {@link android.app.admin.DevicePolicyManager} for working with global
Dianne Hackbornd6847842010-01-12 18:14:19 -08001910 * device policy management.
1911 *
1912 * @see #getSystemService
1913 */
1914 public static final String DEVICE_POLICY_SERVICE = "device_policy";
1915
1916 /**
Tobias Haamel53332882010-02-18 16:15:43 -08001917 * Use with {@link #getSystemService} to retrieve a
1918 * {@link android.app.UiModeManager} for controlling UI modes.
1919 *
1920 * @see #getSystemService
1921 */
1922 public static final String UI_MODE_SERVICE = "uimode";
1923
1924 /**
Steve Howarda2709362010-07-02 17:12:48 -07001925 * Use with {@link #getSystemService} to retrieve a
Steve Howardd58429f2010-09-27 16:32:39 -07001926 * {@link android.app.DownloadManager} for requesting HTTP downloads.
Steve Howarda2709362010-07-02 17:12:48 -07001927 *
1928 * @see #getSystemService
Steve Howarda2709362010-07-02 17:12:48 -07001929 */
1930 public static final String DOWNLOAD_SERVICE = "download";
1931
1932 /**
Chung-yih Wang2d942312010-08-05 12:17:37 +08001933 * Use with {@link #getSystemService} to retrieve a
Nick Pelly50b4d8f2010-12-07 22:40:28 -08001934 * {@link android.nfc.NfcManager} for using NFC.
1935 *
1936 * @see #getSystemService
1937 */
1938 public static final String NFC_SERVICE = "nfc";
1939
1940 /**
1941 * Use with {@link #getSystemService} to retrieve a
Jaikumar Ganesh1abb1cb2012-01-25 16:14:50 -08001942 * {@link android.bluetooth.BluetoothAdapter} for using Bluetooth.
1943 *
1944 * @see #getSystemService
1945 * @hide
1946 */
1947 public static final String BLUETOOTH_SERVICE = "bluetooth";
1948
1949 /**
1950 * Use with {@link #getSystemService} to retrieve a
Chung-yih Wang2d942312010-08-05 12:17:37 +08001951 * {@link android.net.sip.SipManager} for accessing the SIP related service.
1952 *
1953 * @see #getSystemService
1954 */
1955 /** @hide */
1956 public static final String SIP_SERVICE = "sip";
1957
1958 /**
Mike Lockwoode7d511e2010-12-30 13:39:37 -05001959 * Use with {@link #getSystemService} to retrieve a {@link
Mike Lockwoodc4308f02011-03-01 08:04:54 -08001960 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host)
Mike Lockwoode7d511e2010-12-30 13:39:37 -05001961 * and for controlling this device's behavior as a USB device.
1962 *
1963 * @see #getSystemService
Mike Lockwoodc4308f02011-03-01 08:04:54 -08001964 * @see android.harware.usb.UsbManager
Mike Lockwoode7d511e2010-12-30 13:39:37 -05001965 */
1966 public static final String USB_SERVICE = "usb";
1967
1968 /**
Mike Lockwoodb01e8bf2011-08-29 20:11:07 -04001969 * Use with {@link #getSystemService} to retrieve a {@link
1970 * android.hardware.SerialManager} for access to serial ports.
1971 *
1972 * @see #getSystemService
1973 * @see android.harware.SerialManager
1974 *
1975 * @hide
1976 */
1977 public static final String SERIAL_SERVICE = "serial";
1978
1979 /**
Jeff Brown9df6e7a2012-04-05 11:49:26 -07001980 * Use with {@link #getSystemService} to retrieve a
1981 * {@link android.hardware.input.InputManager} for interacting with input devices.
1982 *
1983 * @see #getSystemService
1984 * @see android.hardware.input.InputManager
1985 */
1986 public static final String INPUT_SERVICE = "input";
1987
1988 /**
Glenn Kasten07b04652012-04-23 15:00:43 -07001989 * Use with {@link #getSystemService} to retrieve a
Jeff Brownfa25bf52012-07-23 19:26:30 -07001990 * {@link android.hardware.display.DisplayManager} for interacting with display devices.
1991 *
1992 * @see #getSystemService
1993 * @see android.hardware.display.DisplayManager
1994 */
1995 public static final String DISPLAY_SERVICE = "display";
1996
1997 /**
1998 * Use with {@link #getSystemService} to retrieve a
Glenn Kasten07b04652012-04-23 15:00:43 -07001999 * {@link android.os.SchedulingPolicyService} for managing scheduling policy.
2000 *
2001 * @see #getSystemService
2002 * @see android.os.SchedulingPolicyService
2003 *
2004 * @hide
2005 */
2006 public static final String SCHEDULING_POLICY_SERVICE = "scheduling_policy";
2007
2008 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002009 * Determine whether the given permission is allowed for a particular
2010 * process and user ID running in the system.
2011 *
2012 * @param permission The name of the permission being checked.
2013 * @param pid The process ID being checked against. Must be > 0.
2014 * @param uid The user ID being checked against. A uid of 0 is the root
2015 * user, which will pass every permission check.
2016 *
2017 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given
2018 * pid/uid is allowed that permission, or
2019 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2020 *
2021 * @see PackageManager#checkPermission(String, String)
2022 * @see #checkCallingPermission
2023 */
2024 public abstract int checkPermission(String permission, int pid, int uid);
2025
2026 /**
2027 * Determine whether the calling process of an IPC you are handling has been
2028 * granted a particular permission. This is basically the same as calling
2029 * {@link #checkPermission(String, int, int)} with the pid and uid returned
2030 * by {@link android.os.Binder#getCallingPid} and
2031 * {@link android.os.Binder#getCallingUid}. One important difference
2032 * is that if you are not currently processing an IPC, this function
2033 * will always fail. This is done to protect against accidentally
2034 * leaking permissions; you can use {@link #checkCallingOrSelfPermission}
2035 * to avoid this protection.
2036 *
2037 * @param permission The name of the permission being checked.
2038 *
2039 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling
2040 * pid/uid is allowed that permission, or
2041 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2042 *
2043 * @see PackageManager#checkPermission(String, String)
2044 * @see #checkPermission
2045 * @see #checkCallingOrSelfPermission
2046 */
2047 public abstract int checkCallingPermission(String permission);
2048
2049 /**
2050 * Determine whether the calling process of an IPC <em>or you</em> have been
2051 * granted a particular permission. This is the same as
2052 * {@link #checkCallingPermission}, except it grants your own permissions
2053 * if you are not currently processing an IPC. Use with care!
2054 *
2055 * @param permission The name of the permission being checked.
2056 *
2057 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the calling
2058 * pid/uid is allowed that permission, or
2059 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2060 *
2061 * @see PackageManager#checkPermission(String, String)
2062 * @see #checkPermission
2063 * @see #checkCallingPermission
2064 */
2065 public abstract int checkCallingOrSelfPermission(String permission);
2066
2067 /**
2068 * If the given permission is not allowed for a particular process
2069 * and user ID running in the system, throw a {@link SecurityException}.
2070 *
2071 * @param permission The name of the permission being checked.
2072 * @param pid The process ID being checked against. Must be &gt; 0.
2073 * @param uid The user ID being checked against. A uid of 0 is the root
2074 * user, which will pass every permission check.
2075 * @param message A message to include in the exception if it is thrown.
2076 *
2077 * @see #checkPermission(String, int, int)
2078 */
2079 public abstract void enforcePermission(
2080 String permission, int pid, int uid, String message);
2081
2082 /**
2083 * If the calling process of an IPC you are handling has not been
2084 * granted a particular permission, throw a {@link
2085 * SecurityException}. This is basically the same as calling
2086 * {@link #enforcePermission(String, int, int, String)} with the
2087 * pid and uid returned by {@link android.os.Binder#getCallingPid}
2088 * and {@link android.os.Binder#getCallingUid}. One important
2089 * difference is that if you are not currently processing an IPC,
2090 * this function will always throw the SecurityException. This is
2091 * done to protect against accidentally leaking permissions; you
2092 * can use {@link #enforceCallingOrSelfPermission} to avoid this
2093 * protection.
2094 *
2095 * @param permission The name of the permission being checked.
2096 * @param message A message to include in the exception if it is thrown.
2097 *
2098 * @see #checkCallingPermission(String)
2099 */
2100 public abstract void enforceCallingPermission(
2101 String permission, String message);
2102
2103 /**
2104 * If neither you nor the calling process of an IPC you are
2105 * handling has been granted a particular permission, throw a
2106 * {@link SecurityException}. This is the same as {@link
2107 * #enforceCallingPermission}, except it grants your own
2108 * permissions if you are not currently processing an IPC. Use
2109 * with care!
2110 *
2111 * @param permission The name of the permission being checked.
2112 * @param message A message to include in the exception if it is thrown.
2113 *
2114 * @see #checkCallingOrSelfPermission(String)
2115 */
2116 public abstract void enforceCallingOrSelfPermission(
2117 String permission, String message);
2118
2119 /**
2120 * Grant permission to access a specific Uri to another package, regardless
2121 * of whether that package has general permission to access the Uri's
2122 * content provider. This can be used to grant specific, temporary
2123 * permissions, typically in response to user interaction (such as the
2124 * user opening an attachment that you would like someone else to
2125 * display).
2126 *
2127 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2128 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2129 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2130 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to
2131 * start an activity instead of this function directly. If you use this
2132 * function directly, you should be sure to call
2133 * {@link #revokeUriPermission} when the target should no longer be allowed
2134 * to access it.
2135 *
2136 * <p>To succeed, the content provider owning the Uri must have set the
2137 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions
2138 * grantUriPermissions} attribute in its manifest or included the
2139 * {@link android.R.styleable#AndroidManifestGrantUriPermission
2140 * &lt;grant-uri-permissions&gt;} tag.
2141 *
2142 * @param toPackage The package you would like to allow to access the Uri.
2143 * @param uri The Uri you would like to grant access to.
2144 * @param modeFlags The desired access modes. Any combination of
2145 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2146 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2147 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2148 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2149 *
2150 * @see #revokeUriPermission
2151 */
2152 public abstract void grantUriPermission(String toPackage, Uri uri,
2153 int modeFlags);
2154
2155 /**
2156 * Remove all permissions to access a particular content provider Uri
2157 * that were previously added with {@link #grantUriPermission}. The given
2158 * Uri will match all previously granted Uris that are the same or a
2159 * sub-path of the given Uri. That is, revoking "content://foo/one" will
2160 * revoke both "content://foo/target" and "content://foo/target/sub", but not
2161 * "content://foo".
2162 *
2163 * @param uri The Uri you would like to revoke access to.
2164 * @param modeFlags The desired access modes. Any combination of
2165 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
2166 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2167 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
2168 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2169 *
2170 * @see #grantUriPermission
2171 */
2172 public abstract void revokeUriPermission(Uri uri, int modeFlags);
2173
2174 /**
2175 * Determine whether a particular process and user ID has been granted
2176 * permission to access a specific URI. This only checks for permissions
2177 * that have been explicitly granted -- if the given process/uid has
2178 * more general access to the URI's content provider then this check will
2179 * always fail.
2180 *
2181 * @param uri The uri that is being checked.
2182 * @param pid The process ID being checked against. Must be &gt; 0.
2183 * @param uid The user ID being checked against. A uid of 0 is the root
2184 * user, which will pass every permission check.
2185 * @param modeFlags The type of access to grant. May be one or both of
2186 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2187 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2188 *
2189 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the given
2190 * pid/uid is allowed to access that uri, or
2191 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2192 *
2193 * @see #checkCallingUriPermission
2194 */
2195 public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags);
2196
2197 /**
2198 * Determine whether the calling process and user ID has been
2199 * granted permission to access a specific URI. This is basically
2200 * the same as calling {@link #checkUriPermission(Uri, int, int,
2201 * int)} with the pid and uid returned by {@link
2202 * android.os.Binder#getCallingPid} and {@link
2203 * android.os.Binder#getCallingUid}. One important difference is
2204 * that if you are not currently processing an IPC, this function
2205 * will always fail.
2206 *
2207 * @param uri The uri that is being checked.
2208 * @param modeFlags The type of access to grant. May be one or both of
2209 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2210 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2211 *
2212 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller
2213 * is allowed to access that uri, or
2214 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2215 *
2216 * @see #checkUriPermission(Uri, int, int, int)
2217 */
2218 public abstract int checkCallingUriPermission(Uri uri, int modeFlags);
2219
2220 /**
2221 * Determine whether the calling process of an IPC <em>or you</em> has been granted
2222 * permission to access a specific URI. This is the same as
2223 * {@link #checkCallingUriPermission}, except it grants your own permissions
2224 * if you are not currently processing an IPC. Use with care!
2225 *
2226 * @param uri The uri that is being checked.
2227 * @param modeFlags The type of access to grant. May be one or both of
2228 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2229 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2230 *
2231 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller
2232 * is allowed to access that uri, or
2233 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2234 *
2235 * @see #checkCallingUriPermission
2236 */
2237 public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags);
2238
2239 /**
2240 * Check both a Uri and normal permission. This allows you to perform
2241 * both {@link #checkPermission} and {@link #checkUriPermission} in one
2242 * call.
2243 *
2244 * @param uri The Uri whose permission is to be checked, or null to not
2245 * do this check.
2246 * @param readPermission The permission that provides overall read access,
2247 * or null to not do this check.
2248 * @param writePermission The permission that provides overall write
2249 * acess, or null to not do this check.
2250 * @param pid The process ID being checked against. Must be &gt; 0.
2251 * @param uid The user ID being checked against. A uid of 0 is the root
2252 * user, which will pass every permission check.
2253 * @param modeFlags The type of access to grant. May be one or both of
2254 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2255 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2256 *
2257 * @return Returns {@link PackageManager#PERMISSION_GRANTED} if the caller
2258 * is allowed to access that uri or holds one of the given permissions, or
2259 * {@link PackageManager#PERMISSION_DENIED} if it is not.
2260 */
2261 public abstract int checkUriPermission(Uri uri, String readPermission,
2262 String writePermission, int pid, int uid, int modeFlags);
2263
2264 /**
2265 * If a particular process and user ID has not been granted
2266 * permission to access a specific URI, throw {@link
2267 * SecurityException}. This only checks for permissions that have
2268 * been explicitly granted -- if the given process/uid has more
2269 * general access to the URI's content provider then this check
2270 * will always fail.
2271 *
2272 * @param uri The uri that is being checked.
2273 * @param pid The process ID being checked against. Must be &gt; 0.
2274 * @param uid The user ID being checked against. A uid of 0 is the root
2275 * user, which will pass every permission check.
2276 * @param modeFlags The type of access to grant. May be one or both of
2277 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2278 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2279 * @param message A message to include in the exception if it is thrown.
2280 *
2281 * @see #checkUriPermission(Uri, int, int, int)
2282 */
2283 public abstract void enforceUriPermission(
2284 Uri uri, int pid, int uid, int modeFlags, String message);
2285
2286 /**
2287 * If the calling process and user ID has not been granted
2288 * permission to access a specific URI, throw {@link
2289 * SecurityException}. This is basically the same as calling
2290 * {@link #enforceUriPermission(Uri, int, int, int, String)} with
2291 * the pid and uid returned by {@link
2292 * android.os.Binder#getCallingPid} and {@link
2293 * android.os.Binder#getCallingUid}. One important difference is
2294 * that if you are not currently processing an IPC, this function
2295 * will always throw a SecurityException.
2296 *
2297 * @param uri The uri that is being checked.
2298 * @param modeFlags The type of access to grant. May be one or both of
2299 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2300 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2301 * @param message A message to include in the exception if it is thrown.
2302 *
2303 * @see #checkCallingUriPermission(Uri, int)
2304 */
2305 public abstract void enforceCallingUriPermission(
2306 Uri uri, int modeFlags, String message);
2307
2308 /**
2309 * If the calling process of an IPC <em>or you</em> has not been
2310 * granted permission to access a specific URI, throw {@link
2311 * SecurityException}. This is the same as {@link
2312 * #enforceCallingUriPermission}, except it grants your own
2313 * permissions if you are not currently processing an IPC. Use
2314 * with care!
Scott Main4b5da682010-10-21 11:49:12 -07002315 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002316 * @param uri The uri that is being checked.
2317 * @param modeFlags The type of access to grant. May be one or both of
2318 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2319 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2320 * @param message A message to include in the exception if it is thrown.
2321 *
2322 * @see #checkCallingOrSelfUriPermission(Uri, int)
2323 */
2324 public abstract void enforceCallingOrSelfUriPermission(
2325 Uri uri, int modeFlags, String message);
2326
2327 /**
2328 * Enforce both a Uri and normal permission. This allows you to perform
2329 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one
2330 * call.
Scott Main4b5da682010-10-21 11:49:12 -07002331 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002332 * @param uri The Uri whose permission is to be checked, or null to not
2333 * do this check.
2334 * @param readPermission The permission that provides overall read access,
2335 * or null to not do this check.
2336 * @param writePermission The permission that provides overall write
2337 * acess, or null to not do this check.
2338 * @param pid The process ID being checked against. Must be &gt; 0.
2339 * @param uid The user ID being checked against. A uid of 0 is the root
2340 * user, which will pass every permission check.
2341 * @param modeFlags The type of access to grant. May be one or both of
2342 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or
2343 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}.
2344 * @param message A message to include in the exception if it is thrown.
2345 *
2346 * @see #checkUriPermission(Uri, String, String, int, int, int)
2347 */
2348 public abstract void enforceUriPermission(
2349 Uri uri, String readPermission, String writePermission,
2350 int pid, int uid, int modeFlags, String message);
2351
2352 /**
2353 * Flag for use with {@link #createPackageContext}: include the application
2354 * code with the context. This means loading code into the caller's
2355 * process, so that {@link #getClassLoader()} can be used to instantiate
2356 * the application's classes. Setting this flags imposes security
2357 * restrictions on what application context you can access; if the
2358 * requested application can not be safely loaded into your process,
2359 * java.lang.SecurityException will be thrown. If this flag is not set,
2360 * there will be no restrictions on the packages that can be loaded,
2361 * but {@link #getClassLoader} will always return the default system
2362 * class loader.
2363 */
2364 public static final int CONTEXT_INCLUDE_CODE = 0x00000001;
2365
2366 /**
2367 * Flag for use with {@link #createPackageContext}: ignore any security
2368 * restrictions on the Context being requested, allowing it to always
2369 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code
2370 * to be loaded into a process even when it isn't safe to do so. Use
2371 * with extreme care!
2372 */
2373 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002;
Scott Main4b5da682010-10-21 11:49:12 -07002374
Romain Guy870e09f2009-07-06 16:35:25 -07002375 /**
2376 * Flag for use with {@link #createPackageContext}: a restricted context may
2377 * disable specific features. For instance, a View associated with a restricted
2378 * context would ignore particular XML attributes.
2379 */
2380 public static final int CONTEXT_RESTRICTED = 0x00000004;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002381
2382 /**
2383 * Return a new Context object for the given application name. This
2384 * Context is the same as what the named application gets when it is
2385 * launched, containing the same resources and class loader. Each call to
2386 * this method returns a new instance of a Context object; Context objects
2387 * are not shared, however they share common state (Resources, ClassLoader,
2388 * etc) so the Context instance itself is fairly lightweight.
2389 *
2390 * <p>Throws {@link PackageManager.NameNotFoundException} if there is no
2391 * application with the given package name.
2392 *
2393 * <p>Throws {@link java.lang.SecurityException} if the Context requested
2394 * can not be loaded into the caller's process for security reasons (see
2395 * {@link #CONTEXT_INCLUDE_CODE} for more information}.
2396 *
2397 * @param packageName Name of the application's package.
2398 * @param flags Option flags, one of {@link #CONTEXT_INCLUDE_CODE}
2399 * or {@link #CONTEXT_IGNORE_SECURITY}.
2400 *
2401 * @return A Context for the application.
2402 *
2403 * @throws java.lang.SecurityException
2404 * @throws PackageManager.NameNotFoundException if there is no application with
2405 * the given package name
2406 */
2407 public abstract Context createPackageContext(String packageName,
2408 int flags) throws PackageManager.NameNotFoundException;
Romain Guy870e09f2009-07-06 16:35:25 -07002409
2410 /**
2411 * Indicates whether this Context is restricted.
Scott Main4b5da682010-10-21 11:49:12 -07002412 *
Romain Guy870e09f2009-07-06 16:35:25 -07002413 * @return True if this Context is restricted, false otherwise.
Scott Main4b5da682010-10-21 11:49:12 -07002414 *
Romain Guy870e09f2009-07-06 16:35:25 -07002415 * @see #CONTEXT_RESTRICTED
2416 */
2417 public boolean isRestricted() {
2418 return false;
2419 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002420}