VoiceInteractionSession.Request

Kotlin |Java

public static class VoiceInteractionSession.Request
extends Object

java.lang.Object
↳	android.service.voice.VoiceInteractionSession.Request

Known direct subclasses

VoiceInteractionSession.AbortVoiceRequest, VoiceInteractionSession.CommandRequest, VoiceInteractionSession.CompleteVoiceRequest, VoiceInteractionSession.ConfirmationRequest, VoiceInteractionSession.PickOptionRequest

VoiceInteractionSession.AbortVoiceRequest	A request to report that the current user interaction can not be completed with voice, as per `VoiceInteractor.AbortVoiceRequest`.
VoiceInteractionSession.CommandRequest	A generic vendor-specific request, as per `VoiceInteractor.CommandRequest`.
VoiceInteractionSession.CompleteVoiceRequest	A request to simply inform the user that the voice operation has completed, as per `VoiceInteractor.CompleteVoiceRequest`.
VoiceInteractionSession.ConfirmationRequest	A request for confirmation from the user of an operation, as per `VoiceInteractor.ConfirmationRequest`.
VoiceInteractionSession.PickOptionRequest	A request for the user to pick from a set of option, as per `VoiceInteractor.PickOptionRequest`.

Base class representing a request from a voice-driver app to perform a particular voice operation with the user. See related subclasses for the types of requests that are possible.

Summary

Public methods
`void`	`cancel()` Ask the app to cancel this current request.
`String`	`getCallingPackage()` Return the package name of the application that initiated the request.
`int`	`getCallingUid()` Return the uid of the application that initiated the request.
`Bundle`	`getExtras()` Return any additional extra information that was supplied as part of the request.
`boolean`	`isActive()` Check whether this request is currently active.
`String`	`toString()` Returns a string representation of the object.

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.

Public methods

cancel

Added in API level 23

public void cancel ()

Ask the app to cancel this current request. This also finishes the request (it is no longer active).

getCallingPackage

Added in API level 23

public String getCallingPackage ()

Return the package name of the application that initiated the request.

Returns
`String`

getCallingUid

Added in API level 23

public int getCallingUid ()

Return the uid of the application that initiated the request.

Returns
`int`

getExtras

Added in API level 23

public Bundle getExtras ()

Return any additional extra information that was supplied as part of the request.

Returns
`Bundle`

isActive

Added in API level 23

public boolean isActive ()

Check whether this request is currently active. A request becomes inactive after calling cancel() or a final result method that completes the request. After this point, further interactions with the request will result in IllegalStateException errors; you should not catch these errors, but can use this method if you need to determine the state of the request. Returns true if the request is still active.

Returns
`boolean`

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.