DisconnectCause.java revision 2a3f997b020ccd11718203044a96d42da1eea3ba
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 17package android.telephony; 18 19/** 20 * Contains disconnect call causes generated by the framework and the RIL. 21 * @hide 22 */ 23public 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 // When adding a disconnect type: 211 // 1) Please assign the new type the next id value below. 212 // 2) Increment the next id value below to a new value. 213 // 3) Update MAXIMUM_VALID_VALUE to the new disconnect type. 214 // 4) Update toString() with the newly added disconnect type. 215 // 5) Update android.telecom.DisconnectCauseUtil with any mappings to a telecom.DisconnectCause. 216 // 217 // NextId: 53 218 //********************************************************************************************* 219 220 /** Smallest valid value for call disconnect codes. */ 221 public static final int MINIMUM_VALID_VALUE = NOT_DISCONNECTED; 222 223 /** Largest valid value for call disconnect codes. */ 224 public static final int MAXIMUM_VALID_VALUE = ANSWERED_ELSEWHERE; 225 226 /** Private constructor to avoid class instantiation. */ 227 private DisconnectCause() { 228 // Do nothing. 229 } 230 231 /** Returns descriptive string for the specified disconnect cause. */ 232 public static String toString(int cause) { 233 switch (cause) { 234 case NOT_DISCONNECTED: 235 return "NOT_DISCONNECTED"; 236 case INCOMING_MISSED: 237 return "INCOMING_MISSED"; 238 case NORMAL: 239 return "NORMAL"; 240 case LOCAL: 241 return "LOCAL"; 242 case BUSY: 243 return "BUSY"; 244 case CONGESTION: 245 return "CONGESTION"; 246 case INVALID_NUMBER: 247 return "INVALID_NUMBER"; 248 case NUMBER_UNREACHABLE: 249 return "NUMBER_UNREACHABLE"; 250 case SERVER_UNREACHABLE: 251 return "SERVER_UNREACHABLE"; 252 case INVALID_CREDENTIALS: 253 return "INVALID_CREDENTIALS"; 254 case OUT_OF_NETWORK: 255 return "OUT_OF_NETWORK"; 256 case SERVER_ERROR: 257 return "SERVER_ERROR"; 258 case TIMED_OUT: 259 return "TIMED_OUT"; 260 case LOST_SIGNAL: 261 return "LOST_SIGNAL"; 262 case LIMIT_EXCEEDED: 263 return "LIMIT_EXCEEDED"; 264 case INCOMING_REJECTED: 265 return "INCOMING_REJECTED"; 266 case POWER_OFF: 267 return "POWER_OFF"; 268 case OUT_OF_SERVICE: 269 return "OUT_OF_SERVICE"; 270 case ICC_ERROR: 271 return "ICC_ERROR"; 272 case CALL_BARRED: 273 return "CALL_BARRED"; 274 case FDN_BLOCKED: 275 return "FDN_BLOCKED"; 276 case CS_RESTRICTED: 277 return "CS_RESTRICTED"; 278 case CS_RESTRICTED_NORMAL: 279 return "CS_RESTRICTED_NORMAL"; 280 case CS_RESTRICTED_EMERGENCY: 281 return "CS_RESTRICTED_EMERGENCY"; 282 case UNOBTAINABLE_NUMBER: 283 return "UNOBTAINABLE_NUMBER"; 284 case CDMA_LOCKED_UNTIL_POWER_CYCLE: 285 return "CDMA_LOCKED_UNTIL_POWER_CYCLE"; 286 case CDMA_DROP: 287 return "CDMA_DROP"; 288 case CDMA_INTERCEPT: 289 return "CDMA_INTERCEPT"; 290 case CDMA_REORDER: 291 return "CDMA_REORDER"; 292 case CDMA_SO_REJECT: 293 return "CDMA_SO_REJECT"; 294 case CDMA_RETRY_ORDER: 295 return "CDMA_RETRY_ORDER"; 296 case CDMA_ACCESS_FAILURE: 297 return "CDMA_ACCESS_FAILURE"; 298 case CDMA_PREEMPTED: 299 return "CDMA_PREEMPTED"; 300 case CDMA_NOT_EMERGENCY: 301 return "CDMA_NOT_EMERGENCY"; 302 case CDMA_ACCESS_BLOCKED: 303 return "CDMA_ACCESS_BLOCKED"; 304 case EMERGENCY_ONLY: 305 return "EMERGENCY_ONLY"; 306 case NO_PHONE_NUMBER_SUPPLIED: 307 return "NO_PHONE_NUMBER_SUPPLIED"; 308 case DIALED_MMI: 309 return "DIALED_MMI"; 310 case VOICEMAIL_NUMBER_MISSING: 311 return "VOICEMAIL_NUMBER_MISSING"; 312 case CDMA_CALL_LOST: 313 return "CDMA_CALL_LOST"; 314 case EXITED_ECM: 315 return "EXITED_ECM"; 316 case DIAL_MODIFIED_TO_USSD: 317 return "DIAL_MODIFIED_TO_USSD"; 318 case DIAL_MODIFIED_TO_SS: 319 return "DIAL_MODIFIED_TO_SS"; 320 case DIAL_MODIFIED_TO_DIAL: 321 return "DIAL_MODIFIED_TO_DIAL"; 322 case ERROR_UNSPECIFIED: 323 return "ERROR_UNSPECIFIED"; 324 case OUTGOING_FAILURE: 325 return "OUTGOING_FAILURE"; 326 case OUTGOING_CANCELED: 327 return "OUTGOING_CANCELED"; 328 case IMS_MERGED_SUCCESSFULLY: 329 return "IMS_MERGED_SUCCESSFULLY"; 330 case CDMA_ALREADY_ACTIVATED: 331 return "CDMA_ALREADY_ACTIVATED"; 332 case VIDEO_CALL_NOT_ALLOWED_WHILE_TTY_ENABLED: 333 return "VIDEO_CALL_NOT_ALLOWED_WHILE_TTY_ENABLED"; 334 case CALL_PULLED: 335 return "CALL_PULLED"; 336 case ANSWERED_ELSEWHERE: 337 return "ANSWERED_ELSEWHERE"; 338 default: 339 return "INVALID: " + cause; 340 } 341 } 342} 343