Skip to content

Most visited

Recently visited

navigation

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

From interface android.os.Parcelable

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

From class java.lang.Throwable
From class java.lang.Object
From interface android.os.Parcelable

Fields

Public constructors

AuthenticationRequiredException

added in API level 26
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 setResult(int) before finishing to communicate the final status of the recovery. For example, apps that observe RESULT_OK may choose to immediately retry their operation.

Public methods

describeContents

added in API level 26
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
PendingIntent getUserAction ()

Return primary action that will initiate the authorization.

Returns
PendingIntent

writeToParcel

added in API level 26
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_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)