public class

MockContext

extends Context
java.lang.Object
   ↳ android.content.Context
     ↳ android.test.mock.MockContext

Class Overview

A mock Context class. All methods are non-functional and throw UnsupportedOperationException. You can use this to inject other dependencies, mocks, or monitors into the classes you are testing.

Summary

[Expand]
Inherited Constants
From class android.content.Context
Public Constructors
MockContext()
Public Methods
boolean bindService(Intent service, ServiceConnection conn, int flags)
Connect to an application service, creating it if needed.
int checkCallingOrSelfPermission(String permission)
Determine whether the calling process of an IPC or you have been granted a particular permission.
int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)
Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
int checkCallingPermission(String permission)
Determine whether the calling process of an IPC you are handling has been granted a particular permission.
int checkCallingUriPermission(Uri uri, int modeFlags)
Determine whether the calling process and user ID has been granted permission to access a specific URI.
int checkPermission(String permission, int pid, int uid)
Determine whether the given permission is allowed for a particular process and user ID running in the system.
int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)
Determine whether a particular process and user ID has been granted permission to access a specific URI.
int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
Check both a Uri and normal permission.
void clearWallpaper()
Remove any currently set wallpaper, reverting to the system's default wallpaper.
Context createPackageContext(String packageName, int flags)
Return a new Context object for the given application name.
String[] databaseList()
Returns an array of strings naming the private databases associated with this Context's application package.
boolean deleteDatabase(String name)
Delete an existing private SQLiteDatabase associated with this Context's application package.
boolean deleteFile(String name)
Delete the given private file associated with this Context's application package.
void enforceCallingOrSelfPermission(String permission, String message)
If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.
void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)
If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.
void enforceCallingPermission(String permission, String message)
If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.
void enforceCallingUriPermission(Uri uri, int modeFlags, String message)
If the calling process and user ID has not been granted permission to access a specific URI, throw SecurityException.
void enforcePermission(String permission, int pid, int uid, String message)
If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.
void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)
If a particular process and user ID has not been granted permission to access a specific URI, throw SecurityException.
void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
Enforce both a Uri and normal permission.
String[] fileList()
Returns an array of strings naming the private files associated with this Context's application package.
Context getApplicationContext()
Return the context of the single, global Application object of the current process.
AssetManager getAssets()
Return an AssetManager instance for your application's package.
File getCacheDir()
Returns the absolute path to the application specific cache directory on the filesystem.
ClassLoader getClassLoader()
Return a class loader you can use to retrieve classes in this package.
ContentResolver getContentResolver()
Return a ContentResolver instance for your application's package.
File getDatabasePath(String name)
Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory) is stored.
File getDir(String name, int mode)
Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
File getFileStreamPath(String name)
Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.
File getFilesDir()
Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.
Looper getMainLooper()
Return the Looper for the main thread of the current process.
String getPackageCodePath()
Return the full path to this context's code and asset files.
PackageManager getPackageManager()
Return PackageManager instance to find global package information.
String getPackageName()
Return the name of this application's package.
String getPackageResourcePath()
Return the full path to this context's resource files.
Resources getResources()
Return a Resources instance for your application's package.
SharedPreferences getSharedPreferences(String name, int mode)
Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
Object getSystemService(String name)
Return the handle to a system-level service by name.
Resources.Theme getTheme()
Return the Theme object associated with this Context.
Drawable getWallpaper()
Like peekWallpaper(), but always returns a valid Drawable.
int getWallpaperDesiredMinimumHeight()
Returns the desired minimum height for the wallpaper.
int getWallpaperDesiredMinimumWidth()
Returns the desired minimum width for the wallpaper.
void grantUriPermission(String toPackage, Uri uri, int modeFlags)
Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
FileInputStream openFileInput(String name)
Open a private file associated with this Context's application package for reading.
FileOutputStream openFileOutput(String name, int mode)
Open a private file associated with this Context's application package for writing.
SQLiteDatabase openOrCreateDatabase(String file, int mode, SQLiteDatabase.CursorFactory factory)
Open a new private SQLiteDatabase associated with this Context's application package.
Drawable peekWallpaper()
Retrieve the current system wallpaper.
Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
Register to receive intent broadcasts, to run in the context of scheduler.
Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)
Register a BroadcastReceiver to be run in the main activity thread.
void removeStickyBroadcast(Intent intent)
Remove the data previously sent with sendStickyBroadcast(Intent), so that it is as if the sticky broadcast had never happened.
void revokeUriPermission(Uri uri, int modeFlags)
Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int).
void sendBroadcast(Intent intent)
Broadcast the given intent to all interested BroadcastReceivers.
void sendBroadcast(Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.
void sendOrderedBroadcast(Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
void sendStickyBroadcast(Intent intent)
Perform a sendBroadcast(Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(BroadcastReceiver, IntentFilter).
void setTheme(int resid)
Set the base theme for this context.
void setWallpaper(InputStream data)
Change the current system wallpaper to a specific byte stream.
void setWallpaper(Bitmap bitmap)
Change the current system wallpaper to a bitmap.
void startActivity(Intent intent)
Launch a new activity.
boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)
Start executing an Instrumentation class.
ComponentName startService(Intent service)
Request that a given application service be started.
boolean stopService(Intent service)
Request that a given application service be stopped.
void unbindService(ServiceConnection conn)
Disconnect from an application service.
void unregisterReceiver(BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver.
[Expand]
Inherited Methods
From class android.content.Context
From class java.lang.Object

Public Constructors

public MockContext ()

Public Methods

public boolean bindService (Intent service, ServiceConnection conn, int flags)

Connect to an application service, creating it if needed. This defines a dependency between your application and the service. The given conn will receive the service object when its created and be told if it dies and restarts. The service will be considered required by the system only for as long as the calling context exists. For example, if this Context is an Activity that is stopped, the service will not be required to continue running until the Activity is resumed.

This function will throw SecurityException if you do not have permission to bind to the given service.

Note: this method can not be called from an BroadcastReceiver component. A pattern you can use to communicate from an BroadcastReceiver to a Service is to call startService(Intent) with the arguments containing the command to be sent, with the service calling its stopSelf(int) method when done executing that command. See the API demo App/Service/Service Start Arguments Controller for an illustration of this. It is okay, however, to use this method from an BroadcastReceiver that has been registered with registerReceiver(BroadcastReceiver, IntentFilter), since the lifetime of this BroadcastReceiver is tied to another object (the one that registered it).

Parameters
service Identifies the service to connect to. The Intent may specify either an explicit component name, or a logical description (action, category, etc) to match an IntentFilter published by a service.
conn Receives information as the service is started and stopped.
flags Operation options for the binding. May be 0 or BIND_AUTO_CREATE.
Returns
  • If you have successfully bound to the service, true is returned; false is returned if the connection is not made so you will not receive the service object.

public int checkCallingOrSelfPermission (String permission)

Determine whether the calling process of an IPC or you have been granted a particular permission. This is the same as checkCallingPermission(String), except it grants your own permissions if you are not currently processing an IPC. Use with care!

Parameters
permission The name of the permission being checked.
Returns

public int checkCallingOrSelfUriPermission (Uri uri, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. This is the same as checkCallingUriPermission(Uri, int), except it grants your own permissions if you are not currently processing an IPC. Use with care!

Parameters
uri The uri that is being checked.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
Returns

public int checkCallingPermission (String permission)

Determine whether the calling process of an IPC you are handling has been granted a particular permission. This is basically the same as calling checkPermission(String, int, int) with the pid and uid returned by getCallingPid() and getCallingUid(). One important difference is that if you are not currently processing an IPC, this function will always fail. This is done to protect against accidentally leaking permissions; you can use checkCallingOrSelfPermission(String) to avoid this protection.

Parameters
permission The name of the permission being checked.
Returns

public int checkCallingUriPermission (Uri uri, int modeFlags)

Determine whether the calling process and user ID has been granted permission to access a specific URI. This is basically the same as calling checkUriPermission(Uri, int, int, int) with the pid and uid returned by getCallingPid() and getCallingUid(). One important difference is that if you are not currently processing an IPC, this function will always fail.

Parameters
uri The uri that is being checked.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
Returns

public int checkPermission (String permission, int pid, int uid)

Determine whether the given permission is allowed for a particular process and user ID running in the system.

Parameters
permission The name of the permission being checked.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
Returns

public int checkUriPermission (Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and user ID has been granted permission to access a specific URI. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.

Parameters
uri The uri that is being checked.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
Returns

public int checkUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)

Check both a Uri and normal permission. This allows you to perform both checkPermission(String, int, int) and checkUriPermission(Uri, int, int, int) in one call.

Parameters
uri The Uri whose permission is to be checked, or null to not do this check.
readPermission The permission that provides overall read access, or null to not do this check.
writePermission The permission that provides overall write acess, or null to not do this check.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
Returns

public void clearWallpaper ()

Remove any currently set wallpaper, reverting to the system's default wallpaper. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

public Context createPackageContext (String packageName, int flags)

Return a new Context object for the given application name. This Context is the same as what the named application gets when it is launched, containing the same resources and class loader. Each call to this method returns a new instance of a Context object; Context objects are not shared, however they share common state (Resources, ClassLoader, etc) so the Context instance itself is fairly lightweight.

Throws PackageManager.NameNotFoundException if there is no application with the given package name.

Throws SecurityException if the Context requested can not be loaded into the caller's process for security reasons (see CONTEXT_INCLUDE_CODE for more information}.

Parameters
packageName Name of the application's package.
flags Option flags, one of CONTEXT_INCLUDE_CODE or CONTEXT_IGNORE_SECURITY.
Returns
  • A Context for the application.
Throws
PackageManager.NameNotFoundException

public String[] databaseList ()

Returns an array of strings naming the private databases associated with this Context's application package.

Returns
  • Array of strings naming the private databases.

public boolean deleteDatabase (String name)

Delete an existing private SQLiteDatabase associated with this Context's application package.

Parameters
name The name (unique in the application package) of the database.
Returns
  • True if the database was successfully deleted; else false.

public boolean deleteFile (String name)

Delete the given private file associated with this Context's application package.

Parameters
name The name of the file to delete; can not contain path separators.
Returns
  • True if the file was successfully deleted; else false.

public void enforceCallingOrSelfPermission (String permission, String message)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException. This is the same as enforceCallingPermission(String, String), except it grants your own permissions if you are not currently processing an IPC. Use with care!

Parameters
permission The name of the permission being checked.
message A message to include in the exception if it is thrown.

public void enforceCallingOrSelfUriPermission (Uri uri, int modeFlags, String message)

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException. This is the same as enforceCallingUriPermission(Uri, int, String), except it grants your own permissions if you are not currently processing an IPC. Use with care!

Parameters
uri The uri that is being checked.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
message A message to include in the exception if it is thrown.

public void enforceCallingPermission (String permission, String message)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException. This is basically the same as calling enforcePermission(String, int, int, String) with the pid and uid returned by getCallingPid() and getCallingUid(). One important difference is that if you are not currently processing an IPC, this function will always throw the SecurityException. This is done to protect against accidentally leaking permissions; you can use enforceCallingOrSelfPermission(String, String) to avoid this protection.

Parameters
permission The name of the permission being checked.
message A message to include in the exception if it is thrown.

public void enforceCallingUriPermission (Uri uri, int modeFlags, String message)

If the calling process and user ID has not been granted permission to access a specific URI, throw SecurityException. This is basically the same as calling enforceUriPermission(Uri, int, int, int, String) with the pid and uid returned by getCallingPid() and getCallingUid(). One important difference is that if you are not currently processing an IPC, this function will always throw a SecurityException.

Parameters
uri The uri that is being checked.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
message A message to include in the exception if it is thrown.

public void enforcePermission (String permission, int pid, int uid, String message)

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

Parameters
permission The name of the permission being checked.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
message A message to include in the exception if it is thrown.

public void enforceUriPermission (Uri uri, int pid, int uid, int modeFlags, String message)

If a particular process and user ID has not been granted permission to access a specific URI, throw SecurityException. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.

Parameters
uri The uri that is being checked.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
message A message to include in the exception if it is thrown.

public void enforceUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)

Enforce both a Uri and normal permission. This allows you to perform both enforcePermission(String, int, int, String) and enforceUriPermission(Uri, int, int, int, String) in one call.

Parameters
uri The Uri whose permission is to be checked, or null to not do this check.
readPermission The permission that provides overall read access, or null to not do this check.
writePermission The permission that provides overall write acess, or null to not do this check.
pid The process ID being checked against. Must be > 0.
uid The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
modeFlags The type of access to grant. May be one or both of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.
message A message to include in the exception if it is thrown.

public String[] fileList ()

Returns an array of strings naming the private files associated with this Context's application package.

Returns
  • Array of strings naming the private files.

public Context getApplicationContext ()

Return the context of the single, global Application object of the current process.

public AssetManager getAssets ()

Return an AssetManager instance for your application's package.

public File getCacheDir ()

Returns the absolute path to the application specific cache directory on the filesystem. These files will be ones that get deleted first when the device runs low on storage There is no guarantee when these files will be deleted.

Returns
  • Returns the path of the directory holding application cache files.

public ClassLoader getClassLoader ()

Return a class loader you can use to retrieve classes in this package.

public ContentResolver getContentResolver ()

Return a ContentResolver instance for your application's package.

public File getDatabasePath (String name)

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory) is stored.

Parameters
name The name of the database for which you would like to get its path.
Returns
  • Returns an absolute path to the given database.

public File getDir (String name, int mode)

Retrieve, creating if needed, a new directory in which the application can place its own custom data files. You can use the returned File object to create and access files in this directory. Note that files created through a File object will only be accessible by your own application; you can only set the mode of the entire directory, not of individual files.

Parameters
name Name of the directory to retrieve. This is a directory that is created as part of your application data.
mode Operating mode. Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions.
Returns
  • Returns a File object for the requested directory. The directory will have been created if it does not already exist.

public File getFileStreamPath (String name)

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

Parameters
name The name of the file for which you would like to get its path.
Returns
  • Returns an absolute path to the given file.

public File getFilesDir ()

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Returns
  • Returns the path of the directory holding application files.

public Looper getMainLooper ()

Return the Looper for the main thread of the current process. This is the thread used to dispatch calls to application components (activities, services, etc).

public String getPackageCodePath ()

Return the full path to this context's code and asset files. This is the ZIP files containing the application's code and assets.

Note: this is not generally useful for applications, since they should not be directly accessing the file system.

Returns
  • String Path to the code and assets.

public PackageManager getPackageManager ()

Return PackageManager instance to find global package information.

public String getPackageName ()

Return the name of this application's package.

public String getPackageResourcePath ()

Return the full path to this context's resource files. This is the ZIP files containing the application's resources.

Note: this is not generally useful for applications, since they should not be directly accessing the file system.

Returns
  • String Path to the resources.

public Resources getResources ()

Return a Resources instance for your application's package.

public SharedPreferences getSharedPreferences (String name, int mode)

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. Only one instance of the SharedPreferences object is returned to any callers for the same name, meaning they will see each other's edits as soon as they are made.

Parameters
name Desired preferences file. If a preferences file by this name does not exist, it will be created when you retrieve an editor (SharedPreferences.edit()) and then commit changes (Editor.commit()).
mode Operating mode. Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions.
Returns
  • Returns the single SharedPreferences instance that can be used to retrieve and modify the preference values.

public Object getSystemService (String name)

Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:

WINDOW_SERVICE ("window")
The top-level window manager in which you can place custom windows. The returned object is a WindowManager.
LAYOUT_INFLATER_SERVICE ("layout_inflater")
A LayoutInflater for inflating layout resources in this context.
ACTIVITY_SERVICE ("activity")
A ActivityManager for interacting with the global activity state of the system.
POWER_SERVICE ("power")
A PowerManager for controlling power management.
ALARM_SERVICE ("alarm")
A AlarmManager for receiving intents at the time of your choosing.
NOTIFICATION_SERVICE ("notification")
A NotificationManager for informing the user of background events.
KEYGUARD_SERVICE ("keyguard")
A KeyguardManager for controlling keyguard.
LOCATION_SERVICE ("location")
A LocationManager for controlling location (e.g., GPS) updates.
SEARCH_SERVICE ("search")
A SearchManager for handling search.
VIBRATOR_SERVICE ("vibrator")
A Vibrator for interacting with the vibrator hardware.
CONNECTIVITY_SERVICE ("connection")
A ConnectivityManager for handling management of network connections.
WIFI_SERVICE ("wifi")
A WifiManager for management of Wi-Fi connectivity.
INPUT_METHOD_SERVICE ("input_method")
An InputMethodManager for management of input methods.

Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)

Parameters
name The name of the desired service.
Returns
  • The service or null if the name does not exist.

public Resources.Theme getTheme ()

Return the Theme object associated with this Context.

public Drawable getWallpaper ()

Like peekWallpaper(), but always returns a valid Drawable. If no wallpaper is set, the system default wallpaper is returned.

Returns
  • Returns a Drawable object that will draw the wallpaper.

public int getWallpaperDesiredMinimumHeight ()

Returns the desired minimum height for the wallpaper. Callers of setWallpaper(android.graphics.Bitmap) or setWallpaper(java.io.InputStream) should check this value beforehand to make sure the supplied wallpaper respects the desired minimum height. If the returned value is <= 0, the caller should use the height of the default display instead.

Returns
  • The desired minimum height for the wallpaper. This value should be honored by applications that set the wallpaper but it is not mandatory.

public int getWallpaperDesiredMinimumWidth ()

Returns the desired minimum width for the wallpaper. Callers of setWallpaper(android.graphics.Bitmap) or setWallpaper(java.io.InputStream) should check this value beforehand to make sure the supplied wallpaper respects the desired minimum width. If the returned value is <= 0, the caller should use the width of the default display instead.

Returns
  • The desired minimum width for the wallpaper. This value should be honored by applications that set the wallpaper but it is not mandatory.

public void grantUriPermission (String toPackage, Uri uri, int modeFlags)

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. This can be used to grant specific, temporary permissions, typically in response to user interaction (such as the user opening an attachment that you would like someone else to display).

Normally you should use Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION with the Intent being used to start an activity instead of this function directly. If you use this function directly, you should be sure to call revokeUriPermission(Uri, int) when the target should no longer be allowed to access it.

To succeed, the content provider owning the Uri must have set the grantUriPermissions attribute in its manifest or included the <grant-uri-permissions> tag.

Parameters
toPackage The package you would like to allow to access the Uri.
uri The Uri you would like to grant access to.
modeFlags The desired access modes. Any combination of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.

public FileInputStream openFileInput (String name)

Open a private file associated with this Context's application package for reading.

Parameters
name The name of the file to open; can not contain path separators.
Returns
  • FileInputStream Resulting input stream.
Throws
FileNotFoundException

public FileOutputStream openFileOutput (String name, int mode)

Open a private file associated with this Context's application package for writing. Creates the file if it doesn't already exist.

Parameters
name The name of the file to open; can not contain path separators.
mode Operating mode. Use 0 or MODE_PRIVATE for the default operation, MODE_APPEND to append to an existing file, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions.
Returns
  • FileOutputStream Resulting output stream.
Throws
FileNotFoundException

public SQLiteDatabase openOrCreateDatabase (String file, int mode, SQLiteDatabase.CursorFactory factory)

Open a new private SQLiteDatabase associated with this Context's application package. Create the database file if it doesn't exist.

Parameters
file The name (unique in the application package) of the database.
mode Operating mode. Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions.
factory An optional factory class that is called to instantiate a cursor when query is called.
Returns
  • The contents of a newly created database with the given name.

public Drawable peekWallpaper ()

Retrieve the current system wallpaper. This is returned as an abstract Drawable that you can install in a View to display whatever wallpaper the user has currently set. If there is no wallpaper set, a null pointer is returned.

Returns
  • Returns a Drawable object that will draw the wallpaper or a null pointer if these is none.

public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)

Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(BroadcastReceiver, IntentFilter) for more information. This allows you to enforce permissions on who can broadcast intents to your receiver, or have the receiver run in a different thread than the main application thread.

See BroadcastReceiver for more information on Intent broadcasts.

Parameters
receiver The BroadcastReceiver to handle the broadcast.
filter Selects the Intent broadcasts to be received.
broadcastPermission String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required.
scheduler Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used.
Returns
  • The first sticky intent found that matches filter, or null if there are none.

public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter)

Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread.

The system may broadcast Intents that are "sticky" -- these stay around after the broadcast as finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.

There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.

If you know the Intent your are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.

See BroadcastReceiver for more information on Intent broadcasts.

Note: this method cannot be called from a BroadcastReceiver component; that is, from a BroadcastReceiver that is declared in an application's manifest. It is okay, however, to call this method from another BroadcastReceiver that has itself been registered at run time with registerReceiver(BroadcastReceiver, IntentFilter), since the lifetime of such a registered BroadcastReceiver is tied to the object that registered it.

Parameters
receiver The BroadcastReceiver to handle the broadcast.
filter Selects the Intent broadcasts to be received.
Returns
  • The first sticky intent found that matches filter, or null if there are none.

public void removeStickyBroadcast (Intent intent)

Remove the data previously sent with sendStickyBroadcast(Intent), so that it is as if the sticky broadcast had never happened.

You must hold the BROADCAST_STICKY permission in order to use this API. If you do not hold that permission, SecurityException will be thrown.

Parameters
intent The Intent that was previously broadcast.

public void revokeUriPermission (Uri uri, int modeFlags)

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int). The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/one" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo".

Parameters
uri The Uri you would like to revoke access to.
modeFlags The desired access modes. Any combination of Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION.

public void sendBroadcast (Intent intent)

Broadcast the given intent to all interested BroadcastReceivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Parameters
intent The Intent to broadcast; all receivers matching this Intent will receive the broadcast.

public void sendBroadcast (Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Parameters
intent The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
receiverPermission (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.

public void sendOrderedBroadcast (Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its onReceive(Context, Intent) method will be called with the result values collected from the other receivers. If you use an resultReceiver with this method, then the broadcast will be serialized in the same way as calling sendOrderedBroadcast(Intent, String).

Like sendBroadcast(Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.

See BroadcastReceiver for more information on Intent broadcasts.

Parameters
intent The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
receiverPermission String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.
resultReceiver Your own BroadcastReceiver to treat as the final receiver of the broadcast.
scheduler A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
initialCode An initial value for the result code. Often Activity.RESULT_OK.
initialData An initial value for the result data. Often null.
initialExtras An initial value for the result extras. Often null.

public void sendOrderedBroadcast (Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.

See BroadcastReceiver for more information on Intent broadcasts.

Parameters
intent The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
receiverPermission (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.

public void sendStickyBroadcast (Intent intent)

Perform a sendBroadcast(Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(BroadcastReceiver, IntentFilter). In all other ways, this behaves the same as sendBroadcast(Intent).

You must hold the BROADCAST_STICKY permission in order to use this API. If you do not hold that permission, SecurityException will be thrown.

Parameters
intent The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers.

public void setTheme (int resid)

Set the base theme for this context. Note that this should be called before any views are instantiated in the Context (for example before calling setContentView(View) or inflate(int, ViewGroup)).

Parameters
resid The style resource describing the theme.

public void setWallpaper (InputStream data)

Change the current system wallpaper to a specific byte stream. The give InputStream is copied into persistent storage and will now be used as the wallpaper. Currently it must be either a JPEG or PNG image. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

Parameters
data A stream containing the raw data to install as a wallpaper.
Throws
IOException

public void setWallpaper (Bitmap bitmap)

Change the current system wallpaper to a bitmap. The given bitmap is converted to a PNG and stored as the wallpaper. On success, the intent ACTION_WALLPAPER_CHANGED is broadcast.

Parameters
bitmap The bitmap to save.
Throws
IOException

public void startActivity (Intent intent)

Launch a new activity. You will not receive any information about when the activity exits.

Note that if this method is being called from outside of an Activity Context, then the Intent must include the FLAG_ACTIVITY_NEW_TASK launch flag. This is because, without being started from an existing Activity, there is no existing task in which to place the new activity and thus it needs to be placed in its own separate task.

This method throws ActivityNotFoundException if there was no Activity found to run the given Intent.

Parameters
intent The description of the activity to start.

public boolean startInstrumentation (ComponentName className, String profileFile, Bundle arguments)

Start executing an Instrumentation class. The given Instrumentation component will be run by killing its target application (if currently running), starting the target process, instantiating the instrumentation component, and then letting it drive the application.

This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.

Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).

Parameters
className Name of the Instrumentation component to be run.
profileFile Optional path to write profiling data as the instrumentation runs, or null for no profiling.
arguments Additional optional arguments to pass to the instrumentation, or null.
Returns
  • Returns true if the instrumentation was successfully started, else false if it could not be found.

public ComponentName startService (Intent service)

Request that a given application service be started. The Intent can either contain the complete class name of a specific service implementation to start, or an abstract definition through the action and other fields of the kind of service to start. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.

Every call to this method will result in a corresponding call to the target service's onStart(Intent, int) method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.

Using startService() overrides the default service lifetime that is managed by bindService(Intent, ServiceConnection, int): it requires the service to remain running until stopService(Intent) is called, regardless of whether any clients are connected to it. Note that calls to startService() are not nesting: no matter how many times you call startService(), a single call to stopService(Intent) will stop it.

The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.

This function will throw SecurityException if you do not have permission to start the given service.

Parameters
service Identifies the service to be started. The Intent may specify either an explicit component name to start, or a logical description (action, category, etc) to match an IntentFilter published by a service. Additional values may be included in the Intent extras to supply arguments along with this specific start call.
Returns
  • If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned.

public boolean stopService (Intent service)

Request that a given application service be stopped. If the service is not running, nothing happens. Otherwise it is stopped. Note that calls to startService() are not counted -- this stops the service no matter how many times it was started.

Note that if a stopped service still has ServiceConnection objects bound to it with the BIND_AUTO_CREATE set, it will not be destroyed until all of these bindings are removed. See the Service documentation for more details on a service's lifecycle.

This function will throw SecurityException if you do not have permission to stop the given service.

Parameters
service Description of the service to be stopped. The Intent may specify either an explicit component name to start, or a logical description (action, category, etc) to match an IntentFilter published by a service.
Returns
  • If there is a service matching the given Intent that is already running, then it is stopped and true is returned; else false is returned.

public void unbindService (ServiceConnection conn)

Disconnect from an application service. You will no longer receive calls as the service is restarted, and the service is now allowed to stop at any time.

Parameters
conn The connection interface previously supplied to bindService().

public void unregisterReceiver (BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.

Parameters
receiver The BroadcastReceiver to unregister.