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 OutcomeReceivers. Most of these exceptions are thrown when changing a call state with CallControls or CallControlCallbacks.

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

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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

final void addSuppressed(Throwable exception)

Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.

Throwable fillInStackTrace()

Fills in the execution stack trace.

Throwable getCause()

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

String getLocalizedMessage()

Creates a localized description of this throwable.

String getMessage()

Returns the detail message string of this throwable.

StackTraceElement[] getStackTrace()

Provides programmatic access to the stack trace information printed by printStackTrace().

final Throwable[] getSuppressed()

Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.

Throwable initCause(Throwable cause)

Initializes the cause of this throwable to the specified value.

void printStackTrace()

Prints this throwable and its backtrace to the standard error stream.

void printStackTrace(PrintWriter s)

Prints this throwable and its backtrace to the specified print writer.

void printStackTrace(PrintStream s)

Prints this throwable and its backtrace to the specified print stream.

void setStackTrace(StackTraceElement[] stackTrace)

Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.

String toString()

Returns a short description of this throwable.

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.

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.

Constants

CODE_CALL_CANNOT_BE_SET_TO_ACTIVE

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
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

Added in API level 34
public static final Creator<CallException> CREATOR

Responsible for creating CallAttribute objects for deserialized Parcels.

Public constructors

CallException

Added in API level 34
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

Added in API level 34
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

Added in API level 34
public int getCode ()

writeToParcel

Added in API level 34
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