Added in API level 26

AuthenticationRequiredException


class AuthenticationRequiredException : SecurityException, Parcelable
kotlin.Any
   ↳ kotlin.Throwable
   ↳ java.lang.Exception
   ↳ java.lang.RuntimeException
   ↳ java.lang.SecurityException
   ↳ android.app.AuthenticationRequiredException

Specialization of SecurityException that is thrown when authentication is needed from the end user before viewing the content.

This exception is only appropriate where there is a concrete action the user can take to authorize and make forward progress, such as confirming or entering authentication credentials, or granting access via other means.

Note: legacy code that receives this exception may treat it as a general SecurityException, and thus there is no guarantee that the action contained will be invoked by the user.

Summary

Inherited constants
Public constructors

Create an instance ready to be thrown.

Public methods
Int

PendingIntent!

Return primary action that will initiate the authorization.

Unit
writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<AuthenticationRequiredException!>

Public constructors

AuthenticationRequiredException

Added in API level 26
AuthenticationRequiredException(
    cause: Throwable!,
    userAction: PendingIntent!)

Create an instance ready to be thrown.

Parameters
cause Throwable!: original cause with details designed for engineering audiences.
userAction PendingIntent!: primary action that will initiate the recovery. This must launch an activity that is expected to set Activity#setResult(int) before finishing to communicate the final status of the recovery. For example, apps that observe Activity#RESULT_OK may choose to immediately retry their operation.

Public methods

describeContents

Added in API level 26
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getUserAction

Added in API level 26
fun getUserAction(): PendingIntent!

Return primary action that will initiate the authorization.

writeToParcel

Added in API level 26
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit
Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 26
static val CREATOR: Parcelable.Creator<AuthenticationRequiredException!>