CommandRequest

Kotlin |Java

class CommandRequest : VoiceInteractor.Request

kotlin.Any
↳	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 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(command: String!, args: Bundle!)` Create a new generic command request.

Public methods
open Unit	`onCommandResult(isCompleted: Boolean, result: Bundle!)` Results for CommandRequest can be returned in partial chunks.

Inherited functions

From class Request

`Unit`	`cancel()` Cancel this active request.
`Activity!`	`getActivity()` Return the current `Activity` this request is associated with. Will change if the activity is restarted such as through a configuration change.
`Context!`	`getContext()` Return the current `Context` this request is associated with. May change if the activity hosting it goes through a configuration change.
`String!`	`getName()` Return the name this request was submitted through `submitRequest(android.app.VoiceInteractor.Request,java.lang.String)`.
`Unit`	`onAttached(activity: Activity!)` The request is now attached to an activity, or being re-attached to a new activity after a configuration change.
`Unit`	`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.
`Unit`	`onDetached()` The request is being detached from an activity.
`String`	`toString()`

Public constructors

CommandRequest

Added in API level 23

CommandRequest(
    command: String!, 
    args: Bundle!)

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

open fun onCommandResult(
    isCompleted: Boolean, 
    result: Bundle!
): Unit

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.