Package: android.hardware.confirmationui@1.0

IConfirmationUI

interface IConfirmationUI

Methods

promptUserConfirmation

promptUserConfirmation (IConfirmationResultCallback resultCB, string promptText, vec<uint8_t> extraData, string locale, vec<UIOption> uiOptions)
generates (ResponseCode error)

Asynchronously initiates a confirmation UI dialog prompting the user to confirm a given text.The TUI prompt must be implemented in such a way that a positive response indicates with high confidence that a user has seen the given prompt text even if the Android framework including the kernel was compromised.

Details
Parameters
resultCB
Implementation of IResultCallback.Used by the implementation to report the result of the current pending user prompt.
promptText
UTF-8 encoded string which is to be presented to the user.
extraData
A binary blob that must be included in the formatted output message as is.It is opaque to the implementation.Implementations must neither interpret nor modify the content.
locale
String specifying the locale that must be used by the TUI dialog.The string is an IETF BCP 47 tag.
uiOptions
A set of uiOptions manipulating how the confirmation prompt is displayed.Refer to UIOption in types.hal for possible options.
Generates
error
- OK:IFF the dialog was successfully started.In this case, and only in this case, the implementation must, eventually, call the callback to indicate completion.- OperationPending:Is returned when the confirmation provider is currently in use.- SystemError:An error occurred trying to communicate with the confirmation provider(e.g.trusted app). - UIError:The confirmation provider encountered an issue with displaying the prompt text to the user.

deliverSecureInputEvent

deliverSecureInputEvent (HardwareAuthToken secureInputToken)
generates (ResponseCode error)

DeliverSecureInput is used by the framework to deliver a secure input event to the confirmation provider.

VTS test mode:This function can be used to test certain code paths non-interactively.See TestModeCommands in types.hal for details.

Details
Parameters
secureInputToken
An authentication token as generated by Android authentication providers.
Generates
error
- Ignored:Unless used for testing(See TestModeCommands).

abort

abort ()

Aborts a pending user prompt.This allows the framework to gracefully end a TUI dialog.If a TUI operation was pending the corresponding call back is informed with ErrorCode::Aborted.

Details