VoiceInteractor.Request

Kotlin |Java

public static abstract class VoiceInteractor.Request
extends Object

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

Known direct subclasses

VoiceInteractor.AbortVoiceRequest, VoiceInteractor.CommandRequest, VoiceInteractor.CompleteVoiceRequest, VoiceInteractor.ConfirmationRequest, VoiceInteractor.PickOptionRequest

VoiceInteractor.AbortVoiceRequest	Reports that the current interaction can not be complete with voice, so the application will need to switch to a traditional input UI.
VoiceInteractor.CommandRequest	Execute a vendor-specific command using the trusted system VoiceInteractionService.
VoiceInteractor.CompleteVoiceRequest	Reports that the current interaction was successfully completed with voice, so the application can report the final status to the user.
VoiceInteractor.ConfirmationRequest	Confirms an operation with the user via the trusted system VoiceInteractionService.
VoiceInteractor.PickOptionRequest	Select a single option from multiple potential options with the user via the trusted system VoiceInteractionService.

Base class for voice interaction requests that can be submitted to the interactor. Do not instantiate this directly -- instead, use the appropriate subclass.

Summary

Public methods
`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.

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 ()

Cancel this active request.

getActivity

Added in API level 23

public Activity getActivity ()

Return the current Activity this request is associated with. Will change if the activity is restarted such as through a configuration change.

Returns
`Activity`

getContext

Added in API level 23

public Context getContext ()

Return the current Context this request is associated with. May change if the activity hosting it goes through a configuration change.

Returns
`Context`

getName

Added in API level 23

public String getName ()

Return the name this request was submitted through VoiceInteractor.submitRequest(android.app.VoiceInteractor.Request, java.lang.String).

Returns
`String`

onAttached

Added in API level 23

public void onAttached (Activity activity)

The request is now attached to an activity, or being re-attached to a new activity after a configuration change.

Parameters
`activity`	`Activity`

onCancel

Added in API level 23

public 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.

onDetached

Added in API level 23

public void onDetached ()

The request is being detached from an activity.

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.