Merge "Define UserSelectionResult for when a UI flow completes."

/*

 * Copyright 2022 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 android.credentials.ui;

import android.annotation.NonNull;

import android.os.IBinder;

import android.os.Parcel;

import android.os.Parcelable;

import com.android.internal.util.AnnotationValidations;

/**

 * User selection result information of a UX flow.

 *

 * Returned as part of the activity result intent data when the user dialog completes

 * successfully.

 *

 * @hide

 */

public class UserSelectionResult implements Parcelable {

    /**

    * The intent extra key for the {@code UserSelectionResult} object when the credential selector

    * activity finishes.

    */

    public static final String EXTRA_USER_SELECTION_RESULT =

            "android.credentials.ui.extra.USER_SELECTION_RESULT";

    @NonNull

    private final IBinder mRequestToken;

    // TODO: consider switching to string or other types, depending on the service implementation.

    private final int mEntryId;

    public UserSelectionResult(@NonNull IBinder requestToken, int entryId) {

        mRequestToken = requestToken;

        mEntryId = entryId;

    }

    /** Returns token of the app request that initiated this user dialog. */

    @NonNull

    public IBinder getRequestToken() {

        return mRequestToken;

    }

    /** Returns the id of the visual entry that the user selected. */

    public int geEntryId() {

        return mEntryId;

    }

    protected UserSelectionResult(@NonNull Parcel in) {

        IBinder requestToken = in.readStrongBinder();

        int entryId = in.readInt();

        mRequestToken = requestToken;

        AnnotationValidations.validate(NonNull.class, null, mRequestToken);

        mEntryId = entryId;

    }

    @Override

    public void writeToParcel(@NonNull Parcel dest, int flags) {

        dest.writeStrongBinder(mRequestToken);

        dest.writeInt(mEntryId);

    }

    @Override

    public int describeContents() {

        return 0;

    }

    public static final @NonNull Creator<UserSelectionResult> CREATOR =

            new Creator<UserSelectionResult>() {

        @Override

        public UserSelectionResult createFromParcel(@NonNull Parcel in) {

            return new UserSelectionResult(in);

        }

        @Override

        public UserSelectionResult[] newArray(int size) {

            return new UserSelectionResult[size];

        }

    };

}