lightbulb_outline Please take our October 2018 developer survey. Start survey

AuthenticationRequiredException

public final class AuthenticationRequiredException
extends SecurityException implements Parcelable

java.lang.Object
   ↳ java.lang.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

Fields

public static final Creator<AuthenticationRequiredException> CREATOR

Public constructors

AuthenticationRequiredException(Throwable cause, PendingIntent userAction)

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.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 26
public static final Creator<AuthenticationRequiredException> CREATOR

Public constructors

AuthenticationRequiredException

added in API level 26
public AuthenticationRequiredException (Throwable cause, 
                PendingIntent userAction)

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
public int describeContents ()

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(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getUserAction

added in API level 26
public PendingIntent getUserAction ()

Return primary action that will initiate the authorization.

Returns
PendingIntent

writeToParcel

added in API level 26
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.