ConfirmationActivity
open class ConfirmationActivity : Activity
kotlin.Any | |||||
↳ | android.content.Context | ||||
↳ | android.content.ContextWrapper | ||||
↳ | android.view.ContextThemeWrapper | ||||
↳ | android.app.Activity | ||||
↳ | androidx.wear.activity.ConfirmationActivity |
This Activity is used to display confirmation animations after the user completes an action on the wearable. There are three types of confirmations: Success: the action was completed successfully on the wearable. Failure: the action failed to complete. Open on Phone: the action has caused something to display on the phone, or in order to complete the action, the user will need to go to their phone to continue.
It is the responsibility of the wearable application developer to determine whether the action has succeeded, failed, or requires the user to go to their phone, and trigger the appropriate confirmation.
To configure the confirmation according to the result of the action, set the extra
to one of the following values:
SUCCESS_ANIMATION
- Displays a positive confirmation animation with an optional message.
OPEN_ON_PHONE_ANIMATION
- Displays an animation indicating an action has been sent to a paired device.
FAILURE_ANIMATION
- Displays a generic failure page with an optional message.
An optional message, included in the extra EXTRA_MESSAGE
will be displayed horizontally centered below the animation.
An optional duration in milliseconds to keep the confirmation activity visible for, included in the extra EXTRA_ANIMATION_DURATION_MILLIS
Summary
Constants | |
---|---|
static String |
The lookup key for an optional int that defines the duration in milliseconds that the confirmation activity should be displayed. |
static String |
The lookup key for an optional int that defines the animation type that should be displayed. |
static String |
Used as a string extra field on an intent for this activity to define the message that should be displayed to the user while the activity is visible. |
static Int | |
static Int | |
static Int |
Public constructors | |
---|---|
<init>() This Activity is used to display confirmation animations after the user completes an action on the wearable. |
Public methods | |
---|---|
open Unit |
Protected methods | |
---|---|
open Unit |
Override this method if you wish to provide different than out-of-the-box behavior when the confirmation animation finishes. |
Constants
EXTRA_ANIMATION_DURATION_MILLIS
static val EXTRA_ANIMATION_DURATION_MILLIS: String
The lookup key for an optional int that defines the duration in milliseconds that the confirmation activity should be displayed. If no value is specified it will default to ConfirmationOverlay#DEFAULT_ANIMATION_DURATION_MS
Value: "androidx.wear.activity.extra.ANIMATION_DURATION_MILLIS"
EXTRA_ANIMATION_TYPE
static val EXTRA_ANIMATION_TYPE: String
The lookup key for an optional int that defines the animation type that should be displayed. Should be one of SUCCESS_ANIMATION
, OPEN_ON_PHONE_ANIMATION
, or FAILURE_ANIMATION
If no value is specified it will default to SUCCESS_ANIMATION
Value: "androidx.wear.activity.extra.ANIMATION_TYPE"
EXTRA_MESSAGE
static val EXTRA_MESSAGE: String
Used as a string extra field on an intent for this activity to define the message that should be displayed to the user while the activity is visible.
Value: "androidx.wear.activity.extra.MESSAGE"
Public constructors
<init>
ConfirmationActivity()
This Activity is used to display confirmation animations after the user completes an action on the wearable. There are three types of confirmations: Success: the action was completed successfully on the wearable. Failure: the action failed to complete. Open on Phone: the action has caused something to display on the phone, or in order to complete the action, the user will need to go to their phone to continue.
It is the responsibility of the wearable application developer to determine whether the action has succeeded, failed, or requires the user to go to their phone, and trigger the appropriate confirmation.
To configure the confirmation according to the result of the action, set the extra
to one of the following values:
SUCCESS_ANIMATION
- Displays a positive confirmation animation with an optional message.
OPEN_ON_PHONE_ANIMATION
- Displays an animation indicating an action has been sent to a paired device.
FAILURE_ANIMATION
- Displays a generic failure page with an optional message.
An optional message, included in the extra EXTRA_MESSAGE
will be displayed horizontally centered below the animation.
An optional duration in milliseconds to keep the confirmation activity visible for, included in the extra EXTRA_ANIMATION_DURATION_MILLIS
Public methods
Protected methods
onAnimationFinished
protected open fun onAnimationFinished(): Unit
Override this method if you wish to provide different than out-of-the-box behavior when the confirmation animation finishes. By default this method will finish the ConfirmationActivity.