VoiceInteractor.CommandRequest

Kotlin |Java

public static class VoiceInteractor.CommandRequest
extends VoiceInteractor.Request

java.lang.Object
↳	android.app.VoiceInteractor.Request
	↳	android.app.VoiceInteractor.CommandRequest

Execute a vendor-specific command using the trusted system VoiceInteractionService. This allows an Activity to request additional information from the user needed to complete an action (e.g. booking a table might have several possible times that the user could select from or an app might need the user to agree to a terms of service). The result of the confirmation will be returned through an asynchronous call to either onCommandResult(boolean, android.os.Bundle) or VoiceInteractor.Request.onCancel().

The command is a string that describes the generic operation to be performed. The command will determine how the properties in extras are interpreted and the set of available commands is expected to grow over time. An example might be "com.google.voice.commands.REQUEST_NUMBER_BAGS" to request the number of bags as part of airline check-in. (This is not an actual working example.)

Summary

Public constructors
`CommandRequest(String command, Bundle args)` Create a new generic command request.

Public methods
`void`	`onCommandResult(boolean isCompleted, Bundle result)` Results for CommandRequest can be returned in partial chunks.

Inherited methods

From class


        
          android.app.VoiceInteractor.Request

`void`	`cancel()` Cancel this active request.
`Activity`	`getActivity()` Return the current `Activity` this request is associated with.
`Context`	`getContext()` Return the current `Context` this request is associated with.
`String`	`getName()` Return the name this request was submitted through `VoiceInteractor.submitRequest(android.app.VoiceInteractor.Request, java.lang.String)`.
`void`	`onAttached(Activity activity)` The request is now attached to an activity, or being re-attached to a new activity after a configuration change.
`void`	`onCancel()` Report from voice interaction service: this operation has been canceled, typically as a completion of a previous call to `cancel()` or when the user explicitly cancelled.
`void`	`onDetached()` The request is being detached from an activity.
`String`	`toString()` Returns a string representation of the object.

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 constructors

CommandRequest

Added in API level 23

public CommandRequest (String command, 
                Bundle args)

Create a new generic command request.

Parameters
`command`	`String`: The desired command to perform.
`args`	`Bundle`: Additional arguments to control execution of the command.

Public methods

onCommandResult

Added in API level 23

public void onCommandResult (boolean isCompleted, 
                Bundle result)

Results for CommandRequest can be returned in partial chunks. The isCompleted is set to true iff all results have been returned, indicating the CommandRequest has completed.

Parameters
`isCompleted`	`boolean`
`result`	`Bundle`