@Retention(value=CLASS)
@Target(value={ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD,PARAMETER})
public @interface RequiresPermission
Example of requiring a single permission:
@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;
@RequiresPermission(ACCESS_COARSE_LOCATION)
public abstract Location getLastKnownLocation(String provider);
Example of requiring at least one permission from a set:
@RequiresPermission(anyOf = {ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION})
public abstract Location getLastKnownLocation(String provider);
Example of requiring multiple permissions:
@RequiresPermission(allOf = {ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION})
public abstract Location getLastKnownLocation(String provider);
Example of requiring separate read and write permissions for a content provider:
@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS))
@RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS))
public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");
When specified on a parameter, the annotation indicates that the method requires
a permission which depends on the value of the parameter. For example, consider
android.app.Activity.startActivity(android.content.Intent)
:
public void startActivity(@RequiresPermission Intent intent) { ... }
Notice how there are no actual permission names listed in the annotation. The actual
permissions required will depend on the particular intent passed in. For example,
the code may look like this:
Intent intent = new Intent(Intent.ACTION_CALL);
startActivity(intent);
and the actual permission requirement for this particular intent is described on
the Intent name itself:
@RequiresPermission(Manifest.permission.CALL_PHONE)
public static final String ACTION_CALL = "android.intent.action.CALL";
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String[] |
allOf
Specifies a list of permission names that are all required.
|
java.lang.String[] |
anyOf
Specifies a list of permission names where at least one is required
|
boolean |
conditional
If true, the permission may not be required in all cases (e.g.
|
java.lang.String |
value
The name of the permission that is required, if precisely one permission
is required.
|