AuthenticationRequiredException
bookmark_borderbookmark
Stay organized with collections
Save and categorize content based on your preferences.
public
final
class
AuthenticationRequiredException
extends SecurityException
implements
Parcelable
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
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
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
From interface
android.os.Parcelable
abstract
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation.
|
abstract
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
|
|
Fields
Public constructors
AuthenticationRequiredException
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
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(android.os.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.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
getUserAction
public PendingIntent getUserAction ()
Return primary action that will initiate the authorization.
writeToParcel
public void writeToParcel (Parcel dest,
int flags)
Flatten this object in to a Parcel.