• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.telephony;
18 
19 /**
20  * Contains disconnect call causes generated by the framework and the RIL.
21  * @hide
22  */
23 public class DisconnectCause {
24 
25     /** The disconnect cause is not valid (Not received a disconnect cause) */
26     public static final int NOT_VALID                      = -1;
27     /** Has not yet disconnected */
28     public static final int NOT_DISCONNECTED               = 0;
29     /** An incoming call that was missed and never answered */
30     public static final int INCOMING_MISSED                = 1;
31     /** Normal; Remote hangup*/
32     public static final int NORMAL                         = 2;
33     /** Normal; Local hangup */
34     public static final int LOCAL                          = 3;
35     /** Outgoing call to busy line */
36     public static final int BUSY                           = 4;
37     /** Outgoing call to congested network */
38     public static final int CONGESTION                     = 5;
39     /** Not presently used */
40     public static final int MMI                            = 6;
41     /** Invalid dial string */
42     public static final int INVALID_NUMBER                 = 7;
43     /** Cannot reach the peer */
44     public static final int NUMBER_UNREACHABLE             = 8;
45     /** Cannot reach the server */
46     public static final int SERVER_UNREACHABLE             = 9;
47     /** Invalid credentials */
48     public static final int INVALID_CREDENTIALS            = 10;
49     /** Calling from out of network is not allowed */
50     public static final int OUT_OF_NETWORK                 = 11;
51     /** Server error */
52     public static final int SERVER_ERROR                   = 12;
53     /** Client timed out */
54     public static final int TIMED_OUT                      = 13;
55     /** Client went out of network range */
56     public static final int LOST_SIGNAL                    = 14;
57     /** GSM or CDMA ACM limit exceeded */
58     public static final int LIMIT_EXCEEDED                 = 15;
59     /** An incoming call that was rejected */
60     public static final int INCOMING_REJECTED              = 16;
61     /** Radio is turned off explicitly */
62     public static final int POWER_OFF                      = 17;
63     /** Out of service */
64     public static final int OUT_OF_SERVICE                 = 18;
65     /** No ICC, ICC locked, or other ICC error */
66     public static final int ICC_ERROR                      = 19;
67     /** Call was blocked by call barring */
68     public static final int CALL_BARRED                    = 20;
69     /** Call was blocked by fixed dial number */
70     public static final int FDN_BLOCKED                    = 21;
71     /** Call was blocked by restricted all voice access */
72     public static final int CS_RESTRICTED                  = 22;
73     /** Call was blocked by restricted normal voice access */
74     public static final int CS_RESTRICTED_NORMAL           = 23;
75     /** Call was blocked by restricted emergency voice access */
76     public static final int CS_RESTRICTED_EMERGENCY        = 24;
77     /** Unassigned number */
78     public static final int UNOBTAINABLE_NUMBER            = 25;
79     /** MS is locked until next power cycle */
80     public static final int CDMA_LOCKED_UNTIL_POWER_CYCLE  = 26;
81     /** Drop call*/
82     public static final int CDMA_DROP                      = 27;
83     /** INTERCEPT order received, MS state idle entered */
84     public static final int CDMA_INTERCEPT                 = 28;
85     /** MS has been redirected, call is cancelled */
86     public static final int CDMA_REORDER                   = 29;
87     /** Service option rejection */
88     public static final int CDMA_SO_REJECT                 = 30;
89     /** Requested service is rejected, retry delay is set */
90     public static final int CDMA_RETRY_ORDER               = 31;
91     /** Unable to obtain access to the CDMA system */
92     public static final int CDMA_ACCESS_FAILURE            = 32;
93     /** Not a preempted call */
94     public static final int CDMA_PREEMPTED                 = 33;
95     /** Not an emergency call */
96     public static final int CDMA_NOT_EMERGENCY             = 34;
97     /** Access Blocked by CDMA network */
98     public static final int CDMA_ACCESS_BLOCKED            = 35;
99     /** Unknown error or not specified */
100     public static final int ERROR_UNSPECIFIED              = 36;
101     /**
102      * Only emergency numbers are allowed, but we tried to dial
103      * a non-emergency number.
104      */
105     // TODO: This should be the same as NOT_EMERGENCY
106     public static final int EMERGENCY_ONLY                 = 37;
107     /**
108      * The supplied CALL Intent didn't contain a valid phone number.
109      */
110     public static final int NO_PHONE_NUMBER_SUPPLIED       = 38;
111     /**
112      * Our initial phone number was actually an MMI sequence.
113      */
114     public static final int DIALED_MMI                     = 39;
115     /**
116      * We tried to call a voicemail: URI but the device has no
117      * voicemail number configured.
118      */
119     public static final int VOICEMAIL_NUMBER_MISSING       = 40;
120     /**
121      * This status indicates that InCallScreen should display the
122      * CDMA-specific "call lost" dialog.  (If an outgoing call fails,
123      * and the CDMA "auto-retry" feature is enabled, *and* the retried
124      * call fails too, we display this specific dialog.)
125      *
126      * TODO: this is currently unused, since the "call lost" dialog
127      * needs to be triggered by a *disconnect* event, rather than when
128      * the InCallScreen first comes to the foreground.  For now we use
129      * the needToShowCallLostDialog field for this (see below.)
130      */
131     public static final int CDMA_CALL_LOST                 = 41;
132     /**
133      * This status indicates that the call was placed successfully,
134      * but additionally, the InCallScreen needs to display the
135      * "Exiting ECM" dialog.
136      *
137      * (Details: "Emergency callback mode" is a CDMA-specific concept
138      * where the phone disallows data connections over the cell
139      * network for some period of time after you make an emergency
140      * call.  If the phone is in ECM and you dial a non-emergency
141      * number, that automatically *cancels* ECM, but we additionally
142      * need to warn the user that ECM has been canceled (see bug
143      * 4207607.))
144      *
145      * TODO: Rethink where the best place to put this is. It is not a notification
146      * of a failure of the connection -- it is an additional message that accompanies
147      * a successful connection giving the user important information about what happened.
148      *
149      * {@hide}
150      */
151     public static final int EXITED_ECM                     = 42;
152 
153     /**
154      * The outgoing call failed with an unknown cause.
155      */
156     public static final int OUTGOING_FAILURE               = 43;
157 
158     /**
159      * The outgoing call was canceled by the {@link android.telecom.ConnectionService}.
160      */
161     public static final int OUTGOING_CANCELED              = 44;
162 
163     /**
164      * The call, which was an IMS call, disconnected because it merged with another call.
165      */
166     public static final int IMS_MERGED_SUCCESSFULLY        = 45;
167 
168     /**
169      * Stk Call Control modified DIAL request to USSD request.
170      * {@hide}
171      */
172     public static final int DIAL_MODIFIED_TO_USSD          = 46;
173     /**
174      * Stk Call Control modified DIAL request to SS request.
175      * {@hide}
176      */
177     public static final int DIAL_MODIFIED_TO_SS            = 47;
178     /**
179      * Stk Call Control modified DIAL request to DIAL with modified data.
180      * {@hide}
181      */
182     public static final int DIAL_MODIFIED_TO_DIAL          = 48;
183 
184     /**
185      * The call was terminated because CDMA phone service and roaming have already been activated.
186      * {@hide}
187      */
188     public static final int CDMA_ALREADY_ACTIVATED         = 49;
189 
190     /**
191      * The call was terminated because it is not possible to place a video call while TTY is
192      * enabled.
193      * {@hide}
194      */
195     public static final int VIDEO_CALL_NOT_ALLOWED_WHILE_TTY_ENABLED = 50;
196 
197     /**
198      * The call was terminated because it was pulled to another device.
199      * {@hide}
200      */
201     public static final int CALL_PULLED = 51;
202 
203     /**
204      * The call was terminated because it was answered on another device.
205      * {@hide}
206      */
207     public static final int ANSWERED_ELSEWHERE = 52;
208 
209     /**
210      * The call was terminated because the maximum allowable number of calls has been reached.
211      * {@hide}
212      */
213     public static final int MAXIMUM_NUMBER_OF_CALLS_REACHED = 53;
214 
215     /**
216      * The call was terminated because cellular data has been disabled.
217      * Used when in a video call and the user disables cellular data via the settings.
218      * {@hide}
219      */
220     public static final int DATA_DISABLED = 54;
221 
222     /**
223      * The call was terminated because the data policy has disabled cellular data.
224      * Used when in a video call and the user has exceeded the device data limit.
225      * {@hide}
226      */
227     public static final int DATA_LIMIT_REACHED = 55;
228 
229     /**
230      * The emergency call was terminated because it was dialed on the wrong SIM slot.
231      * The call needs to be redialed the other slot.
232      * {@hide}
233      */
234     public static final int DIALED_ON_WRONG_SLOT = 56;
235 
236     /**
237      * The call being placed was detected as a call forwarding number and was being dialed while
238      * roaming on a carrier that does not allow this.
239      */
240     public static final int DIALED_CALL_FORWARDING_WHILE_ROAMING = 57;
241 
242     /**
243      * The network does not accept the emergency call request because IMEI was used as
244      * identification and this cability is not supported by the network.
245      * {@hide}
246      */
247     public static final int IMEI_NOT_ACCEPTED = 58;
248 
249     /**
250      * A call over WIFI was disconnected because the WIFI signal was lost or became too degraded to
251      * continue the call.
252      */
253     public static final int WIFI_LOST = 59;
254 
255     //*********************************************************************************************
256     // When adding a disconnect type:
257     // 1) Update toString() with the newly added disconnect type.
258     // 2) Update android.telecom.DisconnectCauseUtil with any mappings to a telecom.DisconnectCause.
259     //*********************************************************************************************
260 
261     /** Private constructor to avoid class instantiation. */
DisconnectCause()262     private DisconnectCause() {
263         // Do nothing.
264     }
265 
266     /** Returns descriptive string for the specified disconnect cause. */
toString(int cause)267     public static String toString(int cause) {
268         switch (cause) {
269         case NOT_DISCONNECTED:
270             return "NOT_DISCONNECTED";
271         case INCOMING_MISSED:
272             return "INCOMING_MISSED";
273         case NORMAL:
274             return "NORMAL";
275         case LOCAL:
276             return "LOCAL";
277         case BUSY:
278             return "BUSY";
279         case CONGESTION:
280             return "CONGESTION";
281         case INVALID_NUMBER:
282             return "INVALID_NUMBER";
283         case NUMBER_UNREACHABLE:
284             return "NUMBER_UNREACHABLE";
285         case SERVER_UNREACHABLE:
286             return "SERVER_UNREACHABLE";
287         case INVALID_CREDENTIALS:
288             return "INVALID_CREDENTIALS";
289         case OUT_OF_NETWORK:
290             return "OUT_OF_NETWORK";
291         case SERVER_ERROR:
292             return "SERVER_ERROR";
293         case TIMED_OUT:
294             return "TIMED_OUT";
295         case LOST_SIGNAL:
296             return "LOST_SIGNAL";
297         case LIMIT_EXCEEDED:
298             return "LIMIT_EXCEEDED";
299         case INCOMING_REJECTED:
300             return "INCOMING_REJECTED";
301         case POWER_OFF:
302             return "POWER_OFF";
303         case OUT_OF_SERVICE:
304             return "OUT_OF_SERVICE";
305         case ICC_ERROR:
306             return "ICC_ERROR";
307         case CALL_BARRED:
308             return "CALL_BARRED";
309         case FDN_BLOCKED:
310             return "FDN_BLOCKED";
311         case CS_RESTRICTED:
312             return "CS_RESTRICTED";
313         case CS_RESTRICTED_NORMAL:
314             return "CS_RESTRICTED_NORMAL";
315         case CS_RESTRICTED_EMERGENCY:
316             return "CS_RESTRICTED_EMERGENCY";
317         case UNOBTAINABLE_NUMBER:
318             return "UNOBTAINABLE_NUMBER";
319         case CDMA_LOCKED_UNTIL_POWER_CYCLE:
320             return "CDMA_LOCKED_UNTIL_POWER_CYCLE";
321         case CDMA_DROP:
322             return "CDMA_DROP";
323         case CDMA_INTERCEPT:
324             return "CDMA_INTERCEPT";
325         case CDMA_REORDER:
326             return "CDMA_REORDER";
327         case CDMA_SO_REJECT:
328             return "CDMA_SO_REJECT";
329         case CDMA_RETRY_ORDER:
330             return "CDMA_RETRY_ORDER";
331         case CDMA_ACCESS_FAILURE:
332             return "CDMA_ACCESS_FAILURE";
333         case CDMA_PREEMPTED:
334             return "CDMA_PREEMPTED";
335         case CDMA_NOT_EMERGENCY:
336             return "CDMA_NOT_EMERGENCY";
337         case CDMA_ACCESS_BLOCKED:
338             return "CDMA_ACCESS_BLOCKED";
339         case EMERGENCY_ONLY:
340             return "EMERGENCY_ONLY";
341         case NO_PHONE_NUMBER_SUPPLIED:
342             return "NO_PHONE_NUMBER_SUPPLIED";
343         case DIALED_MMI:
344             return "DIALED_MMI";
345         case VOICEMAIL_NUMBER_MISSING:
346             return "VOICEMAIL_NUMBER_MISSING";
347         case CDMA_CALL_LOST:
348             return "CDMA_CALL_LOST";
349         case EXITED_ECM:
350             return "EXITED_ECM";
351         case DIAL_MODIFIED_TO_USSD:
352             return "DIAL_MODIFIED_TO_USSD";
353         case DIAL_MODIFIED_TO_SS:
354             return "DIAL_MODIFIED_TO_SS";
355         case DIAL_MODIFIED_TO_DIAL:
356             return "DIAL_MODIFIED_TO_DIAL";
357         case ERROR_UNSPECIFIED:
358             return "ERROR_UNSPECIFIED";
359         case OUTGOING_FAILURE:
360             return "OUTGOING_FAILURE";
361         case OUTGOING_CANCELED:
362             return "OUTGOING_CANCELED";
363         case IMS_MERGED_SUCCESSFULLY:
364             return "IMS_MERGED_SUCCESSFULLY";
365         case CDMA_ALREADY_ACTIVATED:
366             return "CDMA_ALREADY_ACTIVATED";
367         case VIDEO_CALL_NOT_ALLOWED_WHILE_TTY_ENABLED:
368             return "VIDEO_CALL_NOT_ALLOWED_WHILE_TTY_ENABLED";
369         case CALL_PULLED:
370             return "CALL_PULLED";
371         case ANSWERED_ELSEWHERE:
372             return "ANSWERED_ELSEWHERE";
373         case MAXIMUM_NUMBER_OF_CALLS_REACHED:
374             return "MAXIMUM_NUMER_OF_CALLS_REACHED";
375         case DATA_DISABLED:
376             return "DATA_DISABLED";
377         case DATA_LIMIT_REACHED:
378             return "DATA_LIMIT_REACHED";
379         case DIALED_ON_WRONG_SLOT:
380             return "DIALED_ON_WRONG_SLOT";
381         case DIALED_CALL_FORWARDING_WHILE_ROAMING:
382             return "DIALED_CALL_FORWARDING_WHILE_ROAMING";
383         case IMEI_NOT_ACCEPTED:
384             return "IMEI_NOT_ACCEPTED";
385         case WIFI_LOST:
386             return "WIFI_LOST";
387         default:
388             return "INVALID: " + cause;
389         }
390     }
391 }
392