CallException
public
final
class
CallException
extends RuntimeException
implements
Parcelable
java.lang.Object | ||||
↳ | java.lang.Throwable | |||
↳ | java.lang.Exception | |||
↳ | java.lang.RuntimeException | |||
↳ | android.telecom.CallException |
This class defines exceptions that can be thrown when using Telecom APIs with
OutcomeReceiver
s. Most of these exceptions are thrown when changing a call
state with CallControl
s or CallControlCallback
s.
Summary
Constants | |
---|---|
int |
CODE_CALL_CANNOT_BE_SET_TO_ACTIVE
The operation has failed because Telecom cannot set the requested call as the current active call. |
int |
CODE_CALL_IS_NOT_BEING_TRACKED
The operation has failed because Telecom has already removed the call from the server side and destroyed all the objects associated with it. |
int |
CODE_CALL_NOT_PERMITTED_AT_PRESENT_TIME
The operation has failed because there is either no PhoneAccount registered with Telecom for the given operation, or the limit of calls has been reached. |
int |
CODE_CANNOT_HOLD_CURRENT_ACTIVE_CALL
The operation has failed due to Telecom failing to hold the current active call for the call attempting to become the new active call. |
int |
CODE_ERROR_UNKNOWN
The operation has failed due to an unknown or unspecified error. |
int |
CODE_OPERATION_TIMED_OUT
The operation has failed because the operation failed to complete before the timeout |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<CallException> |
CREATOR
Responsible for creating CallAttribute objects for deserialized Parcels. |
Public constructors | |
---|---|
CallException(String message, int code)
Constructor for a new CallException that has a defined error code in this class |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
int
|
getCode()
|
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
CODE_CALL_CANNOT_BE_SET_TO_ACTIVE
public static final int CODE_CALL_CANNOT_BE_SET_TO_ACTIVE
The operation has failed because Telecom cannot set the requested call as the current active call. The client should end the current active call and re-try the operation.
Constant Value: 4 (0x00000004)
CODE_CALL_IS_NOT_BEING_TRACKED
public static final int CODE_CALL_IS_NOT_BEING_TRACKED
The operation has failed because Telecom has already removed the call from the server side and destroyed all the objects associated with it. The client should re-add the call.
Constant Value: 3 (0x00000003)
CODE_CALL_NOT_PERMITTED_AT_PRESENT_TIME
public static final int CODE_CALL_NOT_PERMITTED_AT_PRESENT_TIME
The operation has failed because there is either no PhoneAccount registered with Telecom for the given operation, or the limit of calls has been reached. The client should end the current active call and re-try the failed operation.
Constant Value: 5 (0x00000005)
CODE_CANNOT_HOLD_CURRENT_ACTIVE_CALL
public static final int CODE_CANNOT_HOLD_CURRENT_ACTIVE_CALL
The operation has failed due to Telecom failing to hold the current active call for the call attempting to become the new active call. The client should end the current active call and re-try the failed operation.
Constant Value: 2 (0x00000002)
CODE_ERROR_UNKNOWN
public static final int CODE_ERROR_UNKNOWN
The operation has failed due to an unknown or unspecified error.
Constant Value: 1 (0x00000001)
CODE_OPERATION_TIMED_OUT
public static final int CODE_OPERATION_TIMED_OUT
The operation has failed because the operation failed to complete before the timeout
Constant Value: 6 (0x00000006)
Fields
CREATOR
public static final Creator<CallException> CREATOR
Responsible for creating CallAttribute objects for deserialized Parcels.
Public constructors
CallException
public CallException (String message, int code)
Constructor for a new CallException that has a defined error code in this class
Parameters | |
---|---|
message |
String : related to why the exception was created
This value may be null . |
code |
int : defined above that caused this exception to be created
Value is CODE_ERROR_UNKNOWN , CODE_CANNOT_HOLD_CURRENT_ACTIVE_CALL , CODE_CALL_IS_NOT_BEING_TRACKED , CODE_CALL_CANNOT_BE_SET_TO_ACTIVE , CODE_CALL_NOT_PERMITTED_AT_PRESENT_TIME , or CODE_OPERATION_TIMED_OUT |
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 |
getCode
public int getCode ()
Returns | |
---|---|
int |
one of the error codes defined in this class that was passed into the constructor
Value is CODE_ERROR_UNKNOWN , CODE_CANNOT_HOLD_CURRENT_ACTIVE_CALL , CODE_CALL_IS_NOT_BEING_TRACKED , CODE_CALL_CANNOT_BE_SET_TO_ACTIVE , CODE_CALL_NOT_PERMITTED_AT_PRESENT_TIME , or CODE_OPERATION_TIMED_OUT |
writeToParcel
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.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |