RequiresPermission

  • android
    @MustBeDocumented
    @Retention(value = AnnotationRetention.BINARY)
    @Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
    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 types
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.VALUE_PARAMETER])
annotation RequiresPermission.Read

Specifies that the given permission is required for read operations.
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.VALUE_PARAMETER])
annotation RequiresPermission.Write

Specifies that the given permission is required for write operations.

Public constructors
RequiresPermission(
    value: String,
    allOf: Array<String>,
    anyOf: Array<String>,
    conditional: Boolean
)
android

Public properties
Array<String>

Specifies a list of permission names that are all required.
android
Array<String>

Specifies a list of permission names where at least one is required
android
Boolean

If true, the permission may not be required in all cases (e.g. it may only be enforced on certain platforms, or for certain call parameters, etc.
android
String

The name of the permission that is required, if precisely one permission is required.
android

Public constructors

RequiresPermission

android 
RequiresPermission(
    value: String = "",
    allOf: Array<String> = [],
    anyOf: Array<String> = [],
    conditional: Boolean = false
)

Public properties

allOf

android 
val allOf: Array<String>

Specifies a list of permission names that are all required.

If specified, anyOf and value must both be null.

anyOf

android 
val anyOf: Array<String>

Specifies a list of permission names where at least one is required

If specified, allOf and value must both be null.

conditional

android 
val conditional: Boolean

If true, the permission may not be required in all cases (e.g. it may only be enforced on certain platforms, or for certain call parameters, etc.

value

android 
val value: String

The name of the permission that is required, if precisely one permission is required. If more than one permission is required, specify either allOf or anyOf instead.

If specified, anyOf and allOf must both be null.