AuthenticationRequiredException

Kotlin |Java

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

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`AuthenticationRequiredException(cause: Throwable!, userAction: PendingIntent!)` Create an instance ready to be thrown.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
PendingIntent!	`getUserAction()` Return primary action that will initiate the authorization.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AuthenticationRequiredException!>	`CREATOR`

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

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `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

Flatten this object in to a Parcel.

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 the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 26

static val CREATOR: Parcelable.Creator<AuthenticationRequiredException!>