ITelephony.aidl revision 3f5858efa0b4bbed447989dca7d2c06c51dc8d13
1/* 2 * Copyright (C) 2007 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 com.android.internal.telephony; 18 19import android.app.PendingIntent; 20import android.content.Intent; 21import android.os.Bundle; 22import android.os.ResultReceiver; 23import android.net.Uri; 24import android.service.carrier.CarrierIdentifier; 25import android.telecom.PhoneAccount; 26import android.telecom.PhoneAccountHandle; 27import android.telephony.CellInfo; 28import android.telephony.ClientRequestStats; 29import android.telephony.IccOpenLogicalChannelResponse; 30import android.telephony.ModemActivityInfo; 31import android.telephony.NeighboringCellInfo; 32import android.telephony.RadioAccessFamily; 33import android.telephony.ServiceState; 34import android.telephony.TelephonyHistogram; 35import android.telephony.VisualVoicemailSmsFilterSettings; 36import com.android.ims.internal.IImsServiceController; 37import com.android.ims.internal.IImsServiceFeatureListener; 38import com.android.internal.telephony.CellNetworkScanResult; 39import com.android.internal.telephony.OperatorInfo; 40 41import java.util.List; 42 43 44/** 45 * Interface used to interact with the phone. Mostly this is used by the 46 * TelephonyManager class. A few places are still using this directly. 47 * Please clean them up if possible and use TelephonyManager instead. 48 * 49 * {@hide} 50 */ 51interface ITelephony { 52 53 /** 54 * Dial a number. This doesn't place the call. It displays 55 * the Dialer screen. 56 * @param number the number to be dialed. If null, this 57 * would display the Dialer screen with no number pre-filled. 58 */ 59 void dial(String number); 60 61 /** 62 * Place a call to the specified number. 63 * @param callingPackage The package making the call. 64 * @param number the number to be called. 65 */ 66 void call(String callingPackage, String number); 67 68 /** 69 * End call if there is a call in progress, otherwise does nothing. 70 * 71 * @return whether it hung up 72 */ 73 boolean endCall(); 74 75 /** 76 * End call on particular subId or go to the Home screen 77 * @param subId user preferred subId. 78 * @return whether it hung up 79 */ 80 boolean endCallForSubscriber(int subId); 81 82 /** 83 * Answer the currently-ringing call. 84 * 85 * If there's already a current active call, that call will be 86 * automatically put on hold. If both lines are currently in use, the 87 * current active call will be ended. 88 * 89 * TODO: provide a flag to let the caller specify what policy to use 90 * if both lines are in use. (The current behavior is hardwired to 91 * "answer incoming, end ongoing", which is how the CALL button 92 * is specced to behave.) 93 * 94 * TODO: this should be a oneway call (especially since it's called 95 * directly from the key queue thread). 96 */ 97 void answerRingingCall(); 98 99 /** 100 * Answer the currently-ringing call on particular subId . 101 * 102 * If there's already a current active call, that call will be 103 * automatically put on hold. If both lines are currently in use, the 104 * current active call will be ended. 105 * 106 * TODO: provide a flag to let the caller specify what policy to use 107 * if both lines are in use. (The current behavior is hardwired to 108 * "answer incoming, end ongoing", which is how the CALL button 109 * is specced to behave.) 110 * 111 * TODO: this should be a oneway call (especially since it's called 112 * directly from the key queue thread). 113 */ 114 void answerRingingCallForSubscriber(int subId); 115 116 /** 117 * Silence the ringer if an incoming call is currently ringing. 118 * (If vibrating, stop the vibrator also.) 119 * 120 * It's safe to call this if the ringer has already been silenced, or 121 * even if there's no incoming call. (If so, this method will do nothing.) 122 * 123 * TODO: this should be a oneway call too (see above). 124 * (Actually *all* the methods here that return void can 125 * probably be oneway.) 126 */ 127 void silenceRinger(); 128 129 /** 130 * Check if we are in either an active or holding call 131 * @param callingPackage the name of the package making the call. 132 * @return true if the phone state is OFFHOOK. 133 */ 134 boolean isOffhook(String callingPackage); 135 136 /** 137 * Check if a particular subId has an active or holding call 138 * 139 * @param subId user preferred subId. 140 * @param callingPackage the name of the package making the call. 141 * @return true if the phone state is OFFHOOK. 142 */ 143 boolean isOffhookForSubscriber(int subId, String callingPackage); 144 145 /** 146 * Check if an incoming phone call is ringing or call waiting 147 * on a particular subId. 148 * 149 * @param subId user preferred subId. 150 * @param callingPackage the name of the package making the call. 151 * @return true if the phone state is RINGING. 152 */ 153 boolean isRingingForSubscriber(int subId, String callingPackage); 154 155 /** 156 * Check if an incoming phone call is ringing or call waiting. 157 * @param callingPackage the name of the package making the call. 158 * @return true if the phone state is RINGING. 159 */ 160 boolean isRinging(String callingPackage); 161 162 /** 163 * Check if the phone is idle. 164 * @param callingPackage the name of the package making the call. 165 * @return true if the phone state is IDLE. 166 */ 167 boolean isIdle(String callingPackage); 168 169 /** 170 * Check if the phone is idle on a particular subId. 171 * 172 * @param subId user preferred subId. 173 * @param callingPackage the name of the package making the call. 174 * @return true if the phone state is IDLE. 175 */ 176 boolean isIdleForSubscriber(int subId, String callingPackage); 177 178 /** 179 * Check to see if the radio is on or not. 180 * @param callingPackage the name of the package making the call. 181 * @return returns true if the radio is on. 182 */ 183 boolean isRadioOn(String callingPackage); 184 185 /** 186 * Check to see if the radio is on or not on particular subId. 187 * @param subId user preferred subId. 188 * @param callingPackage the name of the package making the call. 189 * @return returns true if the radio is on. 190 */ 191 boolean isRadioOnForSubscriber(int subId, String callingPackage); 192 193 /** 194 * Supply a pin to unlock the SIM. Blocks until a result is determined. 195 * @param pin The pin to check. 196 * @return whether the operation was a success. 197 */ 198 boolean supplyPin(String pin); 199 200 /** 201 * Supply a pin to unlock the SIM for particular subId. 202 * Blocks until a result is determined. 203 * @param pin The pin to check. 204 * @param subId user preferred subId. 205 * @return whether the operation was a success. 206 */ 207 boolean supplyPinForSubscriber(int subId, String pin); 208 209 /** 210 * Supply puk to unlock the SIM and set SIM pin to new pin. 211 * Blocks until a result is determined. 212 * @param puk The puk to check. 213 * pin The new pin to be set in SIM 214 * @return whether the operation was a success. 215 */ 216 boolean supplyPuk(String puk, String pin); 217 218 /** 219 * Supply puk to unlock the SIM and set SIM pin to new pin. 220 * Blocks until a result is determined. 221 * @param puk The puk to check. 222 * pin The new pin to be set in SIM 223 * @param subId user preferred subId. 224 * @return whether the operation was a success. 225 */ 226 boolean supplyPukForSubscriber(int subId, String puk, String pin); 227 228 /** 229 * Supply a pin to unlock the SIM. Blocks until a result is determined. 230 * Returns a specific success/error code. 231 * @param pin The pin to check. 232 * @return retValue[0] = Phone.PIN_RESULT_SUCCESS on success. Otherwise error code 233 * retValue[1] = number of attempts remaining if known otherwise -1 234 */ 235 int[] supplyPinReportResult(String pin); 236 237 /** 238 * Supply a pin to unlock the SIM. Blocks until a result is determined. 239 * Returns a specific success/error code. 240 * @param pin The pin to check. 241 * @return retValue[0] = Phone.PIN_RESULT_SUCCESS on success. Otherwise error code 242 * retValue[1] = number of attempts remaining if known otherwise -1 243 */ 244 int[] supplyPinReportResultForSubscriber(int subId, String pin); 245 246 /** 247 * Supply puk to unlock the SIM and set SIM pin to new pin. 248 * Blocks until a result is determined. 249 * Returns a specific success/error code 250 * @param puk The puk to check 251 * pin The pin to check. 252 * @return retValue[0] = Phone.PIN_RESULT_SUCCESS on success. Otherwise error code 253 * retValue[1] = number of attempts remaining if known otherwise -1 254 */ 255 int[] supplyPukReportResult(String puk, String pin); 256 257 /** 258 * Supply puk to unlock the SIM and set SIM pin to new pin. 259 * Blocks until a result is determined. 260 * Returns a specific success/error code 261 * @param puk The puk to check 262 * pin The pin to check. 263 * @return retValue[0] = Phone.PIN_RESULT_SUCCESS on success. Otherwise error code 264 * retValue[1] = number of attempts remaining if known otherwise -1 265 */ 266 int[] supplyPukReportResultForSubscriber(int subId, String puk, String pin); 267 268 /** 269 * Handles PIN MMI commands (PIN/PIN2/PUK/PUK2), which are initiated 270 * without SEND (so <code>dial</code> is not appropriate). 271 * 272 * @param dialString the MMI command to be executed. 273 * @return true if MMI command is executed. 274 */ 275 boolean handlePinMmi(String dialString); 276 277 278 /** 279 * Handles USSD commands. 280 * 281 * @param subId The subscription to use. 282 * @param ussdRequest the USSD command to be executed. 283 * @param wrappedCallback receives a callback result. 284 */ 285 void handleUssdRequest(int subId, String ussdRequest, in ResultReceiver wrappedCallback); 286 287 /** 288 * Handles PIN MMI commands (PIN/PIN2/PUK/PUK2), which are initiated 289 * without SEND (so <code>dial</code> is not appropriate) for 290 * a particular subId. 291 * @param dialString the MMI command to be executed. 292 * @param subId user preferred subId. 293 * @return true if MMI command is executed. 294 */ 295 boolean handlePinMmiForSubscriber(int subId, String dialString); 296 297 /** 298 * Toggles the radio on or off. 299 */ 300 void toggleRadioOnOff(); 301 302 /** 303 * Toggles the radio on or off on particular subId. 304 * @param subId user preferred subId. 305 */ 306 void toggleRadioOnOffForSubscriber(int subId); 307 308 /** 309 * Set the radio to on or off 310 */ 311 boolean setRadio(boolean turnOn); 312 313 /** 314 * Set the radio to on or off on particular subId. 315 * @param subId user preferred subId. 316 */ 317 boolean setRadioForSubscriber(int subId, boolean turnOn); 318 319 /** 320 * Set the radio to on or off unconditionally 321 */ 322 boolean setRadioPower(boolean turnOn); 323 324 /** 325 * Request to update location information in service state 326 */ 327 void updateServiceLocation(); 328 329 /** 330 * Request to update location information for a subscrition in service state 331 * @param subId user preferred subId. 332 */ 333 void updateServiceLocationForSubscriber(int subId); 334 335 /** 336 * Enable location update notifications. 337 */ 338 void enableLocationUpdates(); 339 340 /** 341 * Enable location update notifications. 342 * @param subId user preferred subId. 343 */ 344 void enableLocationUpdatesForSubscriber(int subId); 345 346 /** 347 * Disable location update notifications. 348 */ 349 void disableLocationUpdates(); 350 351 /** 352 * Disable location update notifications. 353 * @param subId user preferred subId. 354 */ 355 void disableLocationUpdatesForSubscriber(int subId); 356 357 /** 358 * Allow mobile data connections. 359 */ 360 boolean enableDataConnectivity(); 361 362 /** 363 * Disallow mobile data connections. 364 */ 365 boolean disableDataConnectivity(); 366 367 /** 368 * Report whether data connectivity is possible. 369 */ 370 boolean isDataConnectivityPossible(); 371 372 Bundle getCellLocation(String callingPkg); 373 374 /** 375 * Returns the neighboring cell information of the device. 376 */ 377 List<NeighboringCellInfo> getNeighboringCellInfo(String callingPkg); 378 379 int getCallState(); 380 381 /** 382 * Returns the call state for a slot. 383 */ 384 int getCallStateForSlot(int slotId); 385 386 int getDataActivity(); 387 int getDataState(); 388 389 /** 390 * Returns the current active phone type as integer. 391 * Returns TelephonyManager.PHONE_TYPE_CDMA if RILConstants.CDMA_PHONE 392 * and TelephonyManager.PHONE_TYPE_GSM if RILConstants.GSM_PHONE 393 */ 394 int getActivePhoneType(); 395 396 /** 397 * Returns the current active phone type as integer for particular slot. 398 * Returns TelephonyManager.PHONE_TYPE_CDMA if RILConstants.CDMA_PHONE 399 * and TelephonyManager.PHONE_TYPE_GSM if RILConstants.GSM_PHONE 400 * @param slotId - slot to query. 401 */ 402 int getActivePhoneTypeForSlot(int slotId); 403 404 /** 405 * Returns the CDMA ERI icon index to display 406 * @param callingPackage package making the call. 407 */ 408 int getCdmaEriIconIndex(String callingPackage); 409 410 /** 411 * Returns the CDMA ERI icon index to display on particular subId. 412 * @param subId user preferred subId. 413 * @param callingPackage package making the call. 414 */ 415 int getCdmaEriIconIndexForSubscriber(int subId, String callingPackage); 416 417 /** 418 * Returns the CDMA ERI icon mode, 419 * 0 - ON 420 * 1 - FLASHING 421 * @param callingPackage package making the call. 422 */ 423 int getCdmaEriIconMode(String callingPackage); 424 425 /** 426 * Returns the CDMA ERI icon mode on particular subId, 427 * 0 - ON 428 * 1 - FLASHING 429 * @param subId user preferred subId. 430 * @param callingPackage package making the call. 431 */ 432 int getCdmaEriIconModeForSubscriber(int subId, String callingPackage); 433 434 /** 435 * Returns the CDMA ERI text, 436 * @param callingPackage package making the call. 437 */ 438 String getCdmaEriText(String callingPackage); 439 440 /** 441 * Returns the CDMA ERI text for particular subId, 442 * @param subId user preferred subId. 443 * @param callingPackage package making the call. 444 */ 445 String getCdmaEriTextForSubscriber(int subId, String callingPackage); 446 447 /** 448 * Returns true if OTA service provisioning needs to run. 449 * Only relevant on some technologies, others will always 450 * return false. 451 */ 452 boolean needsOtaServiceProvisioning(); 453 454 /** 455 * Sets the voicemail number for a particular subscriber. 456 */ 457 boolean setVoiceMailNumber(int subId, String alphaTag, String number); 458 459 /** 460 * Sets the voice activation state for a particular subscriber. 461 */ 462 void setVoiceActivationState(int subId, int activationState); 463 464 /** 465 * Sets the data activation state for a particular subscriber. 466 */ 467 void setDataActivationState(int subId, int activationState); 468 469 /** 470 * Returns the voice activation state for a particular subscriber. 471 * @param subId user preferred sub 472 * @param callingPackage package queries voice activation state 473 */ 474 int getVoiceActivationState(int subId, String callingPackage); 475 476 /** 477 * Returns the data activation state for a particular subscriber. 478 * @param subId user preferred sub 479 * @param callingPackage package queris data activation state 480 */ 481 int getDataActivationState(int subId, String callingPackage); 482 483 /** 484 * Returns the unread count of voicemails 485 */ 486 int getVoiceMessageCount(); 487 488 /** 489 * Returns the unread count of voicemails for a subId. 490 * @param subId user preferred subId. 491 * Returns the unread count of voicemails 492 */ 493 int getVoiceMessageCountForSubscriber(int subId); 494 495 /** 496 * Returns true if current state supports both voice and data 497 * simultaneously. This can change based on location or network condition. 498 */ 499 boolean isConcurrentVoiceAndDataAllowed(int subId); 500 501 oneway void setVisualVoicemailEnabled(String callingPackage, 502 in PhoneAccountHandle accountHandle, boolean enabled); 503 504 boolean isVisualVoicemailEnabled(String callingPackage, 505 in PhoneAccountHandle accountHandle); 506 507 String getVisualVoicemailPackageName(String callingPackage, int subId); 508 509 // Not oneway, caller needs to make sure the vaule is set before receiving a SMS 510 void enableVisualVoicemailSmsFilter(String callingPackage, int subId, 511 in VisualVoicemailSmsFilterSettings settings); 512 513 oneway void disableVisualVoicemailSmsFilter(String callingPackage, int subId); 514 515 // Get settings set by the calling package 516 VisualVoicemailSmsFilterSettings getVisualVoicemailSmsFilterSettings(String callingPackage, 517 int subId); 518 519 /** 520 * Get settings set by the current default dialer, Internal use only. 521 * Requires READ_PRIVILEGED_PHONE_STATE permission. 522 */ 523 VisualVoicemailSmsFilterSettings getActiveVisualVoicemailSmsFilterSettings(int subId); 524 525 /** 526 * Send a visual voicemail SMS. Internal use only. 527 * Requires caller to be the default dialer and have SEND_SMS permission 528 */ 529 oneway void sendVisualVoicemailSmsForSubscriber(in String callingPackage, in int subId, 530 in String number, in int port, in String text, in PendingIntent sentIntent); 531 532 // Send the special dialer code. The IPC caller must be the current default dialer. 533 boolean sendDialerCode(String callingPackageName, String inputCode); 534 535 /** 536 * Returns the network type for data transmission 537 * Legacy call, permission-free 538 */ 539 int getNetworkType(); 540 541 /** 542 * Returns the network type of a subId. 543 * @param subId user preferred subId. 544 * @param callingPackage package making the call. 545 */ 546 int getNetworkTypeForSubscriber(int subId, String callingPackage); 547 548 /** 549 * Returns the network type for data transmission 550 * @param callingPackage package making the call. 551 */ 552 int getDataNetworkType(String callingPackage); 553 554 /** 555 * Returns the data network type of a subId 556 * @param subId user preferred subId. 557 * @param callingPackage package making the call. 558 */ 559 int getDataNetworkTypeForSubscriber(int subId, String callingPackage); 560 561 /** 562 * Returns the voice network type of a subId 563 * @param subId user preferred subId. 564 * @param callingPackage package making the call. 565 * Returns the network type 566 */ 567 int getVoiceNetworkTypeForSubscriber(int subId, String callingPackage); 568 569 /** 570 * Return true if an ICC card is present 571 */ 572 boolean hasIccCard(); 573 574 /** 575 * Return true if an ICC card is present for a subId. 576 * @param slotId user preferred slotId. 577 * Return true if an ICC card is present 578 */ 579 boolean hasIccCardUsingSlotId(int slotId); 580 581 /** 582 * Return if the current radio is LTE on CDMA. This 583 * is a tri-state return value as for a period of time 584 * the mode may be unknown. 585 * 586 * @param callingPackage the name of the calling package 587 * @return {@link Phone#LTE_ON_CDMA_UNKNOWN}, {@link Phone#LTE_ON_CDMA_FALSE} 588 * or {@link PHone#LTE_ON_CDMA_TRUE} 589 */ 590 int getLteOnCdmaMode(String callingPackage); 591 592 /** 593 * Return if the current radio is LTE on CDMA. This 594 * is a tri-state return value as for a period of time 595 * the mode may be unknown. 596 * 597 * @param callingPackage the name of the calling package 598 * @return {@link Phone#LTE_ON_CDMA_UNKNOWN}, {@link Phone#LTE_ON_CDMA_FALSE} 599 * or {@link PHone#LTE_ON_CDMA_TRUE} 600 */ 601 int getLteOnCdmaModeForSubscriber(int subId, String callingPackage); 602 603 /** 604 * Returns the all observed cell information of the device. 605 */ 606 List<CellInfo> getAllCellInfo(String callingPkg); 607 608 /** 609 * Sets minimum time in milli-seconds between onCellInfoChanged 610 */ 611 void setCellInfoListRate(int rateInMillis); 612 613 /** 614 * get default sim 615 * @return sim id 616 */ 617 int getDefaultSim(); 618 619 /** 620 * Opens a logical channel to the ICC card. 621 * 622 * Input parameters equivalent to TS 27.007 AT+CCHO command. 623 * 624 * @param subId The subscription to use. 625 * @param AID Application id. See ETSI 102.221 and 101.220. 626 * @return an IccOpenLogicalChannelResponse object. 627 */ 628 IccOpenLogicalChannelResponse iccOpenLogicalChannel(int subId, String AID); 629 630 /** 631 * Closes a previously opened logical channel to the ICC card. 632 * 633 * Input parameters equivalent to TS 27.007 AT+CCHC command. 634 * 635 * @param subId The subscription to use. 636 * @param channel is the channel id to be closed as retruned by a 637 * successful iccOpenLogicalChannel. 638 * @return true if the channel was closed successfully. 639 */ 640 boolean iccCloseLogicalChannel(int subId, int channel); 641 642 /** 643 * Transmit an APDU to the ICC card over a logical channel. 644 * 645 * Input parameters equivalent to TS 27.007 AT+CGLA command. 646 * 647 * @param subId The subscription to use. 648 * @param channel is the channel id to be closed as retruned by a 649 * successful iccOpenLogicalChannel. 650 * @param cla Class of the APDU command. 651 * @param instruction Instruction of the APDU command. 652 * @param p1 P1 value of the APDU command. 653 * @param p2 P2 value of the APDU command. 654 * @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU 655 * is sent to the SIM. 656 * @param data Data to be sent with the APDU. 657 * @return The APDU response from the ICC card with the status appended at 658 * the end. 659 */ 660 String iccTransmitApduLogicalChannel(int subId, int channel, int cla, int instruction, 661 int p1, int p2, int p3, String data); 662 663 /** 664 * Transmit an APDU to the ICC card over the basic channel. 665 * 666 * Input parameters equivalent to TS 27.007 AT+CSIM command. 667 * 668 * @param subId The subscription to use. 669 * @param cla Class of the APDU command. 670 * @param instruction Instruction of the APDU command. 671 * @param p1 P1 value of the APDU command. 672 * @param p2 P2 value of the APDU command. 673 * @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU 674 * is sent to the SIM. 675 * @param data Data to be sent with the APDU. 676 * @return The APDU response from the ICC card with the status appended at 677 * the end. 678 */ 679 String iccTransmitApduBasicChannel(int subId, int cla, int instruction, 680 int p1, int p2, int p3, String data); 681 682 /** 683 * Returns the response APDU for a command APDU sent through SIM_IO. 684 * 685 * @param subId The subscription to use. 686 * @param fileID 687 * @param command 688 * @param p1 P1 value of the APDU command. 689 * @param p2 P2 value of the APDU command. 690 * @param p3 P3 value of the APDU command. 691 * @param filePath 692 * @return The APDU response. 693 */ 694 byte[] iccExchangeSimIO(int subId, int fileID, int command, int p1, int p2, int p3, 695 String filePath); 696 697 /** 698 * Send ENVELOPE to the SIM and returns the response. 699 * 700 * @param subId The subscription to use. 701 * @param contents String containing SAT/USAT response in hexadecimal 702 * format starting with command tag. See TS 102 223 for 703 * details. 704 * @return The APDU response from the ICC card, with the last 4 bytes 705 * being the status word. If the command fails, returns an empty 706 * string. 707 */ 708 String sendEnvelopeWithStatus(int subId, String content); 709 710 /** 711 * Read one of the NV items defined in {@link RadioNVItems} / {@code ril_nv_items.h}. 712 * Used for device configuration by some CDMA operators. 713 * 714 * @param itemID the ID of the item to read. 715 * @return the NV item as a String, or null on any failure. 716 */ 717 String nvReadItem(int itemID); 718 719 /** 720 * Write one of the NV items defined in {@link RadioNVItems} / {@code ril_nv_items.h}. 721 * Used for device configuration by some CDMA operators. 722 * 723 * @param itemID the ID of the item to read. 724 * @param itemValue the value to write, as a String. 725 * @return true on success; false on any failure. 726 */ 727 boolean nvWriteItem(int itemID, String itemValue); 728 729 /** 730 * Update the CDMA Preferred Roaming List (PRL) in the radio NV storage. 731 * Used for device configuration by some CDMA operators. 732 * 733 * @param preferredRoamingList byte array containing the new PRL. 734 * @return true on success; false on any failure. 735 */ 736 boolean nvWriteCdmaPrl(in byte[] preferredRoamingList); 737 738 /** 739 * Perform the specified type of NV config reset. The radio will be taken offline 740 * and the device must be rebooted after the operation. Used for device 741 * configuration by some CDMA operators. 742 * 743 * @param resetType the type of reset to perform (1 == factory reset; 2 == NV-only reset). 744 * @return true on success; false on any failure. 745 */ 746 boolean nvResetConfig(int resetType); 747 748 /* 749 * Get the calculated preferred network type. 750 * Used for device configuration by some CDMA operators. 751 * @param callingPackage The package making the call. 752 * 753 * @return the calculated preferred network type, defined in RILConstants.java. 754 */ 755 int getCalculatedPreferredNetworkType(String callingPackage); 756 757 /* 758 * Get the preferred network type. 759 * Used for device configuration by some CDMA operators. 760 * 761 * @param subId the id of the subscription to query. 762 * @return the preferred network type, defined in RILConstants.java. 763 */ 764 int getPreferredNetworkType(int subId); 765 766 /** 767 * Check TETHER_DUN_REQUIRED and TETHER_DUN_APN settings, net.tethering.noprovisioning 768 * SystemProperty, and config_tether_apndata to decide whether DUN APN is required for 769 * tethering. 770 * 771 * @return 0: Not required. 1: required. 2: Not set. 772 */ 773 int getTetherApnRequired(); 774 775 /** 776 * Get ImsServiceController binder from ImsResolver that corresponds to the subId and feature 777 * requested as well as registering the ImsServiceController for callbacks using the 778 * IImsServiceFeatureListener interface. 779 */ 780 IImsServiceController getImsServiceControllerAndListen(int slotId, int feature, 781 IImsServiceFeatureListener callback); 782 783 /** 784 * Set the network selection mode to automatic. 785 * 786 * @param subId the id of the subscription to update. 787 */ 788 void setNetworkSelectionModeAutomatic(int subId); 789 790 /** 791 * Perform a radio scan and return the list of avialble networks. 792 * 793 * @param subId the id of the subscription. 794 * @return CellNetworkScanResult containing status of scan and networks. 795 */ 796 CellNetworkScanResult getCellNetworkScanResults(int subId); 797 798 /** 799 * Ask the radio to connect to the input network and change selection mode to manual. 800 * 801 * @param subId the id of the subscription. 802 * @param operatorInfo the operator to attach to. 803 * @param persistSelection should the selection persist till reboot or its 804 * turned off? Will also result in notification being not shown to 805 * the user if the signal is lost. 806 * @return true if the request suceeded. 807 */ 808 boolean setNetworkSelectionModeManual(int subId, in OperatorInfo operator, 809 boolean persistSelection); 810 811 /** 812 * Set the preferred network type. 813 * Used for device configuration by some CDMA operators. 814 * 815 * @param subId the id of the subscription to update. 816 * @param networkType the preferred network type, defined in RILConstants.java. 817 * @return true on success; false on any failure. 818 */ 819 boolean setPreferredNetworkType(int subId, int networkType); 820 821 /** 822 * User enable/disable Mobile Data. 823 * 824 * @param enable true to turn on, else false 825 */ 826 void setDataEnabled(int subId, boolean enable); 827 828 /** 829 * Get the user enabled state of Mobile Data. 830 * 831 * @return true on enabled 832 */ 833 boolean getDataEnabled(int subId); 834 835 /** 836 * Get P-CSCF address from PCO after data connection is established or modified. 837 * @param apnType the apnType, "ims" for IMS APN, "emergency" for EMERGENCY APN 838 * @param callingPackage The package making the call. 839 */ 840 String[] getPcscfAddress(String apnType, String callingPackage); 841 842 /** 843 * Set IMS registration state 844 */ 845 void setImsRegistrationState(boolean registered); 846 847 /** 848 * Return MDN string for CDMA phone. 849 * @param subId user preferred subId. 850 */ 851 String getCdmaMdn(int subId); 852 853 /** 854 * Return MIN string for CDMA phone. 855 * @param subId user preferred subId. 856 */ 857 String getCdmaMin(int subId); 858 859 /** 860 * Has the calling application been granted special privileges by the carrier. 861 * 862 * If any of the packages in the calling UID has carrier privileges, the 863 * call will return true. This access is granted by the owner of the UICC 864 * card and does not depend on the registered carrier. 865 * 866 * TODO: Add a link to documentation. 867 * 868 * @param subId The subscription to use. 869 * @return carrier privilege status defined in TelephonyManager. 870 */ 871 int getCarrierPrivilegeStatus(int subId); 872 873 /** 874 * Similar to above, but check for the package whose name is pkgName. 875 */ 876 int checkCarrierPrivilegesForPackage(String pkgName); 877 878 /** 879 * Similar to above, but check across all phones. 880 */ 881 int checkCarrierPrivilegesForPackageAnyPhone(String pkgName); 882 883 /** 884 * Returns list of the package names of the carrier apps that should handle the input intent 885 * and have carrier privileges for the given phoneId. 886 * 887 * @param intent Intent that will be sent. 888 * @param phoneId The phoneId on which the carrier app has carrier privileges. 889 * @return list of carrier app package names that can handle the intent on phoneId. 890 * Returns null if there is an error and an empty list if there 891 * are no matching packages. 892 */ 893 List<String> getCarrierPackageNamesForIntentAndPhone(in Intent intent, int phoneId); 894 895 /** 896 * Set the line 1 phone number string and its alphatag for the current ICCID 897 * for display purpose only, for example, displayed in Phone Status. It won't 898 * change the actual MSISDN/MDN. To unset alphatag or number, pass in a null 899 * value. 900 * 901 * @param subId the subscriber that the alphatag and dialing number belongs to. 902 * @param alphaTag alpha-tagging of the dailing nubmer 903 * @param number The dialing number 904 * @return true if the operation was executed correctly. 905 */ 906 boolean setLine1NumberForDisplayForSubscriber(int subId, String alphaTag, String number); 907 908 /** 909 * Returns the displayed dialing number string if it was set previously via 910 * {@link #setLine1NumberForDisplay}. Otherwise returns null. 911 * 912 * @param subId whose dialing number for line 1 is returned. 913 * @param callingPackage The package making the call. 914 * @return the displayed dialing number if set, or null if not set. 915 */ 916 String getLine1NumberForDisplay(int subId, String callingPackage); 917 918 /** 919 * Returns the displayed alphatag of the dialing number if it was set 920 * previously via {@link #setLine1NumberForDisplay}. Otherwise returns null. 921 * 922 * @param subId whose alphatag associated with line 1 is returned. 923 * @param callingPackage The package making the call. 924 * @return the displayed alphatag of the dialing number if set, or null if 925 * not set. 926 */ 927 String getLine1AlphaTagForDisplay(int subId, String callingPackage); 928 929 String[] getMergedSubscriberIds(String callingPackage); 930 931 /** 932 * Override the operator branding for the current ICCID. 933 * 934 * Once set, whenever the SIM is present in the device, the service 935 * provider name (SPN) and the operator name will both be replaced by the 936 * brand value input. To unset the value, the same function should be 937 * called with a null brand value. 938 * 939 * <p>Requires Permission: 940 * {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} 941 * or has to be carrier app - see #hasCarrierPrivileges. 942 * 943 * @param subId The subscription to use. 944 * @param brand The brand name to display/set. 945 * @return true if the operation was executed correctly. 946 */ 947 boolean setOperatorBrandOverride(int subId, String brand); 948 949 /** 950 * Override the roaming indicator for the current ICCID. 951 * 952 * Using this call, the carrier app (see #hasCarrierPrivileges) can override 953 * the platform's notion of a network operator being considered roaming or not. 954 * The change only affects the ICCID that was active when this call was made. 955 * 956 * If null is passed as any of the input, the corresponding value is deleted. 957 * 958 * <p>Requires that the caller have carrier privilege. See #hasCarrierPrivileges. 959 * 960 * @param subId for which the roaming overrides apply. 961 * @param gsmRoamingList - List of MCCMNCs to be considered roaming for 3GPP RATs. 962 * @param gsmNonRoamingList - List of MCCMNCs to be considered not roaming for 3GPP RATs. 963 * @param cdmaRoamingList - List of SIDs to be considered roaming for 3GPP2 RATs. 964 * @param cdmaNonRoamingList - List of SIDs to be considered not roaming for 3GPP2 RATs. 965 * @return true if the operation was executed correctly. 966 */ 967 boolean setRoamingOverride(int subId, in List<String> gsmRoamingList, 968 in List<String> gsmNonRoamingList, in List<String> cdmaRoamingList, 969 in List<String> cdmaNonRoamingList); 970 971 /** 972 * Returns the result and response from RIL for oem request 973 * 974 * @param oemReq the data is sent to ril. 975 * @param oemResp the respose data from RIL. 976 * @return negative value request was not handled or get error 977 * 0 request was handled succesfully, but no response data 978 * positive value success, data length of response 979 */ 980 int invokeOemRilRequestRaw(in byte[] oemReq, out byte[] oemResp); 981 982 /** 983 * Check if any mobile Radios need to be shutdown. 984 * 985 * @return true is any mobile radio needs to be shutdown 986 */ 987 boolean needMobileRadioShutdown(); 988 989 /** 990 * Shutdown Mobile Radios 991 */ 992 void shutdownMobileRadios(); 993 994 /** 995 * Set phone radio type and access technology. 996 * 997 * @param rafs an RadioAccessFamily array to indicate all phone's 998 * new radio access family. The length of RadioAccessFamily 999 * must equ]]al to phone count. 1000 */ 1001 void setRadioCapability(in RadioAccessFamily[] rafs); 1002 1003 /** 1004 * Get phone radio type and access technology. 1005 * 1006 * @param phoneId which phone you want to get 1007 * @param callingPackage the name of the package making the call 1008 * @return phone radio type and access technology 1009 */ 1010 int getRadioAccessFamily(in int phoneId, String callingPackage); 1011 1012 /** 1013 * Enables or disables video calling. 1014 * 1015 * @param enable Whether to enable video calling. 1016 */ 1017 void enableVideoCalling(boolean enable); 1018 1019 /** 1020 * Whether video calling has been enabled by the user. 1021 * 1022 * @param callingPackage The package making the call. 1023 * @return {@code true} if the user has enabled video calling, {@code false} otherwise. 1024 */ 1025 boolean isVideoCallingEnabled(String callingPackage); 1026 1027 /** 1028 * Whether the DTMF tone length can be changed. 1029 * 1030 * @return {@code true} if the DTMF tone length can be changed. 1031 */ 1032 boolean canChangeDtmfToneLength(); 1033 1034 /** 1035 * Whether the device is a world phone. 1036 * 1037 * @return {@code true} if the devices is a world phone. 1038 */ 1039 boolean isWorldPhone(); 1040 1041 /** 1042 * Whether the phone supports TTY mode. 1043 * 1044 * @return {@code true} if the device supports TTY mode. 1045 */ 1046 boolean isTtyModeSupported(); 1047 1048 /** 1049 * Whether the phone supports hearing aid compatibility. 1050 * 1051 * @return {@code true} if the device supports hearing aid compatibility. 1052 */ 1053 boolean isHearingAidCompatibilitySupported(); 1054 1055 /** 1056 * Get IMS Registration Status 1057 */ 1058 boolean isImsRegistered(); 1059 1060 /** 1061 * Returns the Status of Wi-Fi Calling 1062 */ 1063 boolean isWifiCallingAvailable(); 1064 1065 /** 1066 * Returns the Status of Volte 1067 */ 1068 boolean isVolteAvailable(); 1069 1070 /** 1071 * Returns the Status of VT (video telephony) 1072 */ 1073 boolean isVideoTelephonyAvailable(); 1074 1075 /** 1076 * Returns the unique device ID of phone, for example, the IMEI for 1077 * GSM and the MEID for CDMA phones. Return null if device ID is not available. 1078 * 1079 * @param callingPackage The package making the call. 1080 * <p>Requires Permission: 1081 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1082 */ 1083 String getDeviceId(String callingPackage); 1084 1085 /** 1086 * Returns the IMEI for the given slot. 1087 * 1088 * @param slotId - device slot. 1089 * @param callingPackage The package making the call. 1090 * <p>Requires Permission: 1091 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1092 */ 1093 String getImeiForSlot(int slotId, String callingPackage); 1094 1095 /** 1096 * Returns the device software version. 1097 * 1098 * @param slotId - device slot. 1099 * @param callingPackage The package making the call. 1100 * <p>Requires Permission: 1101 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1102 */ 1103 String getDeviceSoftwareVersionForSlot(int slotId, String callingPackage); 1104 1105 /** 1106 * Returns the subscription ID associated with the specified PhoneAccount. 1107 */ 1108 int getSubIdForPhoneAccount(in PhoneAccount phoneAccount); 1109 1110 void factoryReset(int subId); 1111 1112 /** 1113 * An estimate of the users's current locale based on the default SIM. 1114 * 1115 * The returned string will be a well formed BCP-47 language tag, or {@code null} 1116 * if no locale could be derived. 1117 */ 1118 String getLocaleFromDefaultSim(); 1119 1120 /** 1121 * Requests the modem activity info asynchronously. 1122 * The implementor is expected to reply with the 1123 * {@link android.telephony.ModemActivityInfo} object placed into the Bundle with the key 1124 * {@link android.telephony.TelephonyManager#MODEM_ACTIVITY_RESULT_KEY}. 1125 * The result code is ignored. 1126 */ 1127 oneway void requestModemActivityInfo(in ResultReceiver result); 1128 1129 /** 1130 * Get the service state on specified subscription 1131 * @param subId Subscription id 1132 * @param callingPackage The package making the call 1133 * @return Service state on specified subscription. 1134 */ 1135 ServiceState getServiceStateForSubscriber(int subId, String callingPackage); 1136 1137 /** 1138 * Returns the URI for the per-account voicemail ringtone set in Phone settings. 1139 * 1140 * @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the 1141 * voicemail ringtone. 1142 * @return The URI for the ringtone to play when receiving a voicemail from a specific 1143 * PhoneAccount. 1144 */ 1145 Uri getVoicemailRingtoneUri(in PhoneAccountHandle accountHandle); 1146 1147 /** 1148 * Sets the per-account voicemail ringtone. 1149 * 1150 * <p>Requires that the calling app is the default dialer, or has carrier privileges, or 1151 * has permission {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}. 1152 * 1153 * @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the 1154 * voicemail ringtone. 1155 * @param uri The URI for the ringtone to play when receiving a voicemail from a specific 1156 * PhoneAccount. 1157 */ 1158 void setVoicemailRingtoneUri(String callingPackage, 1159 in PhoneAccountHandle phoneAccountHandle, in Uri uri); 1160 1161 /** 1162 * Returns whether vibration is set for voicemail notification in Phone settings. 1163 * 1164 * @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the 1165 * voicemail vibration setting. 1166 * @return {@code true} if the vibration is set for this PhoneAccount, {@code false} otherwise. 1167 */ 1168 boolean isVoicemailVibrationEnabled(in PhoneAccountHandle accountHandle); 1169 1170 /** 1171 * Sets the per-account preference whether vibration is enabled for voicemail notifications. 1172 * 1173 * <p>Requires that the calling app is the default dialer, or has carrier privileges, or 1174 * has permission {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}. 1175 * 1176 * @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the 1177 * voicemail vibration setting. 1178 * @param enabled Whether to enable or disable vibration for voicemail notifications from a 1179 * specific PhoneAccount. 1180 */ 1181 void setVoicemailVibrationEnabled(String callingPackage, 1182 in PhoneAccountHandle phoneAccountHandle, boolean enabled); 1183 1184 /** 1185 * Returns a list of packages that have carrier privileges. 1186 */ 1187 List<String> getPackagesWithCarrierPrivileges(); 1188 1189 /** 1190 * Return the application ID for the app type. 1191 * 1192 * @param subId the subscription ID that this request applies to. 1193 * @param appType the uicc app type, 1194 * @return Application ID for specificied app type or null if no uicc or error. 1195 */ 1196 String getAidForAppType(int subId, int appType); 1197 1198 /** 1199 * Return the Electronic Serial Number. 1200 * 1201 * Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission 1202 * 1203 * @param subId the subscription ID that this request applies to. 1204 * @return ESN or null if error. 1205 * @hide 1206 */ 1207 String getEsn(int subId); 1208 1209 /** 1210 * Return the Preferred Roaming List Version 1211 * 1212 * Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission 1213 * @param subId the subscription ID that this request applies to. 1214 * @return PRLVersion or null if error. 1215 * @hide 1216 */ 1217 String getCdmaPrlVersion(int subId); 1218 1219 /** 1220 * Get snapshot of Telephony histograms 1221 * @return List of Telephony histograms 1222 * Requires Permission: 1223 * {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} 1224 * Or the calling app has carrier privileges. 1225 */ 1226 List<TelephonyHistogram> getTelephonyHistograms(); 1227 1228 /** 1229 * Set the allowed carrier list for slotId 1230 * Require system privileges. In the future we may add this to carrier APIs. 1231 * 1232 * @return The number of carriers set successfully. Should match length of 1233 * carriers on success. 1234 */ 1235 int setAllowedCarriers(int slotId, in List<CarrierIdentifier> carriers); 1236 1237 /** 1238 * Get the allowed carrier list for slotId. 1239 * Require system privileges. In the future we may add this to carrier APIs. 1240 * 1241 * @return List of {@link android.service.carrier.CarrierIdentifier}; empty list 1242 * means all carriers are allowed. 1243 */ 1244 List<CarrierIdentifier> getAllowedCarriers(int slotId); 1245 1246 /** 1247 * Action set from carrier signalling broadcast receivers to enable/disable metered apns 1248 * Permissions android.Manifest.permission.MODIFY_PHONE_STATE is required 1249 * @param subId the subscription ID that this action applies to. 1250 * @param enabled control enable or disable metered apns. 1251 * @hide 1252 */ 1253 void carrierActionSetMeteredApnsEnabled(int subId, boolean visible); 1254 1255 /** 1256 * Action set from carrier signalling broadcast receivers to enable/disable radio 1257 * Permissions android.Manifest.permission.MODIFY_PHONE_STATE is required 1258 * @param subId the subscription ID that this action applies to. 1259 * @param enabled control enable or disable radio. 1260 * @hide 1261 */ 1262 void carrierActionSetRadioEnabled(int subId, boolean enabled); 1263 1264 /** 1265 * Get aggregated video call data usage since boot. 1266 * Permissions android.Manifest.permission.READ_NETWORK_USAGE_HISTORY is required. 1267 * @return total data usage in bytes 1268 * @hide 1269 */ 1270 long getVtDataUsage(); 1271 1272 /** 1273 * Policy control of data connection. Usually used when data limit is passed. 1274 * @param enabled True if enabling the data, otherwise disabling. 1275 * @param subId Subscription index 1276 * @hide 1277 */ 1278 void setPolicyDataEnabled(boolean enabled, int subId); 1279 1280 /** 1281 * Get Client request stats which will contain statistical information 1282 * on each request made by client. 1283 * @param callingPackage package making the call. 1284 * @param subId Subscription index 1285 * @hide 1286 */ 1287 List<ClientRequestStats> getClientRequestStats(String callingPackage, int subid); 1288 1289 /** 1290 * Set SIM card power state. Request is equivalent to inserting or removing the card. 1291 * @param slotId SIM slot id 1292 * @param powerUp True if powering up the SIM, otherwise powering down 1293 * @hide 1294 * */ 1295 void setSimPowerStateForSlot(int slotId, boolean powerUp); 1296 1297 /** 1298 * Returns a list of Forbidden PLMNs from the specified SIM App 1299 * Returns null if the query fails. 1300 * 1301 * 1302 * <p>Requires that the calling app has READ_PRIVILEGED_PHONE_STATE 1303 * 1304 * @param subId subscription ID used for authentication 1305 * @param appType the icc application type, like {@link #APPTYPE_USIM} 1306 */ 1307 String[] getForbiddenPlmns(int subId, int appType); 1308} 1309