AppOpsManager

MODE_ALLOWED

static val MODE_ALLOWED: Int

Result from checkOp, #noteOp, #startOp: the given caller is allowed to perform the given operation.

Value: 0

MODE_DEFAULT

static val MODE_DEFAULT: Int

Result from checkOp, #noteOp, #startOp: the given caller should use its default security check. This mode is not normally used; it should only be used with appop permissions, and callers must explicitly check for it and deal with it.

Value: 3

MODE_ERRORED

static val MODE_ERRORED: Int

Result from checkOpNoThrow, #noteOpNoThrow, #startOpNoThrow: the given caller is not allowed to perform the given operation, and this attempt should cause it to have a fatal error, typically a SecurityException.

Value: 2

MODE_FOREGROUND

static val MODE_FOREGROUND: Int

Special mode that means "allow only when app is in foreground." This is not returned from unsafeCheckOp, #noteOp, #startOp. Rather, unsafeCheckOp will always return MODE_ALLOWED (because it is always possible for it to be ultimately allowed, depending on the app's background state), and #noteOp and #startOp will return MODE_ALLOWED when the app being checked is currently in the foreground, otherwise MODE_IGNORED.

The only place you will this normally see this value is through unsafeCheckOpRaw, which returns the actual raw mode of the op. Note that because you can't know the current state of the app being checked (and it can change at any point), you can only treat the result here as an indication that it will vary between MODE_ALLOWED and MODE_IGNORED depending on changes in the background state of the app. You thus must always use #noteOp or #startOp to do the actual check for access to the op.

Value: 4

MODE_IGNORED

static val MODE_IGNORED: Int

Result from checkOp, #noteOp, #startOp: the given caller is not allowed to perform the given operation, and this attempt should silently fail (it should not cause the app to crash).

Value: 1

OPSTR_ADD_VOICEMAIL

static val OPSTR_ADD_VOICEMAIL: String

Required to access phone state related information.

Value: "android:add_voicemail"

OPSTR_ANSWER_PHONE_CALLS

static val OPSTR_ANSWER_PHONE_CALLS: String

Answer incoming phone calls

Value: "android:answer_phone_calls"

OPSTR_BODY_SENSORS

static val OPSTR_BODY_SENSORS: String

Access to body sensors such as heart rate, etc.

Value: "android:body_sensors"

OPSTR_CALL_PHONE

static val OPSTR_CALL_PHONE: String

Allows an application to initiate a phone call.

Value: "android:call_phone"

OPSTR_CAMERA

static val OPSTR_CAMERA: String

Required to be able to access the camera device.

Value: "android:camera"

OPSTR_COARSE_LOCATION

static val OPSTR_COARSE_LOCATION: String

Access to coarse location information.

Value: "android:coarse_location"

OPSTR_FINE_LOCATION

static val OPSTR_FINE_LOCATION: String

Access to fine location information.

Value: "android:fine_location"

OPSTR_GET_USAGE_STATS

static val OPSTR_GET_USAGE_STATS: String

Access to android.app.usage.UsageStatsManager.

Value: "android:get_usage_stats"

OPSTR_MOCK_LOCATION

static val OPSTR_MOCK_LOCATION: String

Inject mock location into the system.

Value: "android:mock_location"

OPSTR_MONITOR_HIGH_POWER_LOCATION

static val OPSTR_MONITOR_HIGH_POWER_LOCATION: String

Continually monitoring location data with a relatively high power request.

Value: "android:monitor_location_high_power"

OPSTR_MONITOR_LOCATION

static val OPSTR_MONITOR_LOCATION: String

Continually monitoring location data.

Value: "android:monitor_location"

OPSTR_PICTURE_IN_PICTURE

static val OPSTR_PICTURE_IN_PICTURE: String

Access to picture-in-picture.

Value: "android:picture_in_picture"

OPSTR_PROCESS_OUTGOING_CALLS

static val OPSTR_PROCESS_OUTGOING_CALLS: String

Access APIs for diverting outgoing calls

Value: "android:process_outgoing_calls"

OPSTR_READ_CALENDAR

static val OPSTR_READ_CALENDAR: String

Allows an application to read the user's calendar data.

Value: "android:read_calendar"

OPSTR_READ_CALL_LOG

static val OPSTR_READ_CALL_LOG: String

Allows an application to read the user's call log.

Value: "android:read_call_log"

OPSTR_READ_CELL_BROADCASTS

static val OPSTR_READ_CELL_BROADCASTS: String

Read previously received cell broadcast messages.

Value: "android:read_cell_broadcasts"

OPSTR_READ_CONTACTS

static val OPSTR_READ_CONTACTS: String

Allows an application to read the user's contacts data.

Value: "android:read_contacts"

OPSTR_READ_EXTERNAL_STORAGE

static val OPSTR_READ_EXTERNAL_STORAGE: String

Read external storage.

Value: "android:read_external_storage"

OPSTR_READ_PHONE_NUMBERS

static val OPSTR_READ_PHONE_NUMBERS: String

Value: "android:read_phone_numbers"

OPSTR_READ_PHONE_STATE

static val OPSTR_READ_PHONE_STATE: String

Required to access phone state related information.

Value: "android:read_phone_state"

OPSTR_READ_SMS

static val OPSTR_READ_SMS: String

Allows an application to read SMS messages.

Value: "android:read_sms"

OPSTR_RECEIVE_MMS

static val OPSTR_RECEIVE_MMS: String

Allows an application to receive MMS messages.

Value: "android:receive_mms"

OPSTR_RECEIVE_SMS

static val OPSTR_RECEIVE_SMS: String

Allows an application to receive SMS messages.

Value: "android:receive_sms"

OPSTR_RECEIVE_WAP_PUSH

static val OPSTR_RECEIVE_WAP_PUSH: String

Allows an application to receive WAP push messages.

Value: "android:receive_wap_push"

OPSTR_RECORD_AUDIO

static val OPSTR_RECORD_AUDIO: String

Required to be able to access the microphone device.

Value: "android:record_audio"

OPSTR_SEND_SMS

static val OPSTR_SEND_SMS: String

Allows an application to send SMS messages.

Value: "android:send_sms"

OPSTR_SYSTEM_ALERT_WINDOW

static val OPSTR_SYSTEM_ALERT_WINDOW: String

Required to draw on top of other apps.

Value: "android:system_alert_window"

OPSTR_USE_FINGERPRINT

static val OPSTR_USE_FINGERPRINT: String

Use the fingerprint API.

Value: "android:use_fingerprint"

OPSTR_USE_SIP

static val OPSTR_USE_SIP: String

Access APIs for SIP calling over VOIP or WiFi

Value: "android:use_sip"

OPSTR_WRITE_CALENDAR

static val OPSTR_WRITE_CALENDAR: String

Allows an application to write to the user's calendar data.

Value: "android:write_calendar"

OPSTR_WRITE_CALL_LOG

static val OPSTR_WRITE_CALL_LOG: String

Allows an application to write to the user's call log.

Value: "android:write_call_log"

OPSTR_WRITE_CONTACTS

static val OPSTR_WRITE_CONTACTS: String

Allows an application to write to the user's contacts data.

Value: "android:write_contacts"

OPSTR_WRITE_EXTERNAL_STORAGE

static val OPSTR_WRITE_EXTERNAL_STORAGE: String

Write external storage.

Value: "android:write_external_storage"

OPSTR_WRITE_SETTINGS

static val OPSTR_WRITE_SETTINGS: String

Required to write/modify/update system settings.

Value: "android:write_settings"

WATCH_FOREGROUND_CHANGES

static val WATCH_FOREGROUND_CHANGES: Int

Flag for startWatchingMode(java.lang.String,java.lang.String,int,android.app.AppOpsManager.OnOpChangedListener): Also get reports if the foreground state of an op's uid changes. This only works when watching a particular op, not when watching a package.

Value: 1

checkPackage

open fun checkPackage(
    uid: Int, 
    packageName: String
): Unit

Deprecated: Use android.content.pm.PackageManager#getPackageUid instead

finishOp

open fun finishOp(
    op: String, 
    uid: Int, 
    packageName: String
): Unit

Deprecated: Use finishOp(java.lang.String,int,java.lang.String,java.lang.String) instead

finishOp

open fun finishOp(
    op: String, 
    uid: Int, 
    packageName: String, 
    attributionTag: String?
): Unit

Report that an application is no longer performing an operation that had previously been started with startOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String). There is no validation of input or result; the parameters supplied here must be the exact same ones previously passed in when starting the operation.

finishProxyOp

open fun finishProxyOp(
    op: String, 
    proxiedUid: Int, 
    proxiedPackageName: String, 
    proxiedAttributionTag: String?
): Unit

Report that an application is no longer performing an operation that had previously been started with startProxyOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String). There is no validation of input or result; the parameters supplied here must be the exact same ones previously passed in when starting the operation.

isOpActive

open fun isOpActive(
    op: String, 
    uid: Int, 
    packageName: String
): Boolean

Checks whether the given op for a package is active, i.e. did someone call #startOp without #finishOp yet.

If you don't hold the android.Manifest.permission#WATCH_APPOPS permission you can query only for your UID.

noteOp

open fun noteOp(
    op: String, 
    uid: Int, 
    packageName: String
): Int

Deprecated: Use noteOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) instead

noteOp

open fun noteOp(
    op: String, 
    uid: Int, 
    packageName: String?, 
    attributionTag: String?, 
    message: String?
): Int

Make note of an application performing an operation and check if the application is allowed to perform it.

If this is a check that is not preceding the protected operation, use unsafeCheckOp instead.

The identity of the package the app-op is noted for is specified by the uid and packageName parameters. If this is noted for a regular app both should be set and the package needs to be part of the uid. In the very rare case that an app-op is noted for an entity that does not have a package name, the package can be null. As it is possible that a single process contains more than one package the packageName should be read from the context of the caller of the API (in the app process) that eventually triggers this check. If this op is not noted for a running process the packageName cannot be read from the context, but it should be clear which package the note is for.

If the uid and packageName do not match this return MODE_IGNORED.

Beside the access check this method also records the access. While the access check is based on uid and/or packageName the access recording is done based on the packageName and attributionTag. The attributionTag should be read from the same context the package name is read from. In the case the check is not related to an API call, the attributionTag should be null. Please note that e.g. registering a callback for later is still an API call and the code should store the attribution tag along the package name for being used in this method later.

The message parameter only needs to be set when this method is

not

noteOpNoThrow

open fun noteOpNoThrow(
    op: String, 
    uid: Int, 
    packageName: String
): Int

Deprecated: Use noteOpNoThrow(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) instead

noteOpNoThrow

open fun noteOpNoThrow(
    op: String, 
    uid: Int, 
    packageName: String, 
    attributionTag: String?, 
    message: String?
): Int

Like noteOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) but instead of throwing a SecurityException it returns MODE_ERRORED.

noteProxyOp

open fun noteProxyOp(
    op: String, 
    proxiedPackageName: String
): Int

Deprecated: Use noteProxyOp(java.lang.String,java.lang.String,int,java.lang.String,java.lang.String) instead

noteProxyOp

open fun noteProxyOp(
    op: String, 
    proxiedPackageName: String?, 
    proxiedUid: Int, 
    proxiedAttributionTag: String?, 
    message: String?
): Int

Make note of an application performing an operation on behalf of another application when handling an IPC. This function will verify that the calling uid and proxied package name match, and if not, return MODE_IGNORED. If this call succeeds, the last execution time of the operation for the proxied app and your app will be updated to the current time.

noteProxyOpNoThrow

open fun noteProxyOpNoThrow(
    op: String, 
    proxiedPackageName: String
): Int

Deprecated: Use noteProxyOpNoThrow(java.lang.String,java.lang.String,int,java.lang.String,java.lang.String) instead

noteProxyOpNoThrow

open fun noteProxyOpNoThrow(
    op: String, 
    proxiedPackageName: String?, 
    proxiedUid: Int
): Int

Deprecated: Use noteProxyOpNoThrow(java.lang.String,java.lang.String,int,java.lang.String,java.lang.String) instead

noteProxyOpNoThrow

open fun noteProxyOpNoThrow(
    op: String, 
    proxiedPackageName: String?, 
    proxiedUid: Int, 
    proxiedAttributionTag: String?, 
    message: String?
): Int

Like noteProxyOp(java.lang.String,java.lang.String,int,java.lang.String,java.lang.String) but instead of throwing a SecurityException it returns MODE_ERRORED.

permissionToOp

open static fun permissionToOp(permission: String): String?

Gets the app-op name associated with a given permission.

The app-op name is one of the public constants defined in this class such as OPSTR_COARSE_LOCATION. This API is intended to be used for mapping runtime permissions to the corresponding app-op.

setOnOpNotedCallback

open fun setOnOpNotedCallback(
    asyncExecutor: Executor?, 
    callback: AppOpsManager.OnOpNotedCallback?
): Unit

Set a new OnOpNotedCallback.

There can only ever be one collector per process. If there currently is another callback set, this will fail.

Note that if an app has multiple processes registering for this callback, the system would fan out async op noted callbacks to each of the processes, resulting in the same data being delivered multiple times to an app, which is usually undesired. To avoid this, consider listening to async ops only in one process. See #setOnOpNotedCallback(java.util.concurrent.Executor,android.app.AppOpsManager.OnOpNotedCallback,int) for how to do this.

startOp

open fun startOp(
    op: String, 
    uid: Int, 
    packageName: String
): Int

Deprecated: use startOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) instead

startOp

open fun startOp(
    op: String, 
    uid: Int, 
    packageName: String?, 
    attributionTag: String?, 
    message: String?
): Int

Report that an application has started executing a long-running operation.

For more details how to determine the callingPackageName, callingAttributionTag, and message, please check the description in noteOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String)

startOpNoThrow

open fun startOpNoThrow(
    op: String, 
    uid: Int, 
    packageName: String
): Int

Deprecated: use startOpNoThrow(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) instead

startOpNoThrow

open fun startOpNoThrow(
    op: String, 
    uid: Int, 
    packageName: String, 
    attributionTag: String?, 
    message: String?
): Int

Like startOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) but instead of throwing a SecurityException it returns MODE_ERRORED.

startProxyOp

open fun startProxyOp(
    op: String, 
    proxiedUid: Int, 
    proxiedPackageName: String, 
    proxiedAttributionTag: String?, 
    message: String?
): Int

Report that an application has started executing a long-running operation on behalf of another application when handling an IPC. This function will verify that the calling uid and proxied package name match, and if not, return MODE_IGNORED.

startProxyOpNoThrow

open fun startProxyOpNoThrow(
    op: String, 
    proxiedUid: Int, 
    proxiedPackageName: String, 
    proxiedAttributionTag: String?, 
    message: String?
): Int

Like startProxyOp(java.lang.String,int,java.lang.String,java.lang.String,java.lang.String) but instead of throwing a SecurityException it returns MODE_ERRORED.

startWatchingActive

open fun startWatchingActive(
    ops: Array<String!>, 
    executor: Executor, 
    callback: AppOpsManager.OnOpActiveChangedListener
): Unit

Start watching for changes to the active state of app-ops. An app-op may be long running and it has a clear start and stop delimiters. If an op is being started or stopped by any package you will get a callback. To change the watched ops for a registered callback you need to unregister and register it again.

If you don't hold the android.Manifest.permission#WATCH_APPOPS permission you can watch changes only for your UID.

startWatchingMode

open fun startWatchingMode(
    op: String, 
    packageName: String?, 
    callback: AppOpsManager.OnOpChangedListener
): Unit

Monitor for changes to the operating mode for the given op in the given app package. You can watch op changes only for your UID.

startWatchingMode

open fun startWatchingMode(
    op: String, 
    packageName: String?, 
    flags: Int, 
    callback: AppOpsManager.OnOpChangedListener
): Unit

Monitor for changes to the operating mode for the given op in the given app package. You can watch op changes only for your UID.

stopWatchingActive

open fun stopWatchingActive(callback: AppOpsManager.OnOpActiveChangedListener): Unit

Stop watching for changes to the active state of an app-op. An app-op may be long running and it has a clear start and stop delimiters. Unregistering a non-registered callback has no effect.

stopWatchingMode

open fun stopWatchingMode(callback: AppOpsManager.OnOpChangedListener): Unit

Stop monitoring that was previously started with #startWatchingMode. All monitoring associated with this callback will be removed.