Context.java revision cd925885283396c0379ec2dcaa94e318993f40f8
1/* 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 19import android.content.pm.ApplicationInfo; 20import android.content.pm.PackageManager; 21import android.content.res.AssetManager; 22import android.content.res.Configuration; 23import android.content.res.Resources; 24import android.content.res.TypedArray; 25import android.database.DatabaseErrorHandler; 26import android.database.sqlite.SQLiteDatabase; 27import android.database.sqlite.SQLiteDatabase.CursorFactory; 28import android.graphics.Bitmap; 29import android.graphics.drawable.Drawable; 30import android.media.MediaScannerConnection.OnScanCompletedListener; 31import android.net.Uri; 32import android.os.Bundle; 33import android.os.Handler; 34import android.os.Looper; 35import android.os.UserHandle; 36import android.os.UserManager; 37import android.util.AttributeSet; 38import android.view.DisplayAdjustments; 39import android.view.Display; 40import android.view.WindowManager; 41 42import java.io.File; 43import java.io.FileInputStream; 44import java.io.FileNotFoundException; 45import java.io.FileOutputStream; 46import java.io.IOException; 47import java.io.InputStream; 48 49/** 50 * Interface to global information about an application environment. This is 51 * an abstract class whose implementation is provided by 52 * the Android system. It 53 * allows access to application-specific resources and classes, as well as 54 * up-calls for application-level operations such as launching activities, 55 * broadcasting and receiving intents, etc. 56 */ 57public abstract class Context { 58 /** 59 * File creation mode: the default mode, where the created file can only 60 * be accessed by the calling application (or all applications sharing the 61 * same user ID). 62 * @see #MODE_WORLD_READABLE 63 * @see #MODE_WORLD_WRITEABLE 64 */ 65 public static final int MODE_PRIVATE = 0x0000; 66 /** 67 * @deprecated Creating world-readable files is very dangerous, and likely 68 * to cause security holes in applications. It is strongly discouraged; 69 * instead, applications should use more formal mechanism for interactions 70 * such as {@link ContentProvider}, {@link BroadcastReceiver}, and 71 * {@link android.app.Service}. There are no guarantees that this 72 * access mode will remain on a file, such as when it goes through a 73 * backup and restore. 74 * File creation mode: allow all other applications to have read access 75 * to the created file. 76 * @see #MODE_PRIVATE 77 * @see #MODE_WORLD_WRITEABLE 78 */ 79 @Deprecated 80 public static final int MODE_WORLD_READABLE = 0x0001; 81 /** 82 * @deprecated Creating world-writable files is very dangerous, and likely 83 * to cause security holes in applications. It is strongly discouraged; 84 * instead, applications should use more formal mechanism for interactions 85 * such as {@link ContentProvider}, {@link BroadcastReceiver}, and 86 * {@link android.app.Service}. There are no guarantees that this 87 * access mode will remain on a file, such as when it goes through a 88 * backup and restore. 89 * File creation mode: allow all other applications to have write access 90 * to the created file. 91 * @see #MODE_PRIVATE 92 * @see #MODE_WORLD_READABLE 93 */ 94 @Deprecated 95 public static final int MODE_WORLD_WRITEABLE = 0x0002; 96 /** 97 * File creation mode: for use with {@link #openFileOutput}, if the file 98 * already exists then write data to the end of the existing file 99 * instead of erasing it. 100 * @see #openFileOutput 101 */ 102 public static final int MODE_APPEND = 0x8000; 103 104 /** 105 * SharedPreference loading flag: when set, the file on disk will 106 * be checked for modification even if the shared preferences 107 * instance is already loaded in this process. This behavior is 108 * sometimes desired in cases where the application has multiple 109 * processes, all writing to the same SharedPreferences file. 110 * Generally there are better forms of communication between 111 * processes, though. 112 * 113 * <p>This was the legacy (but undocumented) behavior in and 114 * before Gingerbread (Android 2.3) and this flag is implied when 115 * targetting such releases. For applications targetting SDK 116 * versions <em>greater than</em> Android 2.3, this flag must be 117 * explicitly set if desired. 118 * 119 * @see #getSharedPreferences 120 */ 121 public static final int MODE_MULTI_PROCESS = 0x0004; 122 123 /** 124 * Database open flag: when set, the database is opened with write-ahead 125 * logging enabled by default. 126 * 127 * @see #openOrCreateDatabase(String, int, CursorFactory) 128 * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler) 129 * @see SQLiteDatabase#enableWriteAheadLogging 130 */ 131 public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008; 132 133 /** 134 * Flag for {@link #bindService}: automatically create the service as long 135 * as the binding exists. Note that while this will create the service, 136 * its {@link android.app.Service#onStartCommand} 137 * method will still only be called due to an 138 * explicit call to {@link #startService}. Even without that, though, 139 * this still provides you with access to the service object while the 140 * service is created. 141 * 142 * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, 143 * not supplying this flag would also impact how important the system 144 * consider's the target service's process to be. When set, the only way 145 * for it to be raised was by binding from a service in which case it will 146 * only be important when that activity is in the foreground. Now to 147 * achieve this behavior you must explicitly supply the new flag 148 * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications 149 * that don't specify {@link #BIND_AUTO_CREATE} will automatically have 150 * the flags {@link #BIND_WAIVE_PRIORITY} and 151 * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve 152 * the same result. 153 */ 154 public static final int BIND_AUTO_CREATE = 0x0001; 155 156 /** 157 * Flag for {@link #bindService}: include debugging help for mismatched 158 * calls to unbind. When this flag is set, the callstack of the following 159 * {@link #unbindService} call is retained, to be printed if a later 160 * incorrect unbind call is made. Note that doing this requires retaining 161 * information about the binding that was made for the lifetime of the app, 162 * resulting in a leak -- this should only be used for debugging. 163 */ 164 public static final int BIND_DEBUG_UNBIND = 0x0002; 165 166 /** 167 * Flag for {@link #bindService}: don't allow this binding to raise 168 * the target service's process to the foreground scheduling priority. 169 * It will still be raised to at least the same memory priority 170 * as the client (so that its process will not be killable in any 171 * situation where the client is not killable), but for CPU scheduling 172 * purposes it may be left in the background. This only has an impact 173 * in the situation where the binding client is a foreground process 174 * and the target service is in a background process. 175 */ 176 public static final int BIND_NOT_FOREGROUND = 0x0004; 177 178 /** 179 * Flag for {@link #bindService}: indicates that the client application 180 * binding to this service considers the service to be more important than 181 * the app itself. When set, the platform will try to have the out of 182 * memory killer kill the app before it kills the service it is bound to, though 183 * this is not guaranteed to be the case. 184 */ 185 public static final int BIND_ABOVE_CLIENT = 0x0008; 186 187 /** 188 * Flag for {@link #bindService}: allow the process hosting the bound 189 * service to go through its normal memory management. It will be 190 * treated more like a running service, allowing the system to 191 * (temporarily) expunge the process if low on memory or for some other 192 * whim it may have, and being more aggressive about making it a candidate 193 * to be killed (and restarted) if running for a long time. 194 */ 195 public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010; 196 197 /** 198 * Flag for {@link #bindService}: don't impact the scheduling or 199 * memory management priority of the target service's hosting process. 200 * Allows the service's process to be managed on the background LRU list 201 * just like a regular application process in the background. 202 */ 203 public static final int BIND_WAIVE_PRIORITY = 0x0020; 204 205 /** 206 * Flag for {@link #bindService}: this service is very important to 207 * the client, so should be brought to the foreground process level 208 * when the client is. Normally a process can only be raised to the 209 * visibility level by a client, even if that client is in the foreground. 210 */ 211 public static final int BIND_IMPORTANT = 0x0040; 212 213 /** 214 * Flag for {@link #bindService}: If binding from an activity, allow the 215 * target service's process importance to be raised based on whether the 216 * activity is visible to the user, regardless whether another flag is 217 * used to reduce the amount that the client process's overall importance 218 * is used to impact it. 219 */ 220 public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080; 221 222 /** 223 * @hide An idea that is not yet implemented. 224 * Flag for {@link #bindService}: If binding from an activity, consider 225 * this service to be visible like the binding activity is. That is, 226 * it will be treated as something more important to keep around than 227 * invisible background activities. This will impact the number of 228 * recent activities the user can switch between without having them 229 * restart. There is no guarantee this will be respected, as the system 230 * tries to balance such requests from one app vs. the importantance of 231 * keeping other apps around. 232 */ 233 public static final int BIND_VISIBLE = 0x10000000; 234 235 /** 236 * @hide 237 * Flag for {@link #bindService}: Consider this binding to be causing the target 238 * process to be showing UI, so it will be do a UI_HIDDEN memory trim when it goes 239 * away. 240 */ 241 public static final int BIND_SHOWING_UI = 0x20000000; 242 243 /** 244 * Flag for {@link #bindService}: Don't consider the bound service to be 245 * visible, even if the caller is visible. 246 * @hide 247 */ 248 public static final int BIND_NOT_VISIBLE = 0x40000000; 249 250 /** Return an AssetManager instance for your application's package. */ 251 public abstract AssetManager getAssets(); 252 253 /** Return a Resources instance for your application's package. */ 254 public abstract Resources getResources(); 255 256 /** Return PackageManager instance to find global package information. */ 257 public abstract PackageManager getPackageManager(); 258 259 /** Return a ContentResolver instance for your application's package. */ 260 public abstract ContentResolver getContentResolver(); 261 262 /** 263 * Return the Looper for the main thread of the current process. This is 264 * the thread used to dispatch calls to application components (activities, 265 * services, etc). 266 * <p> 267 * By definition, this method returns the same result as would be obtained 268 * by calling {@link Looper#getMainLooper() Looper.getMainLooper()}. 269 * </p> 270 * 271 * @return The main looper. 272 */ 273 public abstract Looper getMainLooper(); 274 275 /** 276 * Return the context of the single, global Application object of the 277 * current process. This generally should only be used if you need a 278 * Context whose lifecycle is separate from the current context, that is 279 * tied to the lifetime of the process rather than the current component. 280 * 281 * <p>Consider for example how this interacts with 282 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}: 283 * <ul> 284 * <li> <p>If used from an Activity context, the receiver is being registered 285 * within that activity. This means that you are expected to unregister 286 * before the activity is done being destroyed; in fact if you do not do 287 * so, the framework will clean up your leaked registration as it removes 288 * the activity and log an error. Thus, if you use the Activity context 289 * to register a receiver that is static (global to the process, not 290 * associated with an Activity instance) then that registration will be 291 * removed on you at whatever point the activity you used is destroyed. 292 * <li> <p>If used from the Context returned here, the receiver is being 293 * registered with the global state associated with your application. Thus 294 * it will never be unregistered for you. This is necessary if the receiver 295 * is associated with static data, not a particular component. However 296 * using the ApplicationContext elsewhere can easily lead to serious leaks 297 * if you forget to unregister, unbind, etc. 298 * </ul> 299 */ 300 public abstract Context getApplicationContext(); 301 302 /** 303 * Add a new {@link ComponentCallbacks} to the base application of the 304 * Context, which will be called at the same times as the ComponentCallbacks 305 * methods of activities and other components are called. Note that you 306 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when 307 * appropriate in the future; this will not be removed for you. 308 * 309 * @param callback The interface to call. This can be either a 310 * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface. 311 */ 312 public void registerComponentCallbacks(ComponentCallbacks callback) { 313 getApplicationContext().registerComponentCallbacks(callback); 314 } 315 316 /** 317 * Remove a {@link ComponentCallbacks} object that was previously registered 318 * with {@link #registerComponentCallbacks(ComponentCallbacks)}. 319 */ 320 public void unregisterComponentCallbacks(ComponentCallbacks callback) { 321 getApplicationContext().unregisterComponentCallbacks(callback); 322 } 323 324 /** 325 * Return a localized, styled CharSequence from the application's package's 326 * default string table. 327 * 328 * @param resId Resource id for the CharSequence text 329 */ 330 public final CharSequence getText(int resId) { 331 return getResources().getText(resId); 332 } 333 334 /** 335 * Return a localized string from the application's package's 336 * default string table. 337 * 338 * @param resId Resource id for the string 339 */ 340 public final String getString(int resId) { 341 return getResources().getString(resId); 342 } 343 344 /** 345 * Return a localized formatted string from the application's package's 346 * default string table, substituting the format arguments as defined in 347 * {@link java.util.Formatter} and {@link java.lang.String#format}. 348 * 349 * @param resId Resource id for the format string 350 * @param formatArgs The format arguments that will be used for substitution. 351 */ 352 353 public final String getString(int resId, Object... formatArgs) { 354 return getResources().getString(resId, formatArgs); 355 } 356 357 /** 358 * Set the base theme for this context. Note that this should be called 359 * before any views are instantiated in the Context (for example before 360 * calling {@link android.app.Activity#setContentView} or 361 * {@link android.view.LayoutInflater#inflate}). 362 * 363 * @param resid The style resource describing the theme. 364 */ 365 public abstract void setTheme(int resid); 366 367 /** @hide Needed for some internal implementation... not public because 368 * you can't assume this actually means anything. */ 369 public int getThemeResId() { 370 return 0; 371 } 372 373 /** 374 * Return the Theme object associated with this Context. 375 */ 376 public abstract Resources.Theme getTheme(); 377 378 /** 379 * Retrieve styled attribute information in this Context's theme. See 380 * {@link Resources.Theme#obtainStyledAttributes(int[])} 381 * for more information. 382 * 383 * @see Resources.Theme#obtainStyledAttributes(int[]) 384 */ 385 public final TypedArray obtainStyledAttributes( 386 int[] attrs) { 387 return getTheme().obtainStyledAttributes(attrs); 388 } 389 390 /** 391 * Retrieve styled attribute information in this Context's theme. See 392 * {@link Resources.Theme#obtainStyledAttributes(int, int[])} 393 * for more information. 394 * 395 * @see Resources.Theme#obtainStyledAttributes(int, int[]) 396 */ 397 public final TypedArray obtainStyledAttributes( 398 int resid, int[] attrs) throws Resources.NotFoundException { 399 return getTheme().obtainStyledAttributes(resid, attrs); 400 } 401 402 /** 403 * Retrieve styled attribute information in this Context's theme. See 404 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 405 * for more information. 406 * 407 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 408 */ 409 public final TypedArray obtainStyledAttributes( 410 AttributeSet set, int[] attrs) { 411 return getTheme().obtainStyledAttributes(set, attrs, 0, 0); 412 } 413 414 /** 415 * Retrieve styled attribute information in this Context's theme. See 416 * {@link Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} 417 * for more information. 418 * 419 * @see Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) 420 */ 421 public final TypedArray obtainStyledAttributes( 422 AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) { 423 return getTheme().obtainStyledAttributes( 424 set, attrs, defStyleAttr, defStyleRes); 425 } 426 427 /** 428 * Return a class loader you can use to retrieve classes in this package. 429 */ 430 public abstract ClassLoader getClassLoader(); 431 432 /** Return the name of this application's package. */ 433 public abstract String getPackageName(); 434 435 /** @hide Return the name of the base context this context is derived from. */ 436 public abstract String getBasePackageName(); 437 438 /** @hide Return the package name that should be used for app ops calls from 439 * this context. This is the same as {@link #getBasePackageName()} except in 440 * cases where system components are loaded into other app processes, in which 441 * case this will be the name of the primary package in that process (so that app 442 * ops uid verification will work with the name). */ 443 public abstract String getOpPackageName(); 444 445 /** Return the full application info for this context's package. */ 446 public abstract ApplicationInfo getApplicationInfo(); 447 448 /** 449 * Return the full path to this context's primary Android package. 450 * The Android package is a ZIP file which contains the application's 451 * primary resources. 452 * 453 * <p>Note: this is not generally useful for applications, since they should 454 * not be directly accessing the file system. 455 * 456 * @return String Path to the resources. 457 */ 458 public abstract String getPackageResourcePath(); 459 460 /** 461 * Return the full path to this context's primary Android package. 462 * The Android package is a ZIP file which contains application's 463 * primary code and assets. 464 * 465 * <p>Note: this is not generally useful for applications, since they should 466 * not be directly accessing the file system. 467 * 468 * @return String Path to the code and assets. 469 */ 470 public abstract String getPackageCodePath(); 471 472 /** 473 * {@hide} 474 * Return the full path to the shared prefs file for the given prefs group name. 475 * 476 * <p>Note: this is not generally useful for applications, since they should 477 * not be directly accessing the file system. 478 */ 479 public abstract File getSharedPrefsFile(String name); 480 481 /** 482 * Retrieve and hold the contents of the preferences file 'name', returning 483 * a SharedPreferences through which you can retrieve and modify its 484 * values. Only one instance of the SharedPreferences object is returned 485 * to any callers for the same name, meaning they will see each other's 486 * edits as soon as they are made. 487 * 488 * @param name Desired preferences file. If a preferences file by this name 489 * does not exist, it will be created when you retrieve an 490 * editor (SharedPreferences.edit()) and then commit changes (Editor.commit()). 491 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 492 * default operation, {@link #MODE_WORLD_READABLE} 493 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. The bit 494 * {@link #MODE_MULTI_PROCESS} can also be used if multiple processes 495 * are mutating the same SharedPreferences file. {@link #MODE_MULTI_PROCESS} 496 * is always on in apps targetting Gingerbread (Android 2.3) and below, and 497 * off by default in later versions. 498 * 499 * @return The single {@link SharedPreferences} instance that can be used 500 * to retrieve and modify the preference values. 501 * 502 * @see #MODE_PRIVATE 503 * @see #MODE_WORLD_READABLE 504 * @see #MODE_WORLD_WRITEABLE 505 * @see #MODE_MULTI_PROCESS 506 */ 507 public abstract SharedPreferences getSharedPreferences(String name, 508 int mode); 509 510 /** 511 * Open a private file associated with this Context's application package 512 * for reading. 513 * 514 * @param name The name of the file to open; can not contain path 515 * separators. 516 * 517 * @return The resulting {@link FileInputStream}. 518 * 519 * @see #openFileOutput 520 * @see #fileList 521 * @see #deleteFile 522 * @see java.io.FileInputStream#FileInputStream(String) 523 */ 524 public abstract FileInputStream openFileInput(String name) 525 throws FileNotFoundException; 526 527 /** 528 * Open a private file associated with this Context's application package 529 * for writing. Creates the file if it doesn't already exist. 530 * 531 * @param name The name of the file to open; can not contain path 532 * separators. 533 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 534 * default operation, {@link #MODE_APPEND} to append to an existing file, 535 * {@link #MODE_WORLD_READABLE} and {@link #MODE_WORLD_WRITEABLE} to control 536 * permissions. 537 * 538 * @return The resulting {@link FileOutputStream}. 539 * 540 * @see #MODE_APPEND 541 * @see #MODE_PRIVATE 542 * @see #MODE_WORLD_READABLE 543 * @see #MODE_WORLD_WRITEABLE 544 * @see #openFileInput 545 * @see #fileList 546 * @see #deleteFile 547 * @see java.io.FileOutputStream#FileOutputStream(String) 548 */ 549 public abstract FileOutputStream openFileOutput(String name, int mode) 550 throws FileNotFoundException; 551 552 /** 553 * Delete the given private file associated with this Context's 554 * application package. 555 * 556 * @param name The name of the file to delete; can not contain path 557 * separators. 558 * 559 * @return {@code true} if the file was successfully deleted; else 560 * {@code false}. 561 * 562 * @see #openFileInput 563 * @see #openFileOutput 564 * @see #fileList 565 * @see java.io.File#delete() 566 */ 567 public abstract boolean deleteFile(String name); 568 569 /** 570 * Returns the absolute path on the filesystem where a file created with 571 * {@link #openFileOutput} is stored. 572 * 573 * @param name The name of the file for which you would like to get 574 * its path. 575 * 576 * @return An absolute path to the given file. 577 * 578 * @see #openFileOutput 579 * @see #getFilesDir 580 * @see #getDir 581 */ 582 public abstract File getFileStreamPath(String name); 583 584 /** 585 * Returns the absolute path to the directory on the filesystem where 586 * files created with {@link #openFileOutput} are stored. 587 * 588 * @return The path of the directory holding application files. 589 * 590 * @see #openFileOutput 591 * @see #getFileStreamPath 592 * @see #getDir 593 */ 594 public abstract File getFilesDir(); 595 596 /** 597 * Returns the absolute path to the directory on the external filesystem 598 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory() 599 * Environment.getExternalStorageDirectory()}) where the application can 600 * place persistent files it owns. These files are internal to the 601 * applications, and not typically visible to the user as media. 602 * 603 * <p>This is like {@link #getFilesDir()} in that these 604 * files will be deleted when the application is uninstalled, however there 605 * are some important differences: 606 * 607 * <ul> 608 * <li>External files are not always available: they will disappear if the 609 * user mounts the external storage on a computer or removes it. See the 610 * APIs on {@link android.os.Environment} for information in the storage state. 611 * <li>There is no security enforced with these files. All applications 612 * can read and write files placed here. 613 * </ul> 614 * 615 * <p>On devices with multiple users (as described by {@link UserManager}), 616 * each user has their own isolated external storage. Applications only 617 * have access to the external storage for the user they're running as.</p> 618 * 619 * <p>Here is an example of typical code to manipulate a file in 620 * an application's private storage:</p> 621 * 622 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 623 * private_file} 624 * 625 * <p>If you supply a non-null <var>type</var> to this function, the returned 626 * file will be a path to a sub-directory of the given type. Though these files 627 * are not automatically scanned by the media scanner, you can explicitly 628 * add them to the media database with 629 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[], 630 * OnScanCompletedListener) MediaScannerConnection.scanFile}. 631 * Note that this is not the same as 632 * {@link android.os.Environment#getExternalStoragePublicDirectory 633 * Environment.getExternalStoragePublicDirectory()}, which provides 634 * directories of media shared by all applications. The 635 * directories returned here are 636 * owned by the application, and their contents will be removed when the 637 * application is uninstalled. Unlike 638 * {@link android.os.Environment#getExternalStoragePublicDirectory 639 * Environment.getExternalStoragePublicDirectory()}, the directory 640 * returned here will be automatically created for you. 641 * 642 * <p>Here is an example of typical code to manipulate a picture in 643 * an application's private storage and add it to the media database:</p> 644 * 645 * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java 646 * private_picture} 647 * <p> 648 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 649 * permissions are required for the owning application to read or write to 650 * this path. Otherwise, {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} 651 * or {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required. 652 * 653 * @param type The type of files directory to return. May be null for 654 * the root of the files directory or one of 655 * the following Environment constants for a subdirectory: 656 * {@link android.os.Environment#DIRECTORY_MUSIC}, 657 * {@link android.os.Environment#DIRECTORY_PODCASTS}, 658 * {@link android.os.Environment#DIRECTORY_RINGTONES}, 659 * {@link android.os.Environment#DIRECTORY_ALARMS}, 660 * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS}, 661 * {@link android.os.Environment#DIRECTORY_PICTURES}, or 662 * {@link android.os.Environment#DIRECTORY_MOVIES}. 663 * 664 * @return The path of the directory holding application files 665 * on external storage. Returns null if external storage is not currently 666 * mounted so it could not ensure the path exists; you will need to call 667 * this method again when it is available. 668 * 669 * @see #getFilesDir 670 * @see android.os.Environment#getExternalStoragePublicDirectory 671 */ 672 public abstract File getExternalFilesDir(String type); 673 674 /** 675 * Returns absolute paths to application-specific directories on all 676 * external storage devices where the application can place persistent files 677 * it owns. These files are internal to the application, and not typically 678 * visible to the user as media. 679 * <p> 680 * External storage devices returned here are considered a permanent part of 681 * the device, including both emulated external storage and physical media 682 * slots. This does not include transient devices, such as USB flash drives. 683 * <p> 684 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 685 * permissions are required for the owning application to read or write to 686 * these paths. 687 * <p> 688 * The returned paths include any path that would be returned by 689 * {@link #getExternalFilesDir(String)}. 690 * 691 * @see #getExternalFilesDir(String) 692 */ 693 public abstract File[] getExternalFilesDirs(String type); 694 695 /** 696 * Return the directory where this application's OBB files (if there are 697 * any) can be found. Note if the application does not have any OBB files, 698 * this directory may not exist. 699 * <p> 700 * On devices with multiple users (as described by {@link UserManager}), 701 * multiple users may share the same OBB storage location. Applications 702 * should ensure that multiple instances running under different users don't 703 * interfere with each other. 704 * <p> 705 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 706 * permissions are required for the owning application to read or write to 707 * this path. Otherwise, 708 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} or 709 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required. 710 */ 711 public abstract File getObbDir(); 712 713 /** 714 * Returns absolute paths to application-specific directories on all 715 * external storage devices where the application's OBB files (if there are 716 * any) can be found. Note if the application does not have any OBB files, 717 * these directories may not exist. 718 * <p> 719 * External storage devices returned here are considered a permanent part of 720 * the device, including both emulated external storage and physical media 721 * slots. This does not include transient devices, such as USB flash drives. 722 * <p> 723 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 724 * permissions are required for the owning application to read or write to 725 * this path. 726 * <p> 727 * The returned paths include any path that would be returned by 728 * {@link #getObbDir()} 729 * 730 * @see #getObbDir() 731 */ 732 public abstract File[] getObbDirs(); 733 734 /** 735 * Returns the absolute path to the application specific cache directory 736 * on the filesystem. These files will be ones that get deleted first when the 737 * device runs low on storage. 738 * There is no guarantee when these files will be deleted. 739 * 740 * <strong>Note: you should not <em>rely</em> on the system deleting these 741 * files for you; you should always have a reasonable maximum, such as 1 MB, 742 * for the amount of space you consume with cache files, and prune those 743 * files when exceeding that space.</strong> 744 * 745 * @return The path of the directory holding application cache files. 746 * 747 * @see #openFileOutput 748 * @see #getFileStreamPath 749 * @see #getDir 750 */ 751 public abstract File getCacheDir(); 752 753 /** 754 * Returns the absolute path to the directory on the external filesystem 755 * (that is somewhere on {@link android.os.Environment#getExternalStorageDirectory() 756 * Environment.getExternalStorageDirectory()} where the application can 757 * place cache files it owns. These files are internal to the application, and 758 * not typically visible to the user as media. 759 * 760 * <p>This is like {@link #getCacheDir()} in that these 761 * files will be deleted when the application is uninstalled, however there 762 * are some important differences: 763 * 764 * <ul> 765 * <li>The platform does not always monitor the space available in external 766 * storage, and thus may not automatically delete these files. Currently 767 * the only time files here will be deleted by the platform is when running 768 * on {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and 769 * {@link android.os.Environment#isExternalStorageEmulated() 770 * Environment.isExternalStorageEmulated()} returns true. Note that you should 771 * be managing the maximum space you will use for these anyway, just like 772 * with {@link #getCacheDir()}. 773 * <li>External files are not always available: they will disappear if the 774 * user mounts the external storage on a computer or removes it. See the 775 * APIs on {@link android.os.Environment} for information in the storage state. 776 * <li>There is no security enforced with these files. All applications 777 * can read and write files placed here. 778 * </ul> 779 * 780 * <p>On devices with multiple users (as described by {@link UserManager}), 781 * each user has their own isolated external storage. Applications only 782 * have access to the external storage for the user they're running as.</p> 783 * <p> 784 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 785 * permissions are required for the owning application to read or write to 786 * this path. Otherwise, 787 * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} or 788 * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required. 789 * 790 * @return The path of the directory holding application cache files 791 * on external storage. Returns null if external storage is not currently 792 * mounted so it could not ensure the path exists; you will need to call 793 * this method again when it is available. 794 * 795 * @see #getCacheDir 796 */ 797 public abstract File getExternalCacheDir(); 798 799 /** 800 * Returns absolute paths to application-specific directories on all 801 * external storage devices where the application can place cache files it 802 * owns. These files are internal to the application, and not typically 803 * visible to the user as media. 804 * <p> 805 * External storage devices returned here are considered a permanent part of 806 * the device, including both emulated external storage and physical media 807 * slots. This does not include transient devices, such as USB flash drives. 808 * <p> 809 * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no 810 * permissions are required for the owning application to read or write to 811 * these paths. 812 * <p> 813 * The returned paths include any path that would be returned by 814 * {@link #getExternalCacheDir()}. 815 * 816 * @see #getExternalCacheDir() 817 */ 818 public abstract File[] getExternalCacheDirs(); 819 820 /** 821 * Returns an array of strings naming the private files associated with 822 * this Context's application package. 823 * 824 * @return Array of strings naming the private files. 825 * 826 * @see #openFileInput 827 * @see #openFileOutput 828 * @see #deleteFile 829 */ 830 public abstract String[] fileList(); 831 832 /** 833 * Retrieve, creating if needed, a new directory in which the application 834 * can place its own custom data files. You can use the returned File 835 * object to create and access files in this directory. Note that files 836 * created through a File object will only be accessible by your own 837 * application; you can only set the mode of the entire directory, not 838 * of individual files. 839 * 840 * @param name Name of the directory to retrieve. This is a directory 841 * that is created as part of your application data. 842 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 843 * default operation, {@link #MODE_WORLD_READABLE} and 844 * {@link #MODE_WORLD_WRITEABLE} to control permissions. 845 * 846 * @return A {@link File} object for the requested directory. The directory 847 * will have been created if it does not already exist. 848 * 849 * @see #openFileOutput(String, int) 850 */ 851 public abstract File getDir(String name, int mode); 852 853 /** 854 * Open a new private SQLiteDatabase associated with this Context's 855 * application package. Create the database file if it doesn't exist. 856 * 857 * @param name The name (unique in the application package) of the database. 858 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 859 * default operation, {@link #MODE_WORLD_READABLE} 860 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 861 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default. 862 * @param factory An optional factory class that is called to instantiate a 863 * cursor when query is called. 864 * 865 * @return The contents of a newly created database with the given name. 866 * @throws android.database.sqlite.SQLiteException if the database file could not be opened. 867 * 868 * @see #MODE_PRIVATE 869 * @see #MODE_WORLD_READABLE 870 * @see #MODE_WORLD_WRITEABLE 871 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING 872 * @see #deleteDatabase 873 */ 874 public abstract SQLiteDatabase openOrCreateDatabase(String name, 875 int mode, CursorFactory factory); 876 877 /** 878 * Open a new private SQLiteDatabase associated with this Context's 879 * application package. Creates the database file if it doesn't exist. 880 * 881 * <p>Accepts input param: a concrete instance of {@link DatabaseErrorHandler} to be 882 * used to handle corruption when sqlite reports database corruption.</p> 883 * 884 * @param name The name (unique in the application package) of the database. 885 * @param mode Operating mode. Use 0 or {@link #MODE_PRIVATE} for the 886 * default operation, {@link #MODE_WORLD_READABLE} 887 * and {@link #MODE_WORLD_WRITEABLE} to control permissions. 888 * Use {@link #MODE_ENABLE_WRITE_AHEAD_LOGGING} to enable write-ahead logging by default. 889 * @param factory An optional factory class that is called to instantiate a 890 * cursor when query is called. 891 * @param errorHandler the {@link DatabaseErrorHandler} to be used when sqlite reports database 892 * corruption. if null, {@link android.database.DefaultDatabaseErrorHandler} is assumed. 893 * @return The contents of a newly created database with the given name. 894 * @throws android.database.sqlite.SQLiteException if the database file could not be opened. 895 * 896 * @see #MODE_PRIVATE 897 * @see #MODE_WORLD_READABLE 898 * @see #MODE_WORLD_WRITEABLE 899 * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING 900 * @see #deleteDatabase 901 */ 902 public abstract SQLiteDatabase openOrCreateDatabase(String name, 903 int mode, CursorFactory factory, DatabaseErrorHandler errorHandler); 904 905 /** 906 * Delete an existing private SQLiteDatabase associated with this Context's 907 * application package. 908 * 909 * @param name The name (unique in the application package) of the 910 * database. 911 * 912 * @return {@code true} if the database was successfully deleted; else {@code false}. 913 * 914 * @see #openOrCreateDatabase 915 */ 916 public abstract boolean deleteDatabase(String name); 917 918 /** 919 * Returns the absolute path on the filesystem where a database created with 920 * {@link #openOrCreateDatabase} is stored. 921 * 922 * @param name The name of the database for which you would like to get 923 * its path. 924 * 925 * @return An absolute path to the given database. 926 * 927 * @see #openOrCreateDatabase 928 */ 929 public abstract File getDatabasePath(String name); 930 931 /** 932 * Returns an array of strings naming the private databases associated with 933 * this Context's application package. 934 * 935 * @return Array of strings naming the private databases. 936 * 937 * @see #openOrCreateDatabase 938 * @see #deleteDatabase 939 */ 940 public abstract String[] databaseList(); 941 942 /** 943 * @deprecated Use {@link android.app.WallpaperManager#getDrawable 944 * WallpaperManager.get()} instead. 945 */ 946 @Deprecated 947 public abstract Drawable getWallpaper(); 948 949 /** 950 * @deprecated Use {@link android.app.WallpaperManager#peekDrawable 951 * WallpaperManager.peek()} instead. 952 */ 953 @Deprecated 954 public abstract Drawable peekWallpaper(); 955 956 /** 957 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth() 958 * WallpaperManager.getDesiredMinimumWidth()} instead. 959 */ 960 @Deprecated 961 public abstract int getWallpaperDesiredMinimumWidth(); 962 963 /** 964 * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight() 965 * WallpaperManager.getDesiredMinimumHeight()} instead. 966 */ 967 @Deprecated 968 public abstract int getWallpaperDesiredMinimumHeight(); 969 970 /** 971 * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap) 972 * WallpaperManager.set()} instead. 973 * <p>This method requires the caller to hold the permission 974 * {@link android.Manifest.permission#SET_WALLPAPER}. 975 */ 976 @Deprecated 977 public abstract void setWallpaper(Bitmap bitmap) throws IOException; 978 979 /** 980 * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream) 981 * WallpaperManager.set()} instead. 982 * <p>This method requires the caller to hold the permission 983 * {@link android.Manifest.permission#SET_WALLPAPER}. 984 */ 985 @Deprecated 986 public abstract void setWallpaper(InputStream data) throws IOException; 987 988 /** 989 * @deprecated Use {@link android.app.WallpaperManager#clear 990 * WallpaperManager.clear()} instead. 991 * <p>This method requires the caller to hold the permission 992 * {@link android.Manifest.permission#SET_WALLPAPER}. 993 */ 994 @Deprecated 995 public abstract void clearWallpaper() throws IOException; 996 997 /** 998 * Same as {@link #startActivity(Intent, Bundle)} with no options 999 * specified. 1000 * 1001 * @param intent The description of the activity to start. 1002 * 1003 * @throws ActivityNotFoundException 1004 * 1005 * @see #startActivity(Intent, Bundle) 1006 * @see PackageManager#resolveActivity 1007 */ 1008 public abstract void startActivity(Intent intent); 1009 1010 /** 1011 * Version of {@link #startActivity(Intent)} that allows you to specify the 1012 * user the activity will be started for. This is not available to applications 1013 * that are not pre-installed on the system image. Using it requires holding 1014 * the INTERACT_ACROSS_USERS_FULL permission. 1015 * @param intent The description of the activity to start. 1016 * @param user The UserHandle of the user to start this activity for. 1017 * @throws ActivityNotFoundException 1018 * @hide 1019 */ 1020 public void startActivityAsUser(Intent intent, UserHandle user) { 1021 throw new RuntimeException("Not implemented. Must override in a subclass."); 1022 } 1023 1024 /** 1025 * Launch a new activity. You will not receive any information about when 1026 * the activity exits. 1027 * 1028 * <p>Note that if this method is being called from outside of an 1029 * {@link android.app.Activity} Context, then the Intent must include 1030 * the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag. This is because, 1031 * without being started from an existing Activity, there is no existing 1032 * task in which to place the new activity and thus it needs to be placed 1033 * in its own separate task. 1034 * 1035 * <p>This method throws {@link ActivityNotFoundException} 1036 * if there was no Activity found to run the given Intent. 1037 * 1038 * @param intent The description of the activity to start. 1039 * @param options Additional options for how the Activity should be started. 1040 * May be null if there are no options. See {@link android.app.ActivityOptions} 1041 * for how to build the Bundle supplied here; there are no supported definitions 1042 * for building it manually. 1043 * 1044 * @throws ActivityNotFoundException 1045 * 1046 * @see #startActivity(Intent) 1047 * @see PackageManager#resolveActivity 1048 */ 1049 public abstract void startActivity(Intent intent, Bundle options); 1050 1051 /** 1052 * Version of {@link #startActivity(Intent, Bundle)} that allows you to specify the 1053 * user the activity will be started for. This is not available to applications 1054 * that are not pre-installed on the system image. Using it requires holding 1055 * the INTERACT_ACROSS_USERS_FULL permission. 1056 * @param intent The description of the activity to start. 1057 * @param options Additional options for how the Activity should be started. 1058 * May be null if there are no options. See {@link android.app.ActivityOptions} 1059 * for how to build the Bundle supplied here; there are no supported definitions 1060 * for building it manually. 1061 * @param userId The UserHandle of the user to start this activity for. 1062 * @throws ActivityNotFoundException 1063 * @hide 1064 */ 1065 public void startActivityAsUser(Intent intent, Bundle options, UserHandle userId) { 1066 throw new RuntimeException("Not implemented. Must override in a subclass."); 1067 } 1068 1069 /** 1070 * Same as {@link #startActivities(Intent[], Bundle)} with no options 1071 * specified. 1072 * 1073 * @param intents An array of Intents to be started. 1074 * 1075 * @throws ActivityNotFoundException 1076 * 1077 * @see #startActivities(Intent[], Bundle) 1078 * @see PackageManager#resolveActivity 1079 */ 1080 public abstract void startActivities(Intent[] intents); 1081 1082 /** 1083 * Launch multiple new activities. This is generally the same as calling 1084 * {@link #startActivity(Intent)} for the first Intent in the array, 1085 * that activity during its creation calling {@link #startActivity(Intent)} 1086 * for the second entry, etc. Note that unlike that approach, generally 1087 * none of the activities except the last in the array will be created 1088 * at this point, but rather will be created when the user first visits 1089 * them (due to pressing back from the activity on top). 1090 * 1091 * <p>This method throws {@link ActivityNotFoundException} 1092 * if there was no Activity found for <em>any</em> given Intent. In this 1093 * case the state of the activity stack is undefined (some Intents in the 1094 * list may be on it, some not), so you probably want to avoid such situations. 1095 * 1096 * @param intents An array of Intents to be started. 1097 * @param options Additional options for how the Activity should be started. 1098 * See {@link android.content.Context#startActivity(Intent, Bundle) 1099 * Context.startActivity(Intent, Bundle)} for more details. 1100 * 1101 * @throws ActivityNotFoundException 1102 * 1103 * @see #startActivities(Intent[]) 1104 * @see PackageManager#resolveActivity 1105 */ 1106 public abstract void startActivities(Intent[] intents, Bundle options); 1107 1108 /** 1109 * @hide 1110 * Launch multiple new activities. This is generally the same as calling 1111 * {@link #startActivity(Intent)} for the first Intent in the array, 1112 * that activity during its creation calling {@link #startActivity(Intent)} 1113 * for the second entry, etc. Note that unlike that approach, generally 1114 * none of the activities except the last in the array will be created 1115 * at this point, but rather will be created when the user first visits 1116 * them (due to pressing back from the activity on top). 1117 * 1118 * <p>This method throws {@link ActivityNotFoundException} 1119 * if there was no Activity found for <em>any</em> given Intent. In this 1120 * case the state of the activity stack is undefined (some Intents in the 1121 * list may be on it, some not), so you probably want to avoid such situations. 1122 * 1123 * @param intents An array of Intents to be started. 1124 * @param options Additional options for how the Activity should be started. 1125 * @param userHandle The user for whom to launch the activities 1126 * See {@link android.content.Context#startActivity(Intent, Bundle) 1127 * Context.startActivity(Intent, Bundle)} for more details. 1128 * 1129 * @throws ActivityNotFoundException 1130 * 1131 * @see #startActivities(Intent[]) 1132 * @see PackageManager#resolveActivity 1133 */ 1134 public void startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle) { 1135 throw new RuntimeException("Not implemented. Must override in a subclass."); 1136 } 1137 1138 /** 1139 * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)} 1140 * with no options specified. 1141 * 1142 * @param intent The IntentSender to launch. 1143 * @param fillInIntent If non-null, this will be provided as the 1144 * intent parameter to {@link IntentSender#sendIntent}. 1145 * @param flagsMask Intent flags in the original IntentSender that you 1146 * would like to change. 1147 * @param flagsValues Desired values for any bits set in 1148 * <var>flagsMask</var> 1149 * @param extraFlags Always set to 0. 1150 * 1151 * @see #startActivity(Intent) 1152 * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle) 1153 */ 1154 public abstract void startIntentSender(IntentSender intent, 1155 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) 1156 throws IntentSender.SendIntentException; 1157 1158 /** 1159 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender 1160 * to start. If the IntentSender is for an activity, that activity will be started 1161 * as if you had called the regular {@link #startActivity(Intent)} 1162 * here; otherwise, its associated action will be executed (such as 1163 * sending a broadcast) as if you had called 1164 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it. 1165 * 1166 * @param intent The IntentSender to launch. 1167 * @param fillInIntent If non-null, this will be provided as the 1168 * intent parameter to {@link IntentSender#sendIntent}. 1169 * @param flagsMask Intent flags in the original IntentSender that you 1170 * would like to change. 1171 * @param flagsValues Desired values for any bits set in 1172 * <var>flagsMask</var> 1173 * @param extraFlags Always set to 0. 1174 * @param options Additional options for how the Activity should be started. 1175 * See {@link android.content.Context#startActivity(Intent, Bundle) 1176 * Context.startActivity(Intent, Bundle)} for more details. If options 1177 * have also been supplied by the IntentSender, options given here will 1178 * override any that conflict with those given by the IntentSender. 1179 * 1180 * @see #startActivity(Intent, Bundle) 1181 * @see #startIntentSender(IntentSender, Intent, int, int, int) 1182 */ 1183 public abstract void startIntentSender(IntentSender intent, 1184 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, 1185 Bundle options) throws IntentSender.SendIntentException; 1186 1187 /** 1188 * Broadcast the given intent to all interested BroadcastReceivers. This 1189 * call is asynchronous; it returns immediately, and you will continue 1190 * executing while the receivers are run. No results are propagated from 1191 * receivers and receivers can not abort the broadcast. If you want 1192 * to allow receivers to propagate results or abort the broadcast, you must 1193 * send an ordered broadcast using 1194 * {@link #sendOrderedBroadcast(Intent, String)}. 1195 * 1196 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1197 * 1198 * @param intent The Intent to broadcast; all receivers matching this 1199 * Intent will receive the broadcast. 1200 * 1201 * @see android.content.BroadcastReceiver 1202 * @see #registerReceiver 1203 * @see #sendBroadcast(Intent, String) 1204 * @see #sendOrderedBroadcast(Intent, String) 1205 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1206 */ 1207 public abstract void sendBroadcast(Intent intent); 1208 1209 /** 1210 * Broadcast the given intent to all interested BroadcastReceivers, allowing 1211 * an optional required permission to be enforced. This 1212 * call is asynchronous; it returns immediately, and you will continue 1213 * executing while the receivers are run. No results are propagated from 1214 * receivers and receivers can not abort the broadcast. If you want 1215 * to allow receivers to propagate results or abort the broadcast, you must 1216 * send an ordered broadcast using 1217 * {@link #sendOrderedBroadcast(Intent, String)}. 1218 * 1219 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1220 * 1221 * @param intent The Intent to broadcast; all receivers matching this 1222 * Intent will receive the broadcast. 1223 * @param receiverPermission (optional) String naming a permission that 1224 * a receiver must hold in order to receive your broadcast. 1225 * If null, no permission is required. 1226 * 1227 * @see android.content.BroadcastReceiver 1228 * @see #registerReceiver 1229 * @see #sendBroadcast(Intent) 1230 * @see #sendOrderedBroadcast(Intent, String) 1231 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1232 */ 1233 public abstract void sendBroadcast(Intent intent, 1234 String receiverPermission); 1235 1236 /** 1237 * Like {@link #sendBroadcast(Intent, String)}, but also allows specification 1238 * of an assocated app op as per {@link android.app.AppOpsManager}. 1239 * @hide 1240 */ 1241 public abstract void sendBroadcast(Intent intent, 1242 String receiverPermission, int appOp); 1243 1244 /** 1245 * Broadcast the given intent to all interested BroadcastReceivers, delivering 1246 * them one at a time to allow more preferred receivers to consume the 1247 * broadcast before it is delivered to less preferred receivers. This 1248 * call is asynchronous; it returns immediately, and you will continue 1249 * executing while the receivers are run. 1250 * 1251 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1252 * 1253 * @param intent The Intent to broadcast; all receivers matching this 1254 * Intent will receive the broadcast. 1255 * @param receiverPermission (optional) String naming a permissions that 1256 * a receiver must hold in order to receive your broadcast. 1257 * If null, no permission is required. 1258 * 1259 * @see android.content.BroadcastReceiver 1260 * @see #registerReceiver 1261 * @see #sendBroadcast(Intent) 1262 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1263 */ 1264 public abstract void sendOrderedBroadcast(Intent intent, 1265 String receiverPermission); 1266 1267 /** 1268 * Version of {@link #sendBroadcast(Intent)} that allows you to 1269 * receive data back from the broadcast. This is accomplished by 1270 * supplying your own BroadcastReceiver when calling, which will be 1271 * treated as a final receiver at the end of the broadcast -- its 1272 * {@link BroadcastReceiver#onReceive} method will be called with 1273 * the result values collected from the other receivers. The broadcast will 1274 * be serialized in the same way as calling 1275 * {@link #sendOrderedBroadcast(Intent, String)}. 1276 * 1277 * <p>Like {@link #sendBroadcast(Intent)}, this method is 1278 * asynchronous; it will return before 1279 * resultReceiver.onReceive() is called. 1280 * 1281 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1282 * 1283 * @param intent The Intent to broadcast; all receivers matching this 1284 * Intent will receive the broadcast. 1285 * @param receiverPermission String naming a permissions that 1286 * a receiver must hold in order to receive your broadcast. 1287 * If null, no permission is required. 1288 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1289 * receiver of the broadcast. 1290 * @param scheduler A custom Handler with which to schedule the 1291 * resultReceiver callback; if null it will be 1292 * scheduled in the Context's main thread. 1293 * @param initialCode An initial value for the result code. Often 1294 * Activity.RESULT_OK. 1295 * @param initialData An initial value for the result data. Often 1296 * null. 1297 * @param initialExtras An initial value for the result extras. Often 1298 * null. 1299 * 1300 * @see #sendBroadcast(Intent) 1301 * @see #sendBroadcast(Intent, String) 1302 * @see #sendOrderedBroadcast(Intent, String) 1303 * @see #sendStickyBroadcast(Intent) 1304 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) 1305 * @see android.content.BroadcastReceiver 1306 * @see #registerReceiver 1307 * @see android.app.Activity#RESULT_OK 1308 */ 1309 public abstract void sendOrderedBroadcast(Intent intent, 1310 String receiverPermission, BroadcastReceiver resultReceiver, 1311 Handler scheduler, int initialCode, String initialData, 1312 Bundle initialExtras); 1313 1314 /** 1315 * Like {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, 1316 * int, String, android.os.Bundle)}, but also allows specification 1317 * of an assocated app op as per {@link android.app.AppOpsManager}. 1318 * @hide 1319 */ 1320 public abstract void sendOrderedBroadcast(Intent intent, 1321 String receiverPermission, int appOp, BroadcastReceiver resultReceiver, 1322 Handler scheduler, int initialCode, String initialData, 1323 Bundle initialExtras); 1324 1325 /** 1326 * Version of {@link #sendBroadcast(Intent)} that allows you to specify the 1327 * user the broadcast will be sent to. This is not available to applications 1328 * that are not pre-installed on the system image. Using it requires holding 1329 * the INTERACT_ACROSS_USERS permission. 1330 * @param intent The intent to broadcast 1331 * @param user UserHandle to send the intent to. 1332 * @see #sendBroadcast(Intent) 1333 */ 1334 public abstract void sendBroadcastAsUser(Intent intent, UserHandle user); 1335 1336 /** 1337 * Version of {@link #sendBroadcast(Intent, String)} that allows you to specify the 1338 * user the broadcast will be sent to. This is not available to applications 1339 * that are not pre-installed on the system image. Using it requires holding 1340 * the INTERACT_ACROSS_USERS permission. 1341 * 1342 * @param intent The Intent to broadcast; all receivers matching this 1343 * Intent will receive the broadcast. 1344 * @param user UserHandle to send the intent to. 1345 * @param receiverPermission (optional) String naming a permission that 1346 * a receiver must hold in order to receive your broadcast. 1347 * If null, no permission is required. 1348 * 1349 * @see #sendBroadcast(Intent, String) 1350 */ 1351 public abstract void sendBroadcastAsUser(Intent intent, UserHandle user, 1352 String receiverPermission); 1353 1354 /** 1355 * Version of 1356 * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)} 1357 * that allows you to specify the 1358 * user the broadcast will be sent to. This is not available to applications 1359 * that are not pre-installed on the system image. Using it requires holding 1360 * the INTERACT_ACROSS_USERS permission. 1361 * 1362 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1363 * 1364 * @param intent The Intent to broadcast; all receivers matching this 1365 * Intent will receive the broadcast. 1366 * @param user UserHandle to send the intent to. 1367 * @param receiverPermission String naming a permissions that 1368 * a receiver must hold in order to receive your broadcast. 1369 * If null, no permission is required. 1370 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1371 * receiver of the broadcast. 1372 * @param scheduler A custom Handler with which to schedule the 1373 * resultReceiver callback; if null it will be 1374 * scheduled in the Context's main thread. 1375 * @param initialCode An initial value for the result code. Often 1376 * Activity.RESULT_OK. 1377 * @param initialData An initial value for the result data. Often 1378 * null. 1379 * @param initialExtras An initial value for the result extras. Often 1380 * null. 1381 * 1382 * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) 1383 */ 1384 public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, 1385 String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, 1386 int initialCode, String initialData, Bundle initialExtras); 1387 1388 /** 1389 * Perform a {@link #sendBroadcast(Intent)} that is "sticky," meaning the 1390 * Intent you are sending stays around after the broadcast is complete, 1391 * so that others can quickly retrieve that data through the return 1392 * value of {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In 1393 * all other ways, this behaves the same as 1394 * {@link #sendBroadcast(Intent)}. 1395 * 1396 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 1397 * permission in order to use this API. If you do not hold that 1398 * permission, {@link SecurityException} will be thrown. 1399 * 1400 * @param intent The Intent to broadcast; all receivers matching this 1401 * Intent will receive the broadcast, and the Intent will be held to 1402 * be re-broadcast to future receivers. 1403 * 1404 * @see #sendBroadcast(Intent) 1405 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) 1406 */ 1407 public abstract void sendStickyBroadcast(Intent intent); 1408 1409 /** 1410 * Version of {@link #sendStickyBroadcast} that allows you to 1411 * receive data back from the broadcast. This is accomplished by 1412 * supplying your own BroadcastReceiver when calling, which will be 1413 * treated as a final receiver at the end of the broadcast -- its 1414 * {@link BroadcastReceiver#onReceive} method will be called with 1415 * the result values collected from the other receivers. The broadcast will 1416 * be serialized in the same way as calling 1417 * {@link #sendOrderedBroadcast(Intent, String)}. 1418 * 1419 * <p>Like {@link #sendBroadcast(Intent)}, this method is 1420 * asynchronous; it will return before 1421 * resultReceiver.onReceive() is called. Note that the sticky data 1422 * stored is only the data you initially supply to the broadcast, not 1423 * the result of any changes made by the receivers. 1424 * 1425 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1426 * 1427 * @param intent The Intent to broadcast; all receivers matching this 1428 * Intent will receive the broadcast. 1429 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1430 * receiver of the broadcast. 1431 * @param scheduler A custom Handler with which to schedule the 1432 * resultReceiver callback; if null it will be 1433 * scheduled in the Context's main thread. 1434 * @param initialCode An initial value for the result code. Often 1435 * Activity.RESULT_OK. 1436 * @param initialData An initial value for the result data. Often 1437 * null. 1438 * @param initialExtras An initial value for the result extras. Often 1439 * null. 1440 * 1441 * @see #sendBroadcast(Intent) 1442 * @see #sendBroadcast(Intent, String) 1443 * @see #sendOrderedBroadcast(Intent, String) 1444 * @see #sendStickyBroadcast(Intent) 1445 * @see android.content.BroadcastReceiver 1446 * @see #registerReceiver 1447 * @see android.app.Activity#RESULT_OK 1448 */ 1449 public abstract void sendStickyOrderedBroadcast(Intent intent, 1450 BroadcastReceiver resultReceiver, 1451 Handler scheduler, int initialCode, String initialData, 1452 Bundle initialExtras); 1453 1454 /** 1455 * Remove the data previously sent with {@link #sendStickyBroadcast}, 1456 * so that it is as if the sticky broadcast had never happened. 1457 * 1458 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 1459 * permission in order to use this API. If you do not hold that 1460 * permission, {@link SecurityException} will be thrown. 1461 * 1462 * @param intent The Intent that was previously broadcast. 1463 * 1464 * @see #sendStickyBroadcast 1465 */ 1466 public abstract void removeStickyBroadcast(Intent intent); 1467 1468 /** 1469 * Version of {@link #sendStickyBroadcast(Intent)} that allows you to specify the 1470 * user the broadcast will be sent to. This is not available to applications 1471 * that are not pre-installed on the system image. Using it requires holding 1472 * the INTERACT_ACROSS_USERS permission. 1473 * 1474 * @param intent The Intent to broadcast; all receivers matching this 1475 * Intent will receive the broadcast, and the Intent will be held to 1476 * be re-broadcast to future receivers. 1477 * @param user UserHandle to send the intent to. 1478 * 1479 * @see #sendBroadcast(Intent) 1480 */ 1481 public abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user); 1482 1483 /** 1484 * Version of 1485 * {@link #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)} 1486 * that allows you to specify the 1487 * user the broadcast will be sent to. This is not available to applications 1488 * that are not pre-installed on the system image. Using it requires holding 1489 * the INTERACT_ACROSS_USERS permission. 1490 * 1491 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1492 * 1493 * @param intent The Intent to broadcast; all receivers matching this 1494 * Intent will receive the broadcast. 1495 * @param user UserHandle to send the intent to. 1496 * @param resultReceiver Your own BroadcastReceiver to treat as the final 1497 * receiver of the broadcast. 1498 * @param scheduler A custom Handler with which to schedule the 1499 * resultReceiver callback; if null it will be 1500 * scheduled in the Context's main thread. 1501 * @param initialCode An initial value for the result code. Often 1502 * Activity.RESULT_OK. 1503 * @param initialData An initial value for the result data. Often 1504 * null. 1505 * @param initialExtras An initial value for the result extras. Often 1506 * null. 1507 * 1508 * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) 1509 */ 1510 public abstract void sendStickyOrderedBroadcastAsUser(Intent intent, 1511 UserHandle user, BroadcastReceiver resultReceiver, 1512 Handler scheduler, int initialCode, String initialData, 1513 Bundle initialExtras); 1514 1515 /** 1516 * Version of {@link #removeStickyBroadcast(Intent)} that allows you to specify the 1517 * user the broadcast will be sent to. This is not available to applications 1518 * that are not pre-installed on the system image. Using it requires holding 1519 * the INTERACT_ACROSS_USERS permission. 1520 * 1521 * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} 1522 * permission in order to use this API. If you do not hold that 1523 * permission, {@link SecurityException} will be thrown. 1524 * 1525 * @param intent The Intent that was previously broadcast. 1526 * @param user UserHandle to remove the sticky broadcast from. 1527 * 1528 * @see #sendStickyBroadcastAsUser 1529 */ 1530 public abstract void removeStickyBroadcastAsUser(Intent intent, UserHandle user); 1531 1532 /** 1533 * Register a BroadcastReceiver to be run in the main activity thread. The 1534 * <var>receiver</var> will be called with any broadcast Intent that 1535 * matches <var>filter</var>, in the main application thread. 1536 * 1537 * <p>The system may broadcast Intents that are "sticky" -- these stay 1538 * around after the broadcast as finished, to be sent to any later 1539 * registrations. If your IntentFilter matches one of these sticky 1540 * Intents, that Intent will be returned by this function 1541 * <strong>and</strong> sent to your <var>receiver</var> as if it had just 1542 * been broadcast. 1543 * 1544 * <p>There may be multiple sticky Intents that match <var>filter</var>, 1545 * in which case each of these will be sent to <var>receiver</var>. In 1546 * this case, only one of these can be returned directly by the function; 1547 * which of these that is returned is arbitrarily decided by the system. 1548 * 1549 * <p>If you know the Intent your are registering for is sticky, you can 1550 * supply null for your <var>receiver</var>. In this case, no receiver is 1551 * registered -- the function simply returns the sticky Intent that 1552 * matches <var>filter</var>. In the case of multiple matches, the same 1553 * rules as described above apply. 1554 * 1555 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1556 * 1557 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers 1558 * registered with this method will correctly respect the 1559 * {@link Intent#setPackage(String)} specified for an Intent being broadcast. 1560 * Prior to that, it would be ignored and delivered to all matching registered 1561 * receivers. Be careful if using this for security.</p> 1562 * 1563 * <p class="note">Note: this method <em>cannot be called from a 1564 * {@link BroadcastReceiver} component;</em> that is, from a BroadcastReceiver 1565 * that is declared in an application's manifest. It is okay, however, to call 1566 * this method from another BroadcastReceiver that has itself been registered 1567 * at run time with {@link #registerReceiver}, since the lifetime of such a 1568 * registered BroadcastReceiver is tied to the object that registered it.</p> 1569 * 1570 * @param receiver The BroadcastReceiver to handle the broadcast. 1571 * @param filter Selects the Intent broadcasts to be received. 1572 * 1573 * @return The first sticky intent found that matches <var>filter</var>, 1574 * or null if there are none. 1575 * 1576 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) 1577 * @see #sendBroadcast 1578 * @see #unregisterReceiver 1579 */ 1580 public abstract Intent registerReceiver(BroadcastReceiver receiver, 1581 IntentFilter filter); 1582 1583 /** 1584 * Register to receive intent broadcasts, to run in the context of 1585 * <var>scheduler</var>. See 1586 * {@link #registerReceiver(BroadcastReceiver, IntentFilter)} for more 1587 * information. This allows you to enforce permissions on who can 1588 * broadcast intents to your receiver, or have the receiver run in 1589 * a different thread than the main application thread. 1590 * 1591 * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. 1592 * 1593 * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers 1594 * registered with this method will correctly respect the 1595 * {@link Intent#setPackage(String)} specified for an Intent being broadcast. 1596 * Prior to that, it would be ignored and delivered to all matching registered 1597 * receivers. Be careful if using this for security.</p> 1598 * 1599 * @param receiver The BroadcastReceiver to handle the broadcast. 1600 * @param filter Selects the Intent broadcasts to be received. 1601 * @param broadcastPermission String naming a permissions that a 1602 * broadcaster must hold in order to send an Intent to you. If null, 1603 * no permission is required. 1604 * @param scheduler Handler identifying the thread that will receive 1605 * the Intent. If null, the main thread of the process will be used. 1606 * 1607 * @return The first sticky intent found that matches <var>filter</var>, 1608 * or null if there are none. 1609 * 1610 * @see #registerReceiver(BroadcastReceiver, IntentFilter) 1611 * @see #sendBroadcast 1612 * @see #unregisterReceiver 1613 */ 1614 public abstract Intent registerReceiver(BroadcastReceiver receiver, 1615 IntentFilter filter, String broadcastPermission, Handler scheduler); 1616 1617 /** 1618 * @hide 1619 * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) 1620 * but for a specific user. This receiver will receiver broadcasts that 1621 * are sent to the requested user. It 1622 * requires holding the {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} 1623 * permission. 1624 * 1625 * @param receiver The BroadcastReceiver to handle the broadcast. 1626 * @param user UserHandle to send the intent to. 1627 * @param filter Selects the Intent broadcasts to be received. 1628 * @param broadcastPermission String naming a permissions that a 1629 * broadcaster must hold in order to send an Intent to you. If null, 1630 * no permission is required. 1631 * @param scheduler Handler identifying the thread that will receive 1632 * the Intent. If null, the main thread of the process will be used. 1633 * 1634 * @return The first sticky intent found that matches <var>filter</var>, 1635 * or null if there are none. 1636 * 1637 * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler 1638 * @see #sendBroadcast 1639 * @see #unregisterReceiver 1640 */ 1641 public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver, 1642 UserHandle user, IntentFilter filter, String broadcastPermission, 1643 Handler scheduler); 1644 1645 /** 1646 * Unregister a previously registered BroadcastReceiver. <em>All</em> 1647 * filters that have been registered for this BroadcastReceiver will be 1648 * removed. 1649 * 1650 * @param receiver The BroadcastReceiver to unregister. 1651 * 1652 * @see #registerReceiver 1653 */ 1654 public abstract void unregisterReceiver(BroadcastReceiver receiver); 1655 1656 /** 1657 * Request that a given application service be started. The Intent 1658 * should contain either contain the complete class name of a specific service 1659 * implementation to start or a specific package name to target. If the 1660 * Intent is less specified, it log a warning about this and which of the 1661 * multiple matching services it finds and uses will be undefined. If this service 1662 * is not already running, it will be instantiated and started (creating a 1663 * process for it if needed); if it is running then it remains running. 1664 * 1665 * <p>Every call to this method will result in a corresponding call to 1666 * the target service's {@link android.app.Service#onStartCommand} method, 1667 * with the <var>intent</var> given here. This provides a convenient way 1668 * to submit jobs to a service without having to bind and call on to its 1669 * interface. 1670 * 1671 * <p>Using startService() overrides the default service lifetime that is 1672 * managed by {@link #bindService}: it requires the service to remain 1673 * running until {@link #stopService} is called, regardless of whether 1674 * any clients are connected to it. Note that calls to startService() 1675 * are not nesting: no matter how many times you call startService(), 1676 * a single call to {@link #stopService} will stop it. 1677 * 1678 * <p>The system attempts to keep running services around as much as 1679 * possible. The only time they should be stopped is if the current 1680 * foreground application is using so many resources that the service needs 1681 * to be killed. If any errors happen in the service's process, it will 1682 * automatically be restarted. 1683 * 1684 * <p>This function will throw {@link SecurityException} if you do not 1685 * have permission to start the given service. 1686 * 1687 * @param service Identifies the service to be started. The Intent must be either 1688 * fully explicit (supplying a component name) or specify a specific package 1689 * name it is targetted to. Additional values 1690 * may be included in the Intent extras to supply arguments along with 1691 * this specific start call. 1692 * 1693 * @return If the service is being started or is already running, the 1694 * {@link ComponentName} of the actual service that was started is 1695 * returned; else if the service does not exist null is returned. 1696 * 1697 * @throws SecurityException 1698 * 1699 * @see #stopService 1700 * @see #bindService 1701 */ 1702 public abstract ComponentName startService(Intent service); 1703 1704 /** 1705 * Request that a given application service be stopped. If the service is 1706 * not running, nothing happens. Otherwise it is stopped. Note that calls 1707 * to startService() are not counted -- this stops the service no matter 1708 * how many times it was started. 1709 * 1710 * <p>Note that if a stopped service still has {@link ServiceConnection} 1711 * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will 1712 * not be destroyed until all of these bindings are removed. See 1713 * the {@link android.app.Service} documentation for more details on a 1714 * service's lifecycle. 1715 * 1716 * <p>This function will throw {@link SecurityException} if you do not 1717 * have permission to stop the given service. 1718 * 1719 * @param service Description of the service to be stopped. The Intent must be either 1720 * fully explicit (supplying a component name) or specify a specific package 1721 * name it is targetted to. 1722 * 1723 * @return If there is a service matching the given Intent that is already 1724 * running, then it is stopped and {@code true} is returned; else {@code false} is returned. 1725 * 1726 * @throws SecurityException 1727 * 1728 * @see #startService 1729 */ 1730 public abstract boolean stopService(Intent service); 1731 1732 /** 1733 * @hide like {@link #startService(Intent)} but for a specific user. 1734 */ 1735 public abstract ComponentName startServiceAsUser(Intent service, UserHandle user); 1736 1737 /** 1738 * @hide like {@link #stopService(Intent)} but for a specific user. 1739 */ 1740 public abstract boolean stopServiceAsUser(Intent service, UserHandle user); 1741 1742 /** 1743 * Connect to an application service, creating it if needed. This defines 1744 * a dependency between your application and the service. The given 1745 * <var>conn</var> will receive the service object when it is created and be 1746 * told if it dies and restarts. The service will be considered required 1747 * by the system only for as long as the calling context exists. For 1748 * example, if this Context is an Activity that is stopped, the service will 1749 * not be required to continue running until the Activity is resumed. 1750 * 1751 * <p>This function will throw {@link SecurityException} if you do not 1752 * have permission to bind to the given service. 1753 * 1754 * <p class="note">Note: this method <em>can not be called from a 1755 * {@link BroadcastReceiver} component</em>. A pattern you can use to 1756 * communicate from a BroadcastReceiver to a Service is to call 1757 * {@link #startService} with the arguments containing the command to be 1758 * sent, with the service calling its 1759 * {@link android.app.Service#stopSelf(int)} method when done executing 1760 * that command. See the API demo App/Service/Service Start Arguments 1761 * Controller for an illustration of this. It is okay, however, to use 1762 * this method from a BroadcastReceiver that has been registered with 1763 * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver 1764 * is tied to another object (the one that registered it).</p> 1765 * 1766 * @param service Identifies the service to connect to. The Intent may 1767 * specify either an explicit component name, or a logical 1768 * description (action, category, etc) to match an 1769 * {@link IntentFilter} published by a service. 1770 * @param conn Receives information as the service is started and stopped. 1771 * This must be a valid ServiceConnection object; it must not be null. 1772 * @param flags Operation options for the binding. May be 0, 1773 * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND}, 1774 * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT}, 1775 * {@link #BIND_ALLOW_OOM_MANAGEMENT}, or 1776 * {@link #BIND_WAIVE_PRIORITY}. 1777 * @return If you have successfully bound to the service, {@code true} is returned; 1778 * {@code false} is returned if the connection is not made so you will not 1779 * receive the service object. 1780 * 1781 * @throws SecurityException 1782 * 1783 * @see #unbindService 1784 * @see #startService 1785 * @see #BIND_AUTO_CREATE 1786 * @see #BIND_DEBUG_UNBIND 1787 * @see #BIND_NOT_FOREGROUND 1788 */ 1789 public abstract boolean bindService(Intent service, ServiceConnection conn, 1790 int flags); 1791 1792 /** 1793 * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle 1794 * argument for use by system server and other multi-user aware code. 1795 * @hide 1796 */ 1797 public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user) { 1798 throw new RuntimeException("Not implemented. Must override in a subclass."); 1799 } 1800 1801 /** 1802 * Disconnect from an application service. You will no longer receive 1803 * calls as the service is restarted, and the service is now allowed to 1804 * stop at any time. 1805 * 1806 * @param conn The connection interface previously supplied to 1807 * bindService(). This parameter must not be null. 1808 * 1809 * @see #bindService 1810 */ 1811 public abstract void unbindService(ServiceConnection conn); 1812 1813 /** 1814 * Start executing an {@link android.app.Instrumentation} class. The given 1815 * Instrumentation component will be run by killing its target application 1816 * (if currently running), starting the target process, instantiating the 1817 * instrumentation component, and then letting it drive the application. 1818 * 1819 * <p>This function is not synchronous -- it returns as soon as the 1820 * instrumentation has started and while it is running. 1821 * 1822 * <p>Instrumentation is normally only allowed to run against a package 1823 * that is either unsigned or signed with a signature that the 1824 * the instrumentation package is also signed with (ensuring the target 1825 * trusts the instrumentation). 1826 * 1827 * @param className Name of the Instrumentation component to be run. 1828 * @param profileFile Optional path to write profiling data as the 1829 * instrumentation runs, or null for no profiling. 1830 * @param arguments Additional optional arguments to pass to the 1831 * instrumentation, or null. 1832 * 1833 * @return {@code true} if the instrumentation was successfully started, 1834 * else {@code false} if it could not be found. 1835 */ 1836 public abstract boolean startInstrumentation(ComponentName className, 1837 String profileFile, Bundle arguments); 1838 1839 /** 1840 * Return the handle to a system-level service by name. The class of the 1841 * returned object varies by the requested name. Currently available names 1842 * are: 1843 * 1844 * <dl> 1845 * <dt> {@link #WINDOW_SERVICE} ("window") 1846 * <dd> The top-level window manager in which you can place custom 1847 * windows. The returned object is a {@link android.view.WindowManager}. 1848 * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater") 1849 * <dd> A {@link android.view.LayoutInflater} for inflating layout resources 1850 * in this context. 1851 * <dt> {@link #ACTIVITY_SERVICE} ("activity") 1852 * <dd> A {@link android.app.ActivityManager} for interacting with the 1853 * global activity state of the system. 1854 * <dt> {@link #POWER_SERVICE} ("power") 1855 * <dd> A {@link android.os.PowerManager} for controlling power 1856 * management. 1857 * <dt> {@link #ALARM_SERVICE} ("alarm") 1858 * <dd> A {@link android.app.AlarmManager} for receiving intents at the 1859 * time of your choosing. 1860 * <dt> {@link #NOTIFICATION_SERVICE} ("notification") 1861 * <dd> A {@link android.app.NotificationManager} for informing the user 1862 * of background events. 1863 * <dt> {@link #KEYGUARD_SERVICE} ("keyguard") 1864 * <dd> A {@link android.app.KeyguardManager} for controlling keyguard. 1865 * <dt> {@link #LOCATION_SERVICE} ("location") 1866 * <dd> A {@link android.location.LocationManager} for controlling location 1867 * (e.g., GPS) updates. 1868 * <dt> {@link #SEARCH_SERVICE} ("search") 1869 * <dd> A {@link android.app.SearchManager} for handling search. 1870 * <dt> {@link #VIBRATOR_SERVICE} ("vibrator") 1871 * <dd> A {@link android.os.Vibrator} for interacting with the vibrator 1872 * hardware. 1873 * <dt> {@link #CONNECTIVITY_SERVICE} ("connection") 1874 * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for 1875 * handling management of network connections. 1876 * <dt> {@link #WIFI_SERVICE} ("wifi") 1877 * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of 1878 * Wi-Fi connectivity. 1879 * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method") 1880 * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager} 1881 * for management of input methods. 1882 * <dt> {@link #UI_MODE_SERVICE} ("uimode") 1883 * <dd> An {@link android.app.UiModeManager} for controlling UI modes. 1884 * <dt> {@link #DOWNLOAD_SERVICE} ("download") 1885 * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads 1886 * </dl> 1887 * 1888 * <p>Note: System services obtained via this API may be closely associated with 1889 * the Context in which they are obtained from. In general, do not share the 1890 * service objects between various different contexts (Activities, Applications, 1891 * Services, Providers, etc.) 1892 * 1893 * @param name The name of the desired service. 1894 * 1895 * @return The service or null if the name does not exist. 1896 * 1897 * @see #WINDOW_SERVICE 1898 * @see android.view.WindowManager 1899 * @see #LAYOUT_INFLATER_SERVICE 1900 * @see android.view.LayoutInflater 1901 * @see #ACTIVITY_SERVICE 1902 * @see android.app.ActivityManager 1903 * @see #POWER_SERVICE 1904 * @see android.os.PowerManager 1905 * @see #ALARM_SERVICE 1906 * @see android.app.AlarmManager 1907 * @see #NOTIFICATION_SERVICE 1908 * @see android.app.NotificationManager 1909 * @see #KEYGUARD_SERVICE 1910 * @see android.app.KeyguardManager 1911 * @see #LOCATION_SERVICE 1912 * @see android.location.LocationManager 1913 * @see #SEARCH_SERVICE 1914 * @see android.app.SearchManager 1915 * @see #SENSOR_SERVICE 1916 * @see android.hardware.SensorManager 1917 * @see #STORAGE_SERVICE 1918 * @see android.os.storage.StorageManager 1919 * @see #VIBRATOR_SERVICE 1920 * @see android.os.Vibrator 1921 * @see #CONNECTIVITY_SERVICE 1922 * @see android.net.ConnectivityManager 1923 * @see #WIFI_SERVICE 1924 * @see android.net.wifi.WifiManager 1925 * @see #AUDIO_SERVICE 1926 * @see android.media.AudioManager 1927 * @see #MEDIA_ROUTER_SERVICE 1928 * @see android.media.MediaRouter 1929 * @see #TELEPHONY_SERVICE 1930 * @see android.telephony.TelephonyManager 1931 * @see #INPUT_METHOD_SERVICE 1932 * @see android.view.inputmethod.InputMethodManager 1933 * @see #UI_MODE_SERVICE 1934 * @see android.app.UiModeManager 1935 * @see #DOWNLOAD_SERVICE 1936 * @see android.app.DownloadManager 1937 */ 1938 public abstract Object getSystemService(String name); 1939 1940 /** 1941 * Use with {@link #getSystemService} to retrieve a 1942 * {@link android.os.PowerManager} for controlling power management, 1943 * including "wake locks," which let you keep the device on while 1944 * you're running long tasks. 1945 */ 1946 public static final String POWER_SERVICE = "power"; 1947 1948 /** 1949 * Use with {@link #getSystemService} to retrieve a 1950 * {@link android.view.WindowManager} for accessing the system's window 1951 * manager. 1952 * 1953 * @see #getSystemService 1954 * @see android.view.WindowManager 1955 */ 1956 public static final String WINDOW_SERVICE = "window"; 1957 1958 /** 1959 * Use with {@link #getSystemService} to retrieve a 1960 * {@link android.view.LayoutInflater} for inflating layout resources in this 1961 * context. 1962 * 1963 * @see #getSystemService 1964 * @see android.view.LayoutInflater 1965 */ 1966 public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater"; 1967 1968 /** 1969 * Use with {@link #getSystemService} to retrieve a 1970 * {@link android.accounts.AccountManager} for receiving intents at a 1971 * time of your choosing. 1972 * 1973 * @see #getSystemService 1974 * @see android.accounts.AccountManager 1975 */ 1976 public static final String ACCOUNT_SERVICE = "account"; 1977 1978 /** 1979 * Use with {@link #getSystemService} to retrieve a 1980 * {@link android.app.ActivityManager} for interacting with the global 1981 * system state. 1982 * 1983 * @see #getSystemService 1984 * @see android.app.ActivityManager 1985 */ 1986 public static final String ACTIVITY_SERVICE = "activity"; 1987 1988 /** 1989 * Use with {@link #getSystemService} to retrieve a 1990 * {@link android.app.AlarmManager} for receiving intents at a 1991 * time of your choosing. 1992 * 1993 * @see #getSystemService 1994 * @see android.app.AlarmManager 1995 */ 1996 public static final String ALARM_SERVICE = "alarm"; 1997 1998 /** 1999 * Use with {@link #getSystemService} to retrieve a 2000 * {@link android.app.NotificationManager} for informing the user of 2001 * background events. 2002 * 2003 * @see #getSystemService 2004 * @see android.app.NotificationManager 2005 */ 2006 public static final String NOTIFICATION_SERVICE = "notification"; 2007 2008 /** 2009 * Use with {@link #getSystemService} to retrieve a 2010 * {@link android.view.accessibility.AccessibilityManager} for giving the user 2011 * feedback for UI events through the registered event listeners. 2012 * 2013 * @see #getSystemService 2014 * @see android.view.accessibility.AccessibilityManager 2015 */ 2016 public static final String ACCESSIBILITY_SERVICE = "accessibility"; 2017 2018 /** 2019 * Use with {@link #getSystemService} to retrieve a 2020 * {@link android.view.accessibility.CaptioningManager} for obtaining 2021 * captioning properties and listening for changes in captioning 2022 * preferences. 2023 * 2024 * @see #getSystemService 2025 * @see android.view.accessibility.CaptioningManager 2026 */ 2027 public static final String CAPTIONING_SERVICE = "captioning"; 2028 2029 /** 2030 * Use with {@link #getSystemService} to retrieve a 2031 * {@link android.app.NotificationManager} for controlling keyguard. 2032 * 2033 * @see #getSystemService 2034 * @see android.app.KeyguardManager 2035 */ 2036 public static final String KEYGUARD_SERVICE = "keyguard"; 2037 2038 /** 2039 * Use with {@link #getSystemService} to retrieve a {@link 2040 * android.location.LocationManager} for controlling location 2041 * updates. 2042 * 2043 * @see #getSystemService 2044 * @see android.location.LocationManager 2045 */ 2046 public static final String LOCATION_SERVICE = "location"; 2047 2048 /** 2049 * Use with {@link #getSystemService} to retrieve a 2050 * {@link android.location.CountryDetector} for detecting the country that 2051 * the user is in. 2052 * 2053 * @hide 2054 */ 2055 public static final String COUNTRY_DETECTOR = "country_detector"; 2056 2057 /** 2058 * Use with {@link #getSystemService} to retrieve a {@link 2059 * android.app.SearchManager} for handling searches. 2060 * 2061 * @see #getSystemService 2062 * @see android.app.SearchManager 2063 */ 2064 public static final String SEARCH_SERVICE = "search"; 2065 2066 /** 2067 * Use with {@link #getSystemService} to retrieve a {@link 2068 * android.hardware.SensorManager} for accessing sensors. 2069 * 2070 * @see #getSystemService 2071 * @see android.hardware.SensorManager 2072 */ 2073 public static final String SENSOR_SERVICE = "sensor"; 2074 2075 /** 2076 * Use with {@link #getSystemService} to retrieve a {@link 2077 * android.os.storage.StorageManager} for accessing system storage 2078 * functions. 2079 * 2080 * @see #getSystemService 2081 * @see android.os.storage.StorageManager 2082 */ 2083 public static final String STORAGE_SERVICE = "storage"; 2084 2085 /** 2086 * Use with {@link #getSystemService} to retrieve a 2087 * com.android.server.WallpaperService for accessing wallpapers. 2088 * 2089 * @see #getSystemService 2090 */ 2091 public static final String WALLPAPER_SERVICE = "wallpaper"; 2092 2093 /** 2094 * Use with {@link #getSystemService} to retrieve a {@link 2095 * android.os.Vibrator} for interacting with the vibration hardware. 2096 * 2097 * @see #getSystemService 2098 * @see android.os.Vibrator 2099 */ 2100 public static final String VIBRATOR_SERVICE = "vibrator"; 2101 2102 /** 2103 * Use with {@link #getSystemService} to retrieve a {@link 2104 * android.app.StatusBarManager} for interacting with the status bar. 2105 * 2106 * @see #getSystemService 2107 * @see android.app.StatusBarManager 2108 * @hide 2109 */ 2110 public static final String STATUS_BAR_SERVICE = "statusbar"; 2111 2112 /** 2113 * Use with {@link #getSystemService} to retrieve a {@link 2114 * android.net.ConnectivityManager} for handling management of 2115 * network connections. 2116 * 2117 * @see #getSystemService 2118 * @see android.net.ConnectivityManager 2119 */ 2120 public static final String CONNECTIVITY_SERVICE = "connectivity"; 2121 2122 /** 2123 * Use with {@link #getSystemService} to retrieve a {@link 2124 * android.os.IUpdateLock} for managing runtime sequences that 2125 * must not be interrupted by headless OTA application or similar. 2126 * 2127 * @hide 2128 * @see #getSystemService 2129 * @see android.os.UpdateLock 2130 */ 2131 public static final String UPDATE_LOCK_SERVICE = "updatelock"; 2132 2133 /** 2134 * Constant for the internal network management service, not really a Context service. 2135 * @hide 2136 */ 2137 public static final String NETWORKMANAGEMENT_SERVICE = "network_management"; 2138 2139 /** {@hide} */ 2140 public static final String NETWORK_STATS_SERVICE = "netstats"; 2141 /** {@hide} */ 2142 public static final String NETWORK_POLICY_SERVICE = "netpolicy"; 2143 2144 /** 2145 * Use with {@link #getSystemService} to retrieve a {@link 2146 * android.net.wifi.WifiManager} for handling management of 2147 * Wi-Fi access. 2148 * 2149 * @see #getSystemService 2150 * @see android.net.wifi.WifiManager 2151 */ 2152 public static final String WIFI_SERVICE = "wifi"; 2153 2154 /** 2155 * Use with {@link #getSystemService} to retrieve a {@link 2156 * android.net.wifi.p2p.WifiP2pManager} for handling management of 2157 * Wi-Fi peer-to-peer connections. 2158 * 2159 * @see #getSystemService 2160 * @see android.net.wifi.p2p.WifiP2pManager 2161 */ 2162 public static final String WIFI_P2P_SERVICE = "wifip2p"; 2163 2164 /** 2165 * Use with {@link #getSystemService} to retrieve a {@link 2166 * android.net.nsd.NsdManager} for handling management of network service 2167 * discovery 2168 * 2169 * @see #getSystemService 2170 * @see android.net.nsd.NsdManager 2171 */ 2172 public static final String NSD_SERVICE = "servicediscovery"; 2173 2174 /** 2175 * Use with {@link #getSystemService} to retrieve a 2176 * {@link android.media.AudioManager} for handling management of volume, 2177 * ringer modes and audio routing. 2178 * 2179 * @see #getSystemService 2180 * @see android.media.AudioManager 2181 */ 2182 public static final String AUDIO_SERVICE = "audio"; 2183 2184 /** 2185 * Use with {@link #getSystemService} to retrieve a 2186 * {@link android.media.MediaRouter} for controlling and managing 2187 * routing of media. 2188 * 2189 * @see #getSystemService 2190 * @see android.media.MediaRouter 2191 */ 2192 public static final String MEDIA_ROUTER_SERVICE = "media_router"; 2193 2194 /** 2195 * Use with {@link #getSystemService} to retrieve a 2196 * {@link android.telephony.TelephonyManager} for handling management the 2197 * telephony features of the device. 2198 * 2199 * @see #getSystemService 2200 * @see android.telephony.TelephonyManager 2201 */ 2202 public static final String TELEPHONY_SERVICE = "phone"; 2203 2204 /** 2205 * Use with {@link #getSystemService} to retrieve a 2206 * {@link android.text.ClipboardManager} for accessing and modifying 2207 * the contents of the global clipboard. 2208 * 2209 * @see #getSystemService 2210 * @see android.text.ClipboardManager 2211 */ 2212 public static final String CLIPBOARD_SERVICE = "clipboard"; 2213 2214 /** 2215 * Use with {@link #getSystemService} to retrieve a 2216 * {@link android.view.inputmethod.InputMethodManager} for accessing input 2217 * methods. 2218 * 2219 * @see #getSystemService 2220 */ 2221 public static final String INPUT_METHOD_SERVICE = "input_method"; 2222 2223 /** 2224 * Use with {@link #getSystemService} to retrieve a 2225 * {@link android.view.textservice.TextServicesManager} for accessing 2226 * text services. 2227 * 2228 * @see #getSystemService 2229 */ 2230 public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices"; 2231 2232 /** 2233 * Use with {@link #getSystemService} to retrieve a 2234 * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets. 2235 * 2236 * @hide 2237 * @see #getSystemService 2238 */ 2239 public static final String APPWIDGET_SERVICE = "appwidget"; 2240 2241 /** 2242 * Use with {@link #getSystemService} to retrieve an 2243 * {@link android.app.backup.IBackupManager IBackupManager} for communicating 2244 * with the backup mechanism. 2245 * @hide 2246 * 2247 * @see #getSystemService 2248 */ 2249 public static final String BACKUP_SERVICE = "backup"; 2250 2251 /** 2252 * Use with {@link #getSystemService} to retrieve a 2253 * {@link android.os.DropBoxManager} instance for recording 2254 * diagnostic logs. 2255 * @see #getSystemService 2256 */ 2257 public static final String DROPBOX_SERVICE = "dropbox"; 2258 2259 /** 2260 * Use with {@link #getSystemService} to retrieve a 2261 * {@link android.app.admin.DevicePolicyManager} for working with global 2262 * device policy management. 2263 * 2264 * @see #getSystemService 2265 */ 2266 public static final String DEVICE_POLICY_SERVICE = "device_policy"; 2267 2268 /** 2269 * Use with {@link #getSystemService} to retrieve a 2270 * {@link android.app.UiModeManager} for controlling UI modes. 2271 * 2272 * @see #getSystemService 2273 */ 2274 public static final String UI_MODE_SERVICE = "uimode"; 2275 2276 /** 2277 * Use with {@link #getSystemService} to retrieve a 2278 * {@link android.app.DownloadManager} for requesting HTTP downloads. 2279 * 2280 * @see #getSystemService 2281 */ 2282 public static final String DOWNLOAD_SERVICE = "download"; 2283 2284 /** 2285 * Use with {@link #getSystemService} to retrieve a 2286 * {@link android.nfc.NfcManager} for using NFC. 2287 * 2288 * @see #getSystemService 2289 */ 2290 public static final String NFC_SERVICE = "nfc"; 2291 2292 /** 2293 * Use with {@link #getSystemService} to retrieve a 2294 * {@link android.bluetooth.BluetoothAdapter} for using Bluetooth. 2295 * 2296 * @see #getSystemService 2297 */ 2298 public static final String BLUETOOTH_SERVICE = "bluetooth"; 2299 2300 /** 2301 * Use with {@link #getSystemService} to retrieve a 2302 * {@link android.net.sip.SipManager} for accessing the SIP related service. 2303 * 2304 * @see #getSystemService 2305 */ 2306 /** @hide */ 2307 public static final String SIP_SERVICE = "sip"; 2308 2309 /** 2310 * Use with {@link #getSystemService} to retrieve a {@link 2311 * android.hardware.usb.UsbManager} for access to USB devices (as a USB host) 2312 * and for controlling this device's behavior as a USB device. 2313 * 2314 * @see #getSystemService 2315 * @see android.hardware.usb.UsbManager 2316 */ 2317 public static final String USB_SERVICE = "usb"; 2318 2319 /** 2320 * Use with {@link #getSystemService} to retrieve a {@link 2321 * android.hardware.SerialManager} for access to serial ports. 2322 * 2323 * @see #getSystemService 2324 * @see android.hardware.SerialManager 2325 * 2326 * @hide 2327 */ 2328 public static final String SERIAL_SERVICE = "serial"; 2329 2330 /** 2331 * Use with {@link #getSystemService} to retrieve a 2332 * {@link android.hardware.input.InputManager} for interacting with input devices. 2333 * 2334 * @see #getSystemService 2335 * @see android.hardware.input.InputManager 2336 */ 2337 public static final String INPUT_SERVICE = "input"; 2338 2339 /** 2340 * Use with {@link #getSystemService} to retrieve a 2341 * {@link android.hardware.display.DisplayManager} for interacting with display devices. 2342 * 2343 * @see #getSystemService 2344 * @see android.hardware.display.DisplayManager 2345 */ 2346 public static final String DISPLAY_SERVICE = "display"; 2347 2348 /** 2349 * Use with {@link #getSystemService} to retrieve a 2350 * {@link android.os.UserManager} for managing users on devices that support multiple users. 2351 * 2352 * @see #getSystemService 2353 * @see android.os.UserManager 2354 */ 2355 public static final String USER_SERVICE = "user"; 2356 2357 /** 2358 * Use with {@link #getSystemService} to retrieve a 2359 * {@link android.app.AppOpsManager} for tracking application operations 2360 * on the device. 2361 * 2362 * @see #getSystemService 2363 * @see android.app.AppOpsManager 2364 */ 2365 public static final String APP_OPS_SERVICE = "appops"; 2366 2367 /** 2368 * Use with {@link #getSystemService} to retrieve a 2369 * {@link android.hardware.camera2.CameraManager} for interacting with 2370 * camera devices. 2371 * 2372 * @see #getSystemService 2373 * @see android.hardware.camera2.CameraManager 2374 * @hide 2375 */ 2376 public static final String CAMERA_SERVICE = "camera"; 2377 2378 /** 2379 * {@link android.print.PrintManager} for printing and managing 2380 * printers and print tasks. 2381 * 2382 * @see #getSystemService 2383 * @see android.print.PrintManager 2384 */ 2385 public static final String PRINT_SERVICE = "print"; 2386 2387 /** 2388 * Use with {@link #getSystemService} to retrieve a 2389 * {@link android.hardware.ConsumerIrManager} for transmitting infrared 2390 * signals from the device. 2391 * 2392 * @see #getSystemService 2393 * @see android.hardware.ConsumerIrManager 2394 */ 2395 public static final String CONSUMER_IR_SERVICE = "consumer_ir"; 2396 2397 /** 2398 * Determine whether the given permission is allowed for a particular 2399 * process and user ID running in the system. 2400 * 2401 * @param permission The name of the permission being checked. 2402 * @param pid The process ID being checked against. Must be > 0. 2403 * @param uid The user ID being checked against. A uid of 0 is the root 2404 * user, which will pass every permission check. 2405 * 2406 * @return {@link PackageManager#PERMISSION_GRANTED} if the given 2407 * pid/uid is allowed that permission, or 2408 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2409 * 2410 * @see PackageManager#checkPermission(String, String) 2411 * @see #checkCallingPermission 2412 */ 2413 public abstract int checkPermission(String permission, int pid, int uid); 2414 2415 /** 2416 * Determine whether the calling process of an IPC you are handling has been 2417 * granted a particular permission. This is basically the same as calling 2418 * {@link #checkPermission(String, int, int)} with the pid and uid returned 2419 * by {@link android.os.Binder#getCallingPid} and 2420 * {@link android.os.Binder#getCallingUid}. One important difference 2421 * is that if you are not currently processing an IPC, this function 2422 * will always fail. This is done to protect against accidentally 2423 * leaking permissions; you can use {@link #checkCallingOrSelfPermission} 2424 * to avoid this protection. 2425 * 2426 * @param permission The name of the permission being checked. 2427 * 2428 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling 2429 * pid/uid is allowed that permission, or 2430 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2431 * 2432 * @see PackageManager#checkPermission(String, String) 2433 * @see #checkPermission 2434 * @see #checkCallingOrSelfPermission 2435 */ 2436 public abstract int checkCallingPermission(String permission); 2437 2438 /** 2439 * Determine whether the calling process of an IPC <em>or you</em> have been 2440 * granted a particular permission. This is the same as 2441 * {@link #checkCallingPermission}, except it grants your own permissions 2442 * if you are not currently processing an IPC. Use with care! 2443 * 2444 * @param permission The name of the permission being checked. 2445 * 2446 * @return {@link PackageManager#PERMISSION_GRANTED} if the calling 2447 * pid/uid is allowed that permission, or 2448 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2449 * 2450 * @see PackageManager#checkPermission(String, String) 2451 * @see #checkPermission 2452 * @see #checkCallingPermission 2453 */ 2454 public abstract int checkCallingOrSelfPermission(String permission); 2455 2456 /** 2457 * If the given permission is not allowed for a particular process 2458 * and user ID running in the system, throw a {@link SecurityException}. 2459 * 2460 * @param permission The name of the permission being checked. 2461 * @param pid The process ID being checked against. Must be > 0. 2462 * @param uid The user ID being checked against. A uid of 0 is the root 2463 * user, which will pass every permission check. 2464 * @param message A message to include in the exception if it is thrown. 2465 * 2466 * @see #checkPermission(String, int, int) 2467 */ 2468 public abstract void enforcePermission( 2469 String permission, int pid, int uid, String message); 2470 2471 /** 2472 * If the calling process of an IPC you are handling has not been 2473 * granted a particular permission, throw a {@link 2474 * SecurityException}. This is basically the same as calling 2475 * {@link #enforcePermission(String, int, int, String)} with the 2476 * pid and uid returned by {@link android.os.Binder#getCallingPid} 2477 * and {@link android.os.Binder#getCallingUid}. One important 2478 * difference is that if you are not currently processing an IPC, 2479 * this function will always throw the SecurityException. This is 2480 * done to protect against accidentally leaking permissions; you 2481 * can use {@link #enforceCallingOrSelfPermission} to avoid this 2482 * protection. 2483 * 2484 * @param permission The name of the permission being checked. 2485 * @param message A message to include in the exception if it is thrown. 2486 * 2487 * @see #checkCallingPermission(String) 2488 */ 2489 public abstract void enforceCallingPermission( 2490 String permission, String message); 2491 2492 /** 2493 * If neither you nor the calling process of an IPC you are 2494 * handling has been granted a particular permission, throw a 2495 * {@link SecurityException}. This is the same as {@link 2496 * #enforceCallingPermission}, except it grants your own 2497 * permissions if you are not currently processing an IPC. Use 2498 * with care! 2499 * 2500 * @param permission The name of the permission being checked. 2501 * @param message A message to include in the exception if it is thrown. 2502 * 2503 * @see #checkCallingOrSelfPermission(String) 2504 */ 2505 public abstract void enforceCallingOrSelfPermission( 2506 String permission, String message); 2507 2508 /** 2509 * Grant permission to access a specific Uri to another package, regardless 2510 * of whether that package has general permission to access the Uri's 2511 * content provider. This can be used to grant specific, temporary 2512 * permissions, typically in response to user interaction (such as the 2513 * user opening an attachment that you would like someone else to 2514 * display). 2515 * 2516 * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2517 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2518 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2519 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} with the Intent being used to 2520 * start an activity instead of this function directly. If you use this 2521 * function directly, you should be sure to call 2522 * {@link #revokeUriPermission} when the target should no longer be allowed 2523 * to access it. 2524 * 2525 * <p>To succeed, the content provider owning the Uri must have set the 2526 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions 2527 * grantUriPermissions} attribute in its manifest or included the 2528 * {@link android.R.styleable#AndroidManifestGrantUriPermission 2529 * <grant-uri-permissions>} tag. 2530 * 2531 * @param toPackage The package you would like to allow to access the Uri. 2532 * @param uri The Uri you would like to grant access to. 2533 * @param modeFlags The desired access modes. Any combination of 2534 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2535 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2536 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2537 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2538 * 2539 * @see #revokeUriPermission 2540 */ 2541 public abstract void grantUriPermission(String toPackage, Uri uri, 2542 int modeFlags); 2543 2544 /** 2545 * Remove all permissions to access a particular content provider Uri 2546 * that were previously added with {@link #grantUriPermission}. The given 2547 * Uri will match all previously granted Uris that are the same or a 2548 * sub-path of the given Uri. That is, revoking "content://foo/target" will 2549 * revoke both "content://foo/target" and "content://foo/target/sub", but not 2550 * "content://foo". 2551 * 2552 * @param uri The Uri you would like to revoke access to. 2553 * @param modeFlags The desired access modes. Any combination of 2554 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 2555 * Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2556 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 2557 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2558 * 2559 * @see #grantUriPermission 2560 */ 2561 public abstract void revokeUriPermission(Uri uri, int modeFlags); 2562 2563 /** 2564 * Determine whether a particular process and user ID has been granted 2565 * permission to access a specific URI. This only checks for permissions 2566 * that have been explicitly granted -- if the given process/uid has 2567 * more general access to the URI's content provider then this check will 2568 * always fail. 2569 * 2570 * @param uri The uri that is being checked. 2571 * @param pid The process ID being checked against. Must be > 0. 2572 * @param uid The user ID being checked against. A uid of 0 is the root 2573 * user, which will pass every permission check. 2574 * @param modeFlags The type of access to grant. May be one or both of 2575 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2576 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2577 * 2578 * @return {@link PackageManager#PERMISSION_GRANTED} if the given 2579 * pid/uid is allowed to access that uri, or 2580 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2581 * 2582 * @see #checkCallingUriPermission 2583 */ 2584 public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags); 2585 2586 /** 2587 * Determine whether the calling process and user ID has been 2588 * granted permission to access a specific URI. This is basically 2589 * the same as calling {@link #checkUriPermission(Uri, int, int, 2590 * int)} with the pid and uid returned by {@link 2591 * android.os.Binder#getCallingPid} and {@link 2592 * android.os.Binder#getCallingUid}. One important difference is 2593 * that if you are not currently processing an IPC, this function 2594 * will always fail. 2595 * 2596 * @param uri The uri that is being checked. 2597 * @param modeFlags The type of access to grant. May be one or both of 2598 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2599 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2600 * 2601 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller 2602 * is allowed to access that uri, or 2603 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2604 * 2605 * @see #checkUriPermission(Uri, int, int, int) 2606 */ 2607 public abstract int checkCallingUriPermission(Uri uri, int modeFlags); 2608 2609 /** 2610 * Determine whether the calling process of an IPC <em>or you</em> has been granted 2611 * permission to access a specific URI. This is the same as 2612 * {@link #checkCallingUriPermission}, except it grants your own permissions 2613 * if you are not currently processing an IPC. Use with care! 2614 * 2615 * @param uri The uri that is being checked. 2616 * @param modeFlags The type of access to grant. May be one or both of 2617 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2618 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2619 * 2620 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller 2621 * is allowed to access that uri, or 2622 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2623 * 2624 * @see #checkCallingUriPermission 2625 */ 2626 public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags); 2627 2628 /** 2629 * Check both a Uri and normal permission. This allows you to perform 2630 * both {@link #checkPermission} and {@link #checkUriPermission} in one 2631 * call. 2632 * 2633 * @param uri The Uri whose permission is to be checked, or null to not 2634 * do this check. 2635 * @param readPermission The permission that provides overall read access, 2636 * or null to not do this check. 2637 * @param writePermission The permission that provides overall write 2638 * acess, or null to not do this check. 2639 * @param pid The process ID being checked against. Must be > 0. 2640 * @param uid The user ID being checked against. A uid of 0 is the root 2641 * user, which will pass every permission check. 2642 * @param modeFlags The type of access to grant. May be one or both of 2643 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2644 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2645 * 2646 * @return {@link PackageManager#PERMISSION_GRANTED} if the caller 2647 * is allowed to access that uri or holds one of the given permissions, or 2648 * {@link PackageManager#PERMISSION_DENIED} if it is not. 2649 */ 2650 public abstract int checkUriPermission(Uri uri, String readPermission, 2651 String writePermission, int pid, int uid, int modeFlags); 2652 2653 /** 2654 * If a particular process and user ID has not been granted 2655 * permission to access a specific URI, throw {@link 2656 * SecurityException}. This only checks for permissions that have 2657 * been explicitly granted -- if the given process/uid has more 2658 * general access to the URI's content provider then this check 2659 * will always fail. 2660 * 2661 * @param uri The uri that is being checked. 2662 * @param pid The process ID being checked against. Must be > 0. 2663 * @param uid The user ID being checked against. A uid of 0 is the root 2664 * user, which will pass every permission check. 2665 * @param modeFlags The type of access to grant. May be one or both of 2666 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2667 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2668 * @param message A message to include in the exception if it is thrown. 2669 * 2670 * @see #checkUriPermission(Uri, int, int, int) 2671 */ 2672 public abstract void enforceUriPermission( 2673 Uri uri, int pid, int uid, int modeFlags, String message); 2674 2675 /** 2676 * If the calling process and user ID has not been granted 2677 * permission to access a specific URI, throw {@link 2678 * SecurityException}. This is basically the same as calling 2679 * {@link #enforceUriPermission(Uri, int, int, int, String)} with 2680 * the pid and uid returned by {@link 2681 * android.os.Binder#getCallingPid} and {@link 2682 * android.os.Binder#getCallingUid}. One important difference is 2683 * that if you are not currently processing an IPC, this function 2684 * will always throw a SecurityException. 2685 * 2686 * @param uri The uri that is being checked. 2687 * @param modeFlags The type of access to grant. May be one or both of 2688 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2689 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2690 * @param message A message to include in the exception if it is thrown. 2691 * 2692 * @see #checkCallingUriPermission(Uri, int) 2693 */ 2694 public abstract void enforceCallingUriPermission( 2695 Uri uri, int modeFlags, String message); 2696 2697 /** 2698 * If the calling process of an IPC <em>or you</em> has not been 2699 * granted permission to access a specific URI, throw {@link 2700 * SecurityException}. This is the same as {@link 2701 * #enforceCallingUriPermission}, except it grants your own 2702 * permissions if you are not currently processing an IPC. Use 2703 * with care! 2704 * 2705 * @param uri The uri that is being checked. 2706 * @param modeFlags The type of access to grant. May be one or both of 2707 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2708 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2709 * @param message A message to include in the exception if it is thrown. 2710 * 2711 * @see #checkCallingOrSelfUriPermission(Uri, int) 2712 */ 2713 public abstract void enforceCallingOrSelfUriPermission( 2714 Uri uri, int modeFlags, String message); 2715 2716 /** 2717 * Enforce both a Uri and normal permission. This allows you to perform 2718 * both {@link #enforcePermission} and {@link #enforceUriPermission} in one 2719 * call. 2720 * 2721 * @param uri The Uri whose permission is to be checked, or null to not 2722 * do this check. 2723 * @param readPermission The permission that provides overall read access, 2724 * or null to not do this check. 2725 * @param writePermission The permission that provides overall write 2726 * acess, or null to not do this check. 2727 * @param pid The process ID being checked against. Must be > 0. 2728 * @param uid The user ID being checked against. A uid of 0 is the root 2729 * user, which will pass every permission check. 2730 * @param modeFlags The type of access to grant. May be one or both of 2731 * {@link Intent#FLAG_GRANT_READ_URI_PERMISSION Intent.FLAG_GRANT_READ_URI_PERMISSION} or 2732 * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION Intent.FLAG_GRANT_WRITE_URI_PERMISSION}. 2733 * @param message A message to include in the exception if it is thrown. 2734 * 2735 * @see #checkUriPermission(Uri, String, String, int, int, int) 2736 */ 2737 public abstract void enforceUriPermission( 2738 Uri uri, String readPermission, String writePermission, 2739 int pid, int uid, int modeFlags, String message); 2740 2741 /** 2742 * Flag for use with {@link #createPackageContext}: include the application 2743 * code with the context. This means loading code into the caller's 2744 * process, so that {@link #getClassLoader()} can be used to instantiate 2745 * the application's classes. Setting this flags imposes security 2746 * restrictions on what application context you can access; if the 2747 * requested application can not be safely loaded into your process, 2748 * java.lang.SecurityException will be thrown. If this flag is not set, 2749 * there will be no restrictions on the packages that can be loaded, 2750 * but {@link #getClassLoader} will always return the default system 2751 * class loader. 2752 */ 2753 public static final int CONTEXT_INCLUDE_CODE = 0x00000001; 2754 2755 /** 2756 * Flag for use with {@link #createPackageContext}: ignore any security 2757 * restrictions on the Context being requested, allowing it to always 2758 * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code 2759 * to be loaded into a process even when it isn't safe to do so. Use 2760 * with extreme care! 2761 */ 2762 public static final int CONTEXT_IGNORE_SECURITY = 0x00000002; 2763 2764 /** 2765 * Flag for use with {@link #createPackageContext}: a restricted context may 2766 * disable specific features. For instance, a View associated with a restricted 2767 * context would ignore particular XML attributes. 2768 */ 2769 public static final int CONTEXT_RESTRICTED = 0x00000004; 2770 2771 /** 2772 * Return a new Context object for the given application name. This 2773 * Context is the same as what the named application gets when it is 2774 * launched, containing the same resources and class loader. Each call to 2775 * this method returns a new instance of a Context object; Context objects 2776 * are not shared, however they share common state (Resources, ClassLoader, 2777 * etc) so the Context instance itself is fairly lightweight. 2778 * 2779 * <p>Throws {@link PackageManager.NameNotFoundException} if there is no 2780 * application with the given package name. 2781 * 2782 * <p>Throws {@link java.lang.SecurityException} if the Context requested 2783 * can not be loaded into the caller's process for security reasons (see 2784 * {@link #CONTEXT_INCLUDE_CODE} for more information}. 2785 * 2786 * @param packageName Name of the application's package. 2787 * @param flags Option flags, one of {@link #CONTEXT_INCLUDE_CODE} 2788 * or {@link #CONTEXT_IGNORE_SECURITY}. 2789 * 2790 * @return A {@link Context} for the application. 2791 * 2792 * @throws SecurityException 2793 * @throws PackageManager.NameNotFoundException if there is no application with 2794 * the given package name. 2795 */ 2796 public abstract Context createPackageContext(String packageName, 2797 int flags) throws PackageManager.NameNotFoundException; 2798 2799 /** 2800 * Similar to {@link #createPackageContext(String, int)}, but with a 2801 * different {@link UserHandle}. For example, {@link #getContentResolver()} 2802 * will open any {@link Uri} as the given user. 2803 * 2804 * @hide 2805 */ 2806 public abstract Context createPackageContextAsUser( 2807 String packageName, int flags, UserHandle user) 2808 throws PackageManager.NameNotFoundException; 2809 2810 /** 2811 * Get the userId associated with this context 2812 * @return user id 2813 * 2814 * @hide 2815 */ 2816 public abstract int getUserId(); 2817 2818 /** 2819 * Return a new Context object for the current Context but whose resources 2820 * are adjusted to match the given Configuration. Each call to this method 2821 * returns a new instance of a Context object; Context objects are not 2822 * shared, however common state (ClassLoader, other Resources for the 2823 * same configuration) may be so the Context itself can be fairly lightweight. 2824 * 2825 * @param overrideConfiguration A {@link Configuration} specifying what 2826 * values to modify in the base Configuration of the original Context's 2827 * resources. If the base configuration changes (such as due to an 2828 * orientation change), the resources of this context will also change except 2829 * for those that have been explicitly overridden with a value here. 2830 * 2831 * @return A {@link Context} with the given configuration override. 2832 */ 2833 public abstract Context createConfigurationContext(Configuration overrideConfiguration); 2834 2835 /** 2836 * Return a new Context object for the current Context but whose resources 2837 * are adjusted to match the metrics of the given Display. Each call to this method 2838 * returns a new instance of a Context object; Context objects are not 2839 * shared, however common state (ClassLoader, other Resources for the 2840 * same configuration) may be so the Context itself can be fairly lightweight. 2841 * 2842 * The returned display Context provides a {@link WindowManager} 2843 * (see {@link #getSystemService(String)}) that is configured to show windows 2844 * on the given display. The WindowManager's {@link WindowManager#getDefaultDisplay} 2845 * method can be used to retrieve the Display from the returned Context. 2846 * 2847 * @param display A {@link Display} object specifying the display 2848 * for whose metrics the Context's resources should be tailored and upon which 2849 * new windows should be shown. 2850 * 2851 * @return A {@link Context} for the display. 2852 */ 2853 public abstract Context createDisplayContext(Display display); 2854 2855 /** 2856 * Gets the display adjustments holder for this context. This information 2857 * is provided on a per-application or activity basis and is used to simulate lower density 2858 * display metrics for legacy applications and restricted screen sizes. 2859 * 2860 * @param displayId The display id for which to get compatibility info. 2861 * @return The compatibility info holder, or null if not required by the application. 2862 * @hide 2863 */ 2864 public abstract DisplayAdjustments getDisplayAdjustments(int displayId); 2865 2866 /** 2867 * Indicates whether this Context is restricted. 2868 * 2869 * @return {@code true} if this Context is restricted, {@code false} otherwise. 2870 * 2871 * @see #CONTEXT_RESTRICTED 2872 */ 2873 public boolean isRestricted() { 2874 return false; 2875 } 2876} 2877