public class

ConfirmationActivity

extends Activity

 java.lang.Object

↳Activity

↳androidx.wear.activity.ConfirmationActivity

Gradle dependencies

compile group: 'androidx.wear', name: 'wear', version: '1.3.0-alpha02'

  • groupId: androidx.wear
  • artifactId: wear
  • version: 1.3.0-alpha02

Artifact androidx.wear:wear:1.3.0-alpha02 it located at Google repository (https://maven.google.com/)

Androidx artifact mapping:

androidx.wear:wear com.android.support:wear

Androidx class mapping:

androidx.wear.activity.ConfirmationActivity android.support.wear.activity.ConfirmationActivity

Overview

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 ConfirmationActivity.EXTRA_ANIMATION_TYPE to one of the following values:

ConfirmationActivity.SUCCESS_ANIMATION
Displays a positive confirmation animation with an optional message.
ConfirmationActivity.OPEN_ON_PHONE_ANIMATION
Displays an animation indicating an action has been sent to a paired device.
ConfirmationActivity.FAILURE_ANIMATION
Displays a generic failure page with an optional message.

An optional message, included in the extra ConfirmationActivity.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 ConfirmationActivity.EXTRA_ANIMATION_DURATION_MILLIS

Summary

Fields
public static final java.lang.StringEXTRA_ANIMATION_DURATION_MILLIS

The lookup key for an optional int that defines the duration in milliseconds that the confirmation activity should be displayed.

public static final java.lang.StringEXTRA_ANIMATION_TYPE

The lookup key for an optional int that defines the animation type that should be displayed.

public static final java.lang.StringEXTRA_MESSAGE

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.

public static final intFAILURE_ANIMATION

public static final intOPEN_ON_PHONE_ANIMATION

public static final intSUCCESS_ANIMATION

Constructors
publicConfirmationActivity()

Methods
protected voidonAnimationFinished()

Override this method if you wish to provide different than out-of-the-box behavior when the confirmation animation finishes.

public voidonCreate(Bundle savedInstanceState)

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Fields

public static final java.lang.String EXTRA_MESSAGE

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.

public static final java.lang.String EXTRA_ANIMATION_TYPE

The lookup key for an optional int that defines the animation type that should be displayed. Should be one of ConfirmationActivity.SUCCESS_ANIMATION, ConfirmationActivity.OPEN_ON_PHONE_ANIMATION, or ConfirmationActivity.FAILURE_ANIMATION

If no value is specified it will default to ConfirmationActivity.SUCCESS_ANIMATION

public static final java.lang.String EXTRA_ANIMATION_DURATION_MILLIS

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

public static final int SUCCESS_ANIMATION

public static final int OPEN_ON_PHONE_ANIMATION

public static final int FAILURE_ANIMATION

Constructors

public ConfirmationActivity()

Methods

public void onCreate(Bundle savedInstanceState)

protected void onAnimationFinished()

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.

Source

/*
 * Copyright 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.wear.activity;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.util.SparseIntArray;

import androidx.wear.R;
import androidx.wear.widget.ConfirmationOverlay;

/**
 * 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.
 *
 * <p>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.
 *
 * <p>To configure the confirmation according to the result of the action, set the extra {@link
 * #EXTRA_ANIMATION_TYPE} to one of the following values:
 *
 * <dl>
 * <dt>{@link #SUCCESS_ANIMATION}
 * <dd>Displays a positive confirmation animation with an optional message.
 * <dt>{@link #OPEN_ON_PHONE_ANIMATION}
 * <dd>Displays an animation indicating an action has been sent to a paired device.
 * <dt>{@link #FAILURE_ANIMATION}
 * <dd>Displays a generic failure page with an optional message.
 * </dl>
 *
 * <p>An optional message, included in the extra {@link #EXTRA_MESSAGE} will be displayed
 * horizontally centered below the animation.
 *
 * <p>An optional duration in milliseconds to keep the confirmation activity visible for, included
 * in the extra {@link #EXTRA_ANIMATION_DURATION_MILLIS}
 */
public class ConfirmationActivity extends Activity {

    /**
     * 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.
     */
    public static final String EXTRA_MESSAGE = "androidx.wear.activity.extra.MESSAGE";

    /**
     * The lookup key for an optional int that defines the animation type that should be
     * displayed. Should be one of  {@link #SUCCESS_ANIMATION}, {@link #OPEN_ON_PHONE_ANIMATION},
     * or {@link #FAILURE_ANIMATION}
     *
     * <p>If no value is specified it will default to {@link #SUCCESS_ANIMATION}
     */
    public static final String EXTRA_ANIMATION_TYPE =
            "androidx.wear.activity.extra.ANIMATION_TYPE";

    /**
     * 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
     * {@link ConfirmationOverlay#DEFAULT_ANIMATION_DURATION_MS}
     */
    public static final String EXTRA_ANIMATION_DURATION_MILLIS =
            "androidx.wear.activity.extra.ANIMATION_DURATION_MILLIS";

    public static final int SUCCESS_ANIMATION = 1;
    public static final int OPEN_ON_PHONE_ANIMATION = 2;
    public static final int FAILURE_ANIMATION = 3;

    /** Default animation duration in milliseconds. **/
    static final int DEFAULT_ANIMATION_DURATION_MILLIS =
            ConfirmationOverlay.DEFAULT_ANIMATION_DURATION_MS;

    private static final SparseIntArray CONFIRMATION_OVERLAY_TYPES = new SparseIntArray();

    static {
        CONFIRMATION_OVERLAY_TYPES.append(SUCCESS_ANIMATION, ConfirmationOverlay.SUCCESS_ANIMATION);
        CONFIRMATION_OVERLAY_TYPES.append(
                OPEN_ON_PHONE_ANIMATION, ConfirmationOverlay.OPEN_ON_PHONE_ANIMATION);
        CONFIRMATION_OVERLAY_TYPES.append(FAILURE_ANIMATION, ConfirmationOverlay.FAILURE_ANIMATION);
    }

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setTheme(R.style.ConfirmationActivity);

        Intent intent = getIntent();

        int requestedType = intent.getIntExtra(EXTRA_ANIMATION_TYPE, SUCCESS_ANIMATION);
        int animationDurationMillis = intent.getIntExtra(EXTRA_ANIMATION_DURATION_MILLIS,
                DEFAULT_ANIMATION_DURATION_MILLIS);
        if (CONFIRMATION_OVERLAY_TYPES.indexOfKey(requestedType) < 0) {
            throw new IllegalArgumentException("Unknown type of animation: " + requestedType);
        }

        @ConfirmationOverlay.OverlayType int type = CONFIRMATION_OVERLAY_TYPES.get(requestedType);
        CharSequence message = intent.getStringExtra(EXTRA_MESSAGE);
        if (message == null) {
            message = "";
        }

        new ConfirmationOverlay()
                .setType(type)
                .setMessage(message)
                .setDuration(animationDurationMillis)
                .setOnAnimationFinishedListener(
                        new ConfirmationOverlay.OnAnimationFinishedListener() {
                            @Override
                            public void onAnimationFinished() {
                                ConfirmationActivity.this.onAnimationFinished();
                            }
                        })
                .showOn(this);
    }

    /**
     * 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.
     */
    protected void onAnimationFinished() {
        finish();
    }
}