PermissionChecker

Added in 1.1.0

Kotlin |Java

class PermissionChecker

This class provides permission check APIs that verify both the permission and the associated app op for this permission if such is defined.

In the new permission model permissions with protection level dangerous are runtime permissions. For apps targeting M and above the user may not grant such permissions or revoke them at any time. For apps targeting API lower than M these permissions are always granted as such apps do not expect permission revocations and would crash. Therefore, when the user disables a permission for a legacy app in the UI the platform disables the APIs guarded by this permission making them a no-op which is doing nothing or returning an empty result or default error.

It is important that when you perform an operation on behalf of another app you use these APIs to check for permissions as the app may be a legacy app that does not participate in the new permission model for which the user had disabled the "permission" which is achieved by disallowing the corresponding app op.

Summary

Constants
`const Int`	`PERMISSION_DENIED = -1` Permission result: The permission is denied.
`const Int`	`PERMISSION_DENIED_APP_OP = -2` Permission result: The permission is denied because the app op is not allowed.
`const Int`	`PERMISSION_GRANTED = 0` Permission result: The permission is granted.

Public functions
`java-static Int`	`checkCallingOrSelfPermission(context: Context, permission: String)` Checks whether the IPC you are handling or your app has a given permission and whether the app op that corresponds to this permission is allowed.
`java-static Int`	`checkCallingPermission( context: Context, permission: String, packageName: String? )` Checks whether the IPC you are handling has a given permission and whether the app op that corresponds to this permission is allowed.
`java-static Int`	`checkPermission( context: Context, permission: String, pid: Int, uid: Int, packageName: String? )` Checks whether a given package in a UID and PID has a given permission and whether the app op that corresponds to this permission is allowed.
`java-static Int`	`checkSelfPermission(context: Context, permission: String)` Checks whether your app has a given permission and whether the app op that corresponds to this permission is allowed.

Constants

PERMISSION_DENIED

Added in 1.1.0

const val PERMISSION_DENIED = -1: Int

Permission result: The permission is denied.

PERMISSION_DENIED_APP_OP

Added in 1.1.0

const val PERMISSION_DENIED_APP_OP = -2: Int

Permission result: The permission is denied because the app op is not allowed.

PERMISSION_GRANTED

Added in 1.1.0

const val PERMISSION_GRANTED = 0: Int

Permission result: The permission is granted.

Public functions

checkCallingOrSelfPermission

Added in 1.1.0

java-static fun checkCallingOrSelfPermission(context: Context, permission: String): Int

Checks whether the IPC you are handling or your app has a given permission and whether the app op that corresponds to this permission is allowed.

Parameters
`context: Context`	Context for accessing resources.
`permission: String`	The permission to check.

Returns
`Int`	The permission check result which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED` or `PERMISSION_DENIED_APP_OP`.

checkCallingPermission

Added in 1.1.0

java-static fun checkCallingPermission(
    context: Context,
    permission: String,
    packageName: String?
): Int

Checks whether the IPC you are handling has a given permission and whether the app op that corresponds to this permission is allowed.

Parameters
`context: Context`	Context for accessing resources.
`permission: String`	The permission to check.
`packageName: String?`	The package name making the IPC. If null the the first package for the calling UID will be used.

Returns
`Int`	The permission check result which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED` or `PERMISSION_DENIED_APP_OP`.

checkPermission

Added in 1.1.0

java-static fun checkPermission(
    context: Context,
    permission: String,
    pid: Int,
    uid: Int,
    packageName: String?
): Int

Checks whether a given package in a UID and PID has a given permission and whether the app op that corresponds to this permission is allowed.

Parameters
`context: Context`	Context for accessing resources.
`permission: String`	The permission to check.
`pid: Int`	The process id for which to check.
`uid: Int`	The uid for which to check.
`packageName: String?`	The package name for which to check. If null the the first package for the calling UID will be used.

Returns
`Int`	The permission check result which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED` or `PERMISSION_DENIED_APP_OP`.

checkSelfPermission

Added in 1.1.0

java-static fun checkSelfPermission(context: Context, permission: String): Int

Checks whether your app has a given permission and whether the app op that corresponds to this permission is allowed.

Parameters
`context: Context`	Context for accessing resources.
`permission: String`	The permission to check.

Returns
`Int`	The permission check result which is either `PERMISSION_GRANTED` or `PERMISSION_DENIED` or `PERMISSION_DENIED_APP_OP`.