RequiresPermission

public abstract @interface RequiresPermission
implements Annotation

android.support.annotation.RequiresPermission

---

Denotes that the annotated element requires (or may require) one or more permissions.

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";
 

Summary

Nested classes
@interface	RequiresPermission.Read Specifies that the given permission is required for read operations.
@interface	RequiresPermission.Write Specifies that the given permission is required for write operations.

Inherited methods

From interface java.lang.annotation.Annotation abstract Class<? extends Annotation> annotationType() Returns the annotation type of this annotation. abstract boolean equals(Object obj) Returns true if the specified object represents an annotation that is logically equivalent to this one. abstract int hashCode() Returns the hash code of this annotation, as defined below: The hash code of an annotation is the sum of the hash codes of its members (including those with default values), as defined below: The hash code of an annotation member is (127 times the hash code of the member-name as computed by hashCode()) XOR the hash code of the member-value, as defined below: The hash code of a member-value depends on its type: The hash code of a primitive value v is equal to WrapperType.valueOf(v).hashCode(), where WrapperType is the wrapper type corresponding to the primitive type of v (Byte, Character, Double, Float, Integer, Long, Short, or Boolean). abstract String toString() Returns a string representation of this annotation.