VoiceInteractionManager

Kotlin |Java

public final class VoiceInteractionManager
extends Object

java.lang.Object
↳	android.app.voiceinteraction.VoiceInteractionManager

Service that provides information about and interacts with the current global voice interactor

Summary

Constants
`int`	`READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED` Read screen context access is granted.
`int`	`READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE` Read screen context access isn't granted, but apps can request access.
`int`	`READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE` Read screen context access is denied, and can't be requested with dialog by apps.

Public methods
`boolean`	`canReadScreenContext()` Returns whether the calling app can read screen context.
`Intent`	`createRequestReadScreenContextIntent()` Creates an intent which can be used to request access to screen context for current assistant role holder.
`int`	`getReadScreenContextRequestState()` Returns the read screen context request state for an app.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED

Added in API level 37

public static final int READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED

Read screen context access is granted.

See also:

getReadScreenContextRequestState()

Constant Value: 0 (0x00000000)

READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE

Added in API level 37

public static final int READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE

Read screen context access isn't granted, but apps can request access. When the app request access, user will be prompted with request dialog to grant or deny the request.

See also:

getReadScreenContextRequestState()

Constant Value: 1 (0x00000001)

READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE

Added in API level 37

public static final int READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE

Read screen context access is denied, and can't be requested with dialog by apps. Access request will be automatically denied by the system, preventing the request dialog from being displayed to the user.

See also:

getReadScreenContextRequestState()

Constant Value: 2 (0x00000002)

Public methods

canReadScreenContext

Added in API level 37

public boolean canReadScreenContext ()

Returns whether the calling app can read screen context.

Returns
`boolean`	`true` if the calling app is the current assistant and has access to screen context , `false` otherwise.

createRequestReadScreenContextIntent

Added in API level 37

public Intent createRequestReadScreenContextIntent ()

Creates an intent which can be used to request access to screen context for current assistant role holder. This intent MUST be used with Activity.startActivityForResult(Intent, int). The result code of the activity will be Activity.RESULT_OK if the request was granted, Activity.RESULT_CANCELED if not. If the caller is not the current default assistant, the request will be denied automatically.

Returns
`Intent`	The created intent. This value cannot be `null`.

getReadScreenContextRequestState

Added in API level 37

public int getReadScreenContextRequestState ()

Returns the read screen context request state for an app. This method provides a streamlined mechanism for applications to determine whether read screen context access can be requested (i.e. whether the user will be prompted with a request dialog).

Returns

Returns
`int`	The current request state of the specified access, represented by one of the following constants: `READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED`, `READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE`, or `READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE` Value is one of the following: `READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED` `READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE` `READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE`

int

The current request state of the specified access, represented by one of the following constants: READ_SCREEN_CONTEXT_REQUEST_STATE_GRANTED, READ_SCREEN_CONTEXT_REQUEST_STATE_REQUESTABLE, or READ_SCREEN_CONTEXT_REQUEST_STATE_UNREQUESTABLE
Value is one of the following: