public class

AuthPromptHost

extends java.lang.Object

 java.lang.Object

↳androidx.biometric.auth.AuthPromptHost

Gradle dependencies

compile group: 'androidx.biometric', name: 'biometric', version: '1.2.0-alpha04'

  • groupId: androidx.biometric
  • artifactId: biometric
  • version: 1.2.0-alpha04

Artifact androidx.biometric:biometric:1.2.0-alpha04 it located at Google repository (https://maven.google.com/)

Overview

A wrapper class for the component that will be used to host an auth prompt.

Summary

Constructors
publicAuthPromptHost(Fragment fragment)

Constructs an AuthPromptHost wrapper for the given fragment.

publicAuthPromptHost(FragmentActivity activity)

Constructs an AuthPromptHost wrapper for the given activity.

Methods
public FragmentActivitygetActivity()

Gets the activity that will host the prompt, if set.

public FragmentgetFragment()

Gets the fragment that will host the prompt, if set.

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

Constructors

public AuthPromptHost(FragmentActivity activity)

Constructs an AuthPromptHost wrapper for the given activity.

Parameters:

activity: The activity that will host the prompt.

public AuthPromptHost(Fragment fragment)

Constructs an AuthPromptHost wrapper for the given fragment.

Parameters:

fragment: The fragment that will host the prompt.

Methods

public FragmentActivity getActivity()

Gets the activity that will host the prompt, if set.

Returns:

The activity that will host the prompt, or null if the prompt will be hosted by a different type of component.

public Fragment getFragment()

Gets the fragment that will host the prompt, if set.

Returns:

The fragment that will host the prompt, or null if the prompt will be hosted by a different type of component.

Source

/*
 * Copyright 2020 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.biometric.auth;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.fragment.app.Fragment;
import androidx.fragment.app.FragmentActivity;

/**
 * A wrapper class for the component that will be used to host an auth prompt.
 */
public class AuthPromptHost {
    @Nullable private FragmentActivity mActivity;
    @Nullable private Fragment mFragment;

    /**
     * Constructs an {@link AuthPromptHost} wrapper for the given activity.
     *
     * @param activity The activity that will host the prompt.
     */
    public AuthPromptHost(@NonNull FragmentActivity activity) {
        mActivity = activity;
    }

    /**
     * Constructs an {@link AuthPromptHost} wrapper for the given fragment.
     *
     * @param fragment The fragment that will host the prompt.
     */
    public AuthPromptHost(@NonNull Fragment fragment) {
        mFragment = fragment;
    }

    /**
     * Gets the activity that will host the prompt, if set.
     *
     * @return The activity that will host the prompt, or {@code null} if the prompt will be hosted
     * by a different type of component.
     */
    @Nullable
    public FragmentActivity getActivity() {
        return mActivity;
    }

    /**
     * Gets the fragment that will host the prompt, if set.
     *
     * @return The fragment that will host the prompt, or {@code null} if the prompt will be hosted
     * by a different type of component.
     */
    @Nullable
    public Fragment getFragment() {
        return mFragment;
    }
}