FragmentActivity

public FragmentActivity()

Default constructor for FragmentActivity. All Activities must have a default constructor for API 27 and lower devices or when using the default android.app.AppComponentFactory.

@ContentView
public FragmentActivity(@LayoutRes int contentLayoutId)

Alternate constructor that can be used to provide a default layout that will be inflated as part of super.onCreate(savedInstanceState).

This should generally be called from your constructor that takes no parameters, as is required for API 27 and lower or when using the default android.app.AppComponentFactory.

public void dump(
    @NonNull String prefix,
    @Nullable FileDescriptor fd,
    @NonNull PrintWriter writer,
    @Nullable String[] args
)

Print the Activity's state into the given stream. This gets invoked if you run "adb shell dumpsys activity ".

public @NonNull FragmentManager getSupportFragmentManager()

Return the FragmentManager for interacting with fragments associated with this activity.

@MainThread
public void onAttachFragment(@NonNull Fragment fragment)

Called when a fragment is attached to the activity.

This is called after the attached fragment's onAttach and before the attached fragment's onCreate if the fragment has not yet had a previous call to onCreate.

@CallSuper
public void onRequestPermissionsResult(
    int requestCode,
    @NonNull String[] permissions,
    @NonNull int[] grantResults
)

{@inheritDoc}

public void onStateNotSaved()

Hook in to note that fragment state is no longer saved.

public void setEnterSharedElementCallback(@Nullable SharedElementCallback callback)

When makeSceneTransitionAnimation was used to start an Activity, callback will be called to handle shared elements on the launched Activity. This requires FEATURE_CONTENT_TRANSITIONS.

public void setExitSharedElementCallback(@Nullable SharedElementCallback listener)

When makeSceneTransitionAnimation was used to start an Activity, listener will be called to handle shared elements on the launching Activity. Most calls will only come when returning from the started Activity. This requires FEATURE_CONTENT_TRANSITIONS.

public void startActivityFromFragment(
    @NonNull Fragment fragment,
    @NonNull Intent intent,
    int requestCode
)

Called by Fragment.startActivityForResult() to implement its behavior.

public void startActivityFromFragment(
    @NonNull Fragment fragment,
    @NonNull Intent intent,
    int requestCode,
    @Nullable Bundle options
)

Called by Fragment.startActivityForResult() to implement its behavior.

public void startIntentSenderFromFragment(
    @NonNull Fragment fragment,
    @NonNull IntentSender intent,
    int requestCode,
    @Nullable Intent fillInIntent,
    int flagsMask,
    int flagsValues,
    int extraFlags,
    @Nullable Bundle options
)

Called by Fragment.startIntentSenderForResult() to implement its behavior.

public void supportFinishAfterTransition()

Reverses the Activity Scene entry Transition and triggers the calling Activity to reverse its exit Transition. When the exit Transition completes, finish is called. If no entry Transition was used, finish() is called immediately and the Activity exit Transition is run.

On Android 4.4 or lower, this method only finishes the Activity with no special exit transition.

public void supportInvalidateOptionsMenu()

Support library version of invalidateOptionsMenu.

Invalidate the activity's options menu. This will cause relevant presentations of the menu to fully update via calls to onCreateOptionsMenu and onPrepareOptionsMenu the next time the menu is requested.

public void supportPostponeEnterTransition()

Support library version of postponeEnterTransition that works only on API 21 and later.

public void supportStartPostponedEnterTransition()

Support library version of startPostponedEnterTransition that only works with API 21 and later.

@CallSuper
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data)

{@inheritDoc}

protected void onCreate(@Nullable Bundle savedInstanceState)

{@inheritDoc}

If your ComponentActivity is annotated with ContentView, this will call setContentView for you.

protected void onDestroy()

Destroy all fragments.

protected void onPause()

Dispatch onPause() to fragments.

protected void onPostResume()

Dispatch onResume() to fragments.

protected void onResume()

Dispatch onResume() to fragments. Note that for better inter-operation with older versions of the platform, at the point of this call the fragments attached to the activity are not resumed.

protected void onResumeFragments()

This is the fragment-orientated version of onResume that you can override to perform operations in the Activity at the same point where its fragments are resumed. Be sure to always call through to the super-class.

protected void onStart()

Dispatch onStart() to all fragments.

protected void onStop()

Dispatch onStop() to all fragments.

public final @NonNull AuthenticationResultLauncher AuthenticationUtils.registerForAuthenticationResult(
    @NonNull FragmentActivity receiver,
    @NonNull Function0<Unit> onAuthFailedCallback,
    @NonNull AuthenticationResultCallback resultCallback
)

Register a request to start an authentication for result.

This must be called unconditionally, as part of initialization path, typically as a field initializer of an Activity.

Note that if multiple calls to this method are made within a single Fragment or Activity, only the callback registered by the last invocation will be saved and receive authentication results. This can result in unexpected behavior if you intend to manage multiple independent authentication flows. It is strongly recommended to avoid multiple calls to this method in such scenarios.

import androidx.biometric.AuthenticationRequest
import androidx.biometric.AuthenticationRequest.Biometric
import androidx.biometric.AuthenticationRequest.Companion.biometricRequest
import androidx.biometric.AuthenticationResult
import androidx.biometric.PromptContentItemBulletedText
import androidx.biometric.registerForAuthenticationResult
import androidx.fragment.app.Fragment
import androidx.fragment.app.FragmentActivity

class MyActivityForBiometricAuth : FragmentActivity() {
    val requestAuthentication =
        registerForAuthenticationResult(
            // Handle intermediate authentication failure, this is optional.
            onAuthFailedCallback = { Log.i(TAG, "onAuthenticationFailed, try again") }
        ) { result: AuthenticationResult ->
            when (result) {
                // Handle successful authentication
                is AuthenticationResult.Success -> {
                    Log.i(TAG, "onAuthenticationSucceeded with type" + result.authType)
                }
                // Handle authentication error, e.g. negative button click, user cancellation,
                // etc
                is AuthenticationResult.Error -> {
                    Log.i(
                        TAG,
                        "onAuthenticationError " + result.errorCode + " " + result.errString
                    )
                }
            }
        }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val authRequest =
            biometricRequest(
                title = "Title",
                authFallback = Biometric.Fallback.DeviceCredential,
            ) {
                setSubtitle("Subtitle")
                setContent(
                    AuthenticationRequest.BodyContent.VerticalList(
                        "Vertical list description",
                        listOf(
                            PromptContentItemBulletedText("test item1"),
                            PromptContentItemBulletedText("test item2")
                        )
                    )
                )
                setMinStrength(Biometric.Strength.Class3(/*optional: cryptoObject*/ ))
                setIsConfirmationRequired(true)
            }

        Button(this).setOnClickListener { requestAuthentication.launch(authRequest) }
    }
}

public final @NonNull BiometricPrompt.AuthenticationResult Class2BiometricAuthExtensionsKt.authenticateWithClass2Biometrics(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

public final @NonNull <Error class: unknown class> Class2BiometricAuthExtensionsKt.startClass2BiometricAuthentication(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired,
    Executor executor,
    @NonNull <Error class: unknown class> callback
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris).

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

public final @NonNull BiometricPrompt.AuthenticationResult Class2BiometricOrCredentialAuthExtensionsKt.authenticateWithClass2BiometricsOrCredentials(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris) or the screen lock credential (i.e. PIN, pattern, or password) for the device.

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

public final @NonNull <Error class: unknown class> Class2BiometricOrCredentialAuthExtensionsKt.startClass2BiometricOrCredentialAuthentication(
    @NonNull FragmentActivity receiver,
    @NonNull CharSequence title,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired,
    Executor executor,
    @NonNull <Error class: unknown class> callback
)

Prompts the user to authenticate with a Class 2 biometric (e.g. fingerprint, face, or iris) or the screen lock credential (i.e. PIN, pattern, or password) for the device.

Note that Class 3 biometrics are guaranteed to meet the requirements for Class 2 and thus will also be accepted.

public final @NonNull BiometricPrompt.AuthenticationResult Class3BiometricAuthExtensionsKt.authenticateWithClass3Biometrics(
    @NonNull FragmentActivity receiver,
    BiometricPrompt.CryptoObject crypto,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired
)

Prompts the user to authenticate with a Class 3 biometric (e.g. fingerprint, face, or iris).

public final @NonNull <Error class: unknown class> Class3BiometricAuthExtensionsKt.authenticateWithClass3Biometrics(
    @NonNull FragmentActivity receiver,
    BiometricPrompt.CryptoObject crypto,
    @NonNull CharSequence title,
    @NonNull CharSequence negativeButtonText,
    CharSequence subtitle,
    CharSequence description,
    boolean confirmationRequired,
    Executor executor,
    @NonNull <Error class: unknown class> callback
)

Prompts the user to authenticate with a Class 3 biometric (e.g. fingerprint, face, or iris).