VoiceInteractor.ConfirmationRequest


public static class VoiceInteractor.ConfirmationRequest
extends VoiceInteractor.Request

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


Confirms an operation with the user via the trusted system VoiceInteractionService. This allows an Activity to complete an unsafe operation that would require the user to touch the screen when voice interaction mode is not enabled. The result of the confirmation will be returned through an asynchronous call to either onConfirmationResult(boolean, android.os.Bundle) or VoiceInteractor.Request.onCancel() - these methods should be overridden to define the application specific behavior.

In some cases this may be a simple yes / no confirmation or the confirmation could include context information about how the action will be completed (e.g. booking a cab might include details about how long until the cab arrives) so the user can give a confirmation.

Summary

Public constructors

ConfirmationRequest(VoiceInteractor.Prompt prompt, Bundle extras)

Create a new confirmation request.

Public methods

void onConfirmationResult(boolean confirmed, Bundle result)

Handle the confirmation result.

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

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

ConfirmationRequest

Added in API level 23
public ConfirmationRequest (VoiceInteractor.Prompt prompt, 
                Bundle extras)

Create a new confirmation request.

Parameters
prompt VoiceInteractor.Prompt: Optional confirmation to speak to the user or null if nothing should be spoken.

extras Bundle: Additional optional information or null.

Public methods

onConfirmationResult

Added in API level 23
public void onConfirmationResult (boolean confirmed, 
                Bundle result)

Handle the confirmation result. Override this method to define the behavior when the user confirms or rejects the operation.

Parameters
confirmed boolean: Whether the user confirmed or rejected the operation.

result Bundle: Additional result information or null.