public final class DisconnectCause extends Object implements Parcelable
ConnectionService
to provide localized versions of
the label and description. It also may contain a reason for the disconnect, which is intended for
logging and not for display to the user.Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static int |
ANSWERED_ELSEWHERE
Disconnected because the user did not locally answer the incoming call, but it was answered
on another device where the call was ringing.
|
static int |
BUSY
Disconnected because the other party was busy.
|
static int |
CALL_PULLED
Disconnected because the call was pulled from the current device to another device.
|
static int |
CANCELED
Disconnected because it has been canceled.
|
static int |
CONNECTION_MANAGER_NOT_SUPPORTED
Disconnected because the connection manager did not support the call.
|
static Parcelable.Creator<DisconnectCause> |
CREATOR |
static int |
ERROR
Disconnected because there was an error, such as a problem with the network.
|
static int |
LOCAL
Disconnected because of a local user-initiated action, such as hanging up.
|
static int |
MISSED
Disconnected because there was no response to an incoming call.
|
static int |
OTHER
Disconnected for reason not described by other disconnect codes.
|
static int |
REJECTED
Disconnected because the user rejected an incoming call.
|
static int |
REMOTE
Disconnected because of a remote user-initiated action, such as the other party hanging up
up.
|
static int |
RESTRICTED
Disconnected because of a restriction on placing the call, such as dialing in airplane
mode.
|
static int |
UNKNOWN
Disconnected because of an unknown or unspecified reason.
|
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_WRITE_RETURN_VALUE
Constructor and Description |
---|
DisconnectCause(int code)
Creates a new DisconnectCause.
|
DisconnectCause(int code,
CharSequence label,
CharSequence description,
String reason)
Creates a new DisconnectCause.
|
DisconnectCause(int code,
CharSequence label,
CharSequence description,
String reason,
int toneToPlay)
Creates a new DisconnectCause.
|
DisconnectCause(int code,
String reason)
Creates a new DisconnectCause.
|
Modifier and Type | Method and Description |
---|---|
int |
describeContents()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation.
|
boolean |
equals(Object o)
Indicates whether some other object is "equal to" this one.
|
int |
getCode()
Returns the code for the reason for this disconnect.
|
CharSequence |
getDescription()
Returns a description which explains the reason for the disconnect cause and is for display
in the user interface.
|
CharSequence |
getLabel()
Returns a short label which explains the reason for the disconnect cause and is for display
in the user interface.
|
String |
getReason()
Returns an explanation of the reason for the disconnect.
|
int |
getTone()
Returns the tone to play when disconnected.
|
int |
hashCode()
Returns a hash code value for the object.
|
String |
toString()
Returns a string representation of the object.
|
void |
writeToParcel(Parcel destination,
int flags)
Flatten this object in to a Parcel.
|
public static final int UNKNOWN
public static final int ERROR
public static final int LOCAL
public static final int REMOTE
public static final int CANCELED
public static final int MISSED
public static final int REJECTED
public static final int BUSY
public static final int RESTRICTED
public static final int OTHER
public static final int CONNECTION_MANAGER_NOT_SUPPORTED
PhoneAccount.CAPABILITY_CONNECTION_MANAGER
.public static final int ANSWERED_ELSEWHERE
public static final int CALL_PULLED
public static final Parcelable.Creator<DisconnectCause> CREATOR
public DisconnectCause(int code)
code
- The code for the disconnect cause.public DisconnectCause(int code, String reason)
code
- The code for the disconnect cause.reason
- The reason for the disconnect.public DisconnectCause(int code, CharSequence label, CharSequence description, String reason)
code
- The code for the disconnect cause.label
- The localized label to show to the user to explain the disconnect.description
- The localized description to show to the user to explain the disconnect.reason
- The reason for the disconnect.public DisconnectCause(int code, CharSequence label, CharSequence description, String reason, int toneToPlay)
code
- The code for the disconnect cause.label
- The localized label to show to the user to explain the disconnect.description
- The localized description to show to the user to explain the disconnect.reason
- The reason for the disconnect.toneToPlay
- The tone to play on disconnect, as defined in ToneGenerator
.public int getCode()
public CharSequence getLabel()
ConnectionService
is responsible for
providing and localizing this label. If there is no string provided, returns null.public CharSequence getDescription()
getLabel()
, however it can exist even if getLabel()
is empty. The In-Call UI
should display this relatively prominently; the traditional implementation displays this as
an alert dialog. The ConnectionService
is responsible for providing and localizing
this message. If there is no string provided, returns null.public String getReason()
public int getTone()
ToneGenerator
to play when disconnected.public void writeToParcel(Parcel destination, int flags)
Parcelable
writeToParcel
in interface Parcelable
destination
- The Parcel in which the object should be written.flags
- Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE
.public int describeContents()
Parcelable
Parcelable.writeToParcel(Parcel, int)
,
the return value of this method must include the
Parcelable.CONTENTS_FILE_DESCRIPTOR
bit.describeContents
in interface Parcelable
Parcelable.CONTENTS_FILE_DESCRIPTOR
public int hashCode()
Object
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public boolean equals(Object o)
Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in class Object
o
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public String toString()
Object
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())