ITelephony.aidl revision 388eab414779124f9b07837a2a9d5e4c6c1c068c
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 slotIndex); 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 slotIndex - slot to query. 401 */ 402 int getActivePhoneTypeForSlot(int slotIndex); 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 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 // Send the special dialer code. The IPC caller must be the current default dialer. 536 void sendDialerSpecialCode(String callingPackageName, String inputCode); 537 538 /** 539 * Returns the network type for data transmission 540 * Legacy call, permission-free 541 */ 542 int getNetworkType(); 543 544 /** 545 * Returns the network type of a subId. 546 * @param subId user preferred subId. 547 * @param callingPackage package making the call. 548 */ 549 int getNetworkTypeForSubscriber(int subId, String callingPackage); 550 551 /** 552 * Returns the network type for data transmission 553 * @param callingPackage package making the call. 554 */ 555 int getDataNetworkType(String callingPackage); 556 557 /** 558 * Returns the data network type of a subId 559 * @param subId user preferred subId. 560 * @param callingPackage package making the call. 561 */ 562 int getDataNetworkTypeForSubscriber(int subId, String callingPackage); 563 564 /** 565 * Returns the voice network type of a subId 566 * @param subId user preferred subId. 567 * @param callingPackage package making the call. 568 * Returns the network type 569 */ 570 int getVoiceNetworkTypeForSubscriber(int subId, String callingPackage); 571 572 /** 573 * Return true if an ICC card is present 574 */ 575 boolean hasIccCard(); 576 577 /** 578 * Return true if an ICC card is present for a subId. 579 * @param slotIndex user preferred slotIndex. 580 * Return true if an ICC card is present 581 */ 582 boolean hasIccCardUsingSlotIndex(int slotIndex); 583 584 /** 585 * Return if the current radio is LTE on CDMA. This 586 * is a tri-state return value as for a period of time 587 * the mode may be unknown. 588 * 589 * @param callingPackage the name of the calling package 590 * @return {@link Phone#LTE_ON_CDMA_UNKNOWN}, {@link Phone#LTE_ON_CDMA_FALSE} 591 * or {@link PHone#LTE_ON_CDMA_TRUE} 592 */ 593 int getLteOnCdmaMode(String callingPackage); 594 595 /** 596 * Return if the current radio is LTE on CDMA. This 597 * is a tri-state return value as for a period of time 598 * the mode may be unknown. 599 * 600 * @param callingPackage the name of the calling package 601 * @return {@link Phone#LTE_ON_CDMA_UNKNOWN}, {@link Phone#LTE_ON_CDMA_FALSE} 602 * or {@link PHone#LTE_ON_CDMA_TRUE} 603 */ 604 int getLteOnCdmaModeForSubscriber(int subId, String callingPackage); 605 606 /** 607 * Returns the all observed cell information of the device. 608 */ 609 List<CellInfo> getAllCellInfo(String callingPkg); 610 611 /** 612 * Sets minimum time in milli-seconds between onCellInfoChanged 613 */ 614 void setCellInfoListRate(int rateInMillis); 615 616 /** 617 * get default sim 618 * @return sim id 619 */ 620 int getDefaultSim(); 621 622 /** 623 * Opens a logical channel to the ICC card. 624 * 625 * Input parameters equivalent to TS 27.007 AT+CCHO command. 626 * 627 * @param subId The subscription to use. 628 * @param AID Application id. See ETSI 102.221 and 101.220. 629 * @return an IccOpenLogicalChannelResponse object. 630 */ 631 IccOpenLogicalChannelResponse iccOpenLogicalChannel(int subId, String AID); 632 633 /** 634 * Closes a previously opened logical channel to the ICC card. 635 * 636 * Input parameters equivalent to TS 27.007 AT+CCHC command. 637 * 638 * @param subId The subscription to use. 639 * @param channel is the channel id to be closed as retruned by a 640 * successful iccOpenLogicalChannel. 641 * @return true if the channel was closed successfully. 642 */ 643 boolean iccCloseLogicalChannel(int subId, int channel); 644 645 /** 646 * Transmit an APDU to the ICC card over a logical channel. 647 * 648 * Input parameters equivalent to TS 27.007 AT+CGLA command. 649 * 650 * @param subId The subscription to use. 651 * @param channel is the channel id to be closed as retruned by a 652 * successful iccOpenLogicalChannel. 653 * @param cla Class of the APDU command. 654 * @param instruction Instruction of the APDU command. 655 * @param p1 P1 value of the APDU command. 656 * @param p2 P2 value of the APDU command. 657 * @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU 658 * is sent to the SIM. 659 * @param data Data to be sent with the APDU. 660 * @return The APDU response from the ICC card with the status appended at 661 * the end. 662 */ 663 String iccTransmitApduLogicalChannel(int subId, int channel, int cla, int instruction, 664 int p1, int p2, int p3, String data); 665 666 /** 667 * Transmit an APDU to the ICC card over the basic channel. 668 * 669 * Input parameters equivalent to TS 27.007 AT+CSIM command. 670 * 671 * @param subId The subscription to use. 672 * @param cla Class of the APDU command. 673 * @param instruction Instruction of the APDU command. 674 * @param p1 P1 value of the APDU command. 675 * @param p2 P2 value of the APDU command. 676 * @param p3 P3 value of the APDU command. If p3 is negative a 4 byte APDU 677 * is sent to the SIM. 678 * @param data Data to be sent with the APDU. 679 * @return The APDU response from the ICC card with the status appended at 680 * the end. 681 */ 682 String iccTransmitApduBasicChannel(int subId, int cla, int instruction, 683 int p1, int p2, int p3, String data); 684 685 /** 686 * Returns the response APDU for a command APDU sent through SIM_IO. 687 * 688 * @param subId The subscription to use. 689 * @param fileID 690 * @param command 691 * @param p1 P1 value of the APDU command. 692 * @param p2 P2 value of the APDU command. 693 * @param p3 P3 value of the APDU command. 694 * @param filePath 695 * @return The APDU response. 696 */ 697 byte[] iccExchangeSimIO(int subId, int fileID, int command, int p1, int p2, int p3, 698 String filePath); 699 700 /** 701 * Send ENVELOPE to the SIM and returns the response. 702 * 703 * @param subId The subscription to use. 704 * @param contents String containing SAT/USAT response in hexadecimal 705 * format starting with command tag. See TS 102 223 for 706 * details. 707 * @return The APDU response from the ICC card, with the last 4 bytes 708 * being the status word. If the command fails, returns an empty 709 * string. 710 */ 711 String sendEnvelopeWithStatus(int subId, String content); 712 713 /** 714 * Read one of the NV items defined in {@link RadioNVItems} / {@code ril_nv_items.h}. 715 * Used for device configuration by some CDMA operators. 716 * 717 * @param itemID the ID of the item to read. 718 * @return the NV item as a String, or null on any failure. 719 */ 720 String nvReadItem(int itemID); 721 722 /** 723 * Write one of the NV items defined in {@link RadioNVItems} / {@code ril_nv_items.h}. 724 * Used for device configuration by some CDMA operators. 725 * 726 * @param itemID the ID of the item to read. 727 * @param itemValue the value to write, as a String. 728 * @return true on success; false on any failure. 729 */ 730 boolean nvWriteItem(int itemID, String itemValue); 731 732 /** 733 * Update the CDMA Preferred Roaming List (PRL) in the radio NV storage. 734 * Used for device configuration by some CDMA operators. 735 * 736 * @param preferredRoamingList byte array containing the new PRL. 737 * @return true on success; false on any failure. 738 */ 739 boolean nvWriteCdmaPrl(in byte[] preferredRoamingList); 740 741 /** 742 * Perform the specified type of NV config reset. The radio will be taken offline 743 * and the device must be rebooted after the operation. Used for device 744 * configuration by some CDMA operators. 745 * 746 * @param resetType the type of reset to perform (1 == factory reset; 2 == NV-only reset). 747 * @return true on success; false on any failure. 748 */ 749 boolean nvResetConfig(int resetType); 750 751 /* 752 * Get the calculated preferred network type. 753 * Used for device configuration by some CDMA operators. 754 * @param callingPackage The package making the call. 755 * 756 * @return the calculated preferred network type, defined in RILConstants.java. 757 */ 758 int getCalculatedPreferredNetworkType(String callingPackage); 759 760 /* 761 * Get the preferred network type. 762 * Used for device configuration by some CDMA operators. 763 * 764 * @param subId the id of the subscription to query. 765 * @return the preferred network type, defined in RILConstants.java. 766 */ 767 int getPreferredNetworkType(int subId); 768 769 /** 770 * Check TETHER_DUN_REQUIRED and TETHER_DUN_APN settings, net.tethering.noprovisioning 771 * SystemProperty, and config_tether_apndata to decide whether DUN APN is required for 772 * tethering. 773 * 774 * @return 0: Not required. 1: required. 2: Not set. 775 */ 776 int getTetherApnRequired(); 777 778 /** 779 * Get ImsServiceController binder from ImsResolver that corresponds to the subId and feature 780 * requested as well as registering the ImsServiceController for callbacks using the 781 * IImsServiceFeatureListener interface. 782 */ 783 IImsServiceController getImsServiceControllerAndListen(int slotIndex, int feature, 784 IImsServiceFeatureListener callback); 785 786 /** 787 * Set the network selection mode to automatic. 788 * 789 * @param subId the id of the subscription to update. 790 */ 791 void setNetworkSelectionModeAutomatic(int subId); 792 793 /** 794 * Perform a radio scan and return the list of avialble networks. 795 * 796 * @param subId the id of the subscription. 797 * @return CellNetworkScanResult containing status of scan and networks. 798 */ 799 CellNetworkScanResult getCellNetworkScanResults(int subId); 800 801 /** 802 * Ask the radio to connect to the input network and change selection mode to manual. 803 * 804 * @param subId the id of the subscription. 805 * @param operatorInfo the operator to attach to. 806 * @param persistSelection should the selection persist till reboot or its 807 * turned off? Will also result in notification being not shown to 808 * the user if the signal is lost. 809 * @return true if the request suceeded. 810 */ 811 boolean setNetworkSelectionModeManual(int subId, in OperatorInfo operator, 812 boolean persistSelection); 813 814 /** 815 * Set the preferred network type. 816 * Used for device configuration by some CDMA operators. 817 * 818 * @param subId the id of the subscription to update. 819 * @param networkType the preferred network type, defined in RILConstants.java. 820 * @return true on success; false on any failure. 821 */ 822 boolean setPreferredNetworkType(int subId, int networkType); 823 824 /** 825 * User enable/disable Mobile Data. 826 * 827 * @param enable true to turn on, else false 828 */ 829 void setDataEnabled(int subId, boolean enable); 830 831 /** 832 * Get the user enabled state of Mobile Data. 833 * 834 * @return true on enabled 835 */ 836 boolean getDataEnabled(int subId); 837 838 /** 839 * Get P-CSCF address from PCO after data connection is established or modified. 840 * @param apnType the apnType, "ims" for IMS APN, "emergency" for EMERGENCY APN 841 * @param callingPackage The package making the call. 842 */ 843 String[] getPcscfAddress(String apnType, String callingPackage); 844 845 /** 846 * Set IMS registration state 847 */ 848 void setImsRegistrationState(boolean registered); 849 850 /** 851 * Return MDN string for CDMA phone. 852 * @param subId user preferred subId. 853 */ 854 String getCdmaMdn(int subId); 855 856 /** 857 * Return MIN string for CDMA phone. 858 * @param subId user preferred subId. 859 */ 860 String getCdmaMin(int subId); 861 862 /** 863 * Has the calling application been granted special privileges by the carrier. 864 * 865 * If any of the packages in the calling UID has carrier privileges, the 866 * call will return true. This access is granted by the owner of the UICC 867 * card and does not depend on the registered carrier. 868 * 869 * TODO: Add a link to documentation. 870 * 871 * @param subId The subscription to use. 872 * @return carrier privilege status defined in TelephonyManager. 873 */ 874 int getCarrierPrivilegeStatus(int subId); 875 876 /** 877 * Similar to above, but check for the package whose name is pkgName. 878 */ 879 int checkCarrierPrivilegesForPackage(String pkgName); 880 881 /** 882 * Similar to above, but check across all phones. 883 */ 884 int checkCarrierPrivilegesForPackageAnyPhone(String pkgName); 885 886 /** 887 * Returns list of the package names of the carrier apps that should handle the input intent 888 * and have carrier privileges for the given phoneId. 889 * 890 * @param intent Intent that will be sent. 891 * @param phoneId The phoneId on which the carrier app has carrier privileges. 892 * @return list of carrier app package names that can handle the intent on phoneId. 893 * Returns null if there is an error and an empty list if there 894 * are no matching packages. 895 */ 896 List<String> getCarrierPackageNamesForIntentAndPhone(in Intent intent, int phoneId); 897 898 /** 899 * Set the line 1 phone number string and its alphatag for the current ICCID 900 * for display purpose only, for example, displayed in Phone Status. It won't 901 * change the actual MSISDN/MDN. To unset alphatag or number, pass in a null 902 * value. 903 * 904 * @param subId the subscriber that the alphatag and dialing number belongs to. 905 * @param alphaTag alpha-tagging of the dailing nubmer 906 * @param number The dialing number 907 * @return true if the operation was executed correctly. 908 */ 909 boolean setLine1NumberForDisplayForSubscriber(int subId, String alphaTag, String number); 910 911 /** 912 * Returns the displayed dialing number string if it was set previously via 913 * {@link #setLine1NumberForDisplay}. Otherwise returns null. 914 * 915 * @param subId whose dialing number for line 1 is returned. 916 * @param callingPackage The package making the call. 917 * @return the displayed dialing number if set, or null if not set. 918 */ 919 String getLine1NumberForDisplay(int subId, String callingPackage); 920 921 /** 922 * Returns the displayed alphatag of the dialing number if it was set 923 * previously via {@link #setLine1NumberForDisplay}. Otherwise returns null. 924 * 925 * @param subId whose alphatag associated with line 1 is returned. 926 * @param callingPackage The package making the call. 927 * @return the displayed alphatag of the dialing number if set, or null if 928 * not set. 929 */ 930 String getLine1AlphaTagForDisplay(int subId, String callingPackage); 931 932 String[] getMergedSubscriberIds(String callingPackage); 933 934 /** 935 * Override the operator branding for the current ICCID. 936 * 937 * Once set, whenever the SIM is present in the device, the service 938 * provider name (SPN) and the operator name will both be replaced by the 939 * brand value input. To unset the value, the same function should be 940 * called with a null brand value. 941 * 942 * <p>Requires Permission: 943 * {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} 944 * or has to be carrier app - see #hasCarrierPrivileges. 945 * 946 * @param subId The subscription to use. 947 * @param brand The brand name to display/set. 948 * @return true if the operation was executed correctly. 949 */ 950 boolean setOperatorBrandOverride(int subId, String brand); 951 952 /** 953 * Override the roaming indicator for the current ICCID. 954 * 955 * Using this call, the carrier app (see #hasCarrierPrivileges) can override 956 * the platform's notion of a network operator being considered roaming or not. 957 * The change only affects the ICCID that was active when this call was made. 958 * 959 * If null is passed as any of the input, the corresponding value is deleted. 960 * 961 * <p>Requires that the caller have carrier privilege. See #hasCarrierPrivileges. 962 * 963 * @param subId for which the roaming overrides apply. 964 * @param gsmRoamingList - List of MCCMNCs to be considered roaming for 3GPP RATs. 965 * @param gsmNonRoamingList - List of MCCMNCs to be considered not roaming for 3GPP RATs. 966 * @param cdmaRoamingList - List of SIDs to be considered roaming for 3GPP2 RATs. 967 * @param cdmaNonRoamingList - List of SIDs to be considered not roaming for 3GPP2 RATs. 968 * @return true if the operation was executed correctly. 969 */ 970 boolean setRoamingOverride(int subId, in List<String> gsmRoamingList, 971 in List<String> gsmNonRoamingList, in List<String> cdmaRoamingList, 972 in List<String> cdmaNonRoamingList); 973 974 /** 975 * Returns the result and response from RIL for oem request 976 * 977 * @param oemReq the data is sent to ril. 978 * @param oemResp the respose data from RIL. 979 * @return negative value request was not handled or get error 980 * 0 request was handled succesfully, but no response data 981 * positive value success, data length of response 982 */ 983 int invokeOemRilRequestRaw(in byte[] oemReq, out byte[] oemResp); 984 985 /** 986 * Check if any mobile Radios need to be shutdown. 987 * 988 * @return true is any mobile radio needs to be shutdown 989 */ 990 boolean needMobileRadioShutdown(); 991 992 /** 993 * Shutdown Mobile Radios 994 */ 995 void shutdownMobileRadios(); 996 997 /** 998 * Set phone radio type and access technology. 999 * 1000 * @param rafs an RadioAccessFamily array to indicate all phone's 1001 * new radio access family. The length of RadioAccessFamily 1002 * must equ]]al to phone count. 1003 */ 1004 void setRadioCapability(in RadioAccessFamily[] rafs); 1005 1006 /** 1007 * Get phone radio type and access technology. 1008 * 1009 * @param phoneId which phone you want to get 1010 * @param callingPackage the name of the package making the call 1011 * @return phone radio type and access technology 1012 */ 1013 int getRadioAccessFamily(in int phoneId, String callingPackage); 1014 1015 /** 1016 * Enables or disables video calling. 1017 * 1018 * @param enable Whether to enable video calling. 1019 */ 1020 void enableVideoCalling(boolean enable); 1021 1022 /** 1023 * Whether video calling has been enabled by the user. 1024 * 1025 * @param callingPackage The package making the call. 1026 * @return {@code true} if the user has enabled video calling, {@code false} otherwise. 1027 */ 1028 boolean isVideoCallingEnabled(String callingPackage); 1029 1030 /** 1031 * Whether the DTMF tone length can be changed. 1032 * 1033 * @return {@code true} if the DTMF tone length can be changed. 1034 */ 1035 boolean canChangeDtmfToneLength(); 1036 1037 /** 1038 * Whether the device is a world phone. 1039 * 1040 * @return {@code true} if the devices is a world phone. 1041 */ 1042 boolean isWorldPhone(); 1043 1044 /** 1045 * Whether the phone supports TTY mode. 1046 * 1047 * @return {@code true} if the device supports TTY mode. 1048 */ 1049 boolean isTtyModeSupported(); 1050 1051 /** 1052 * Whether the phone supports hearing aid compatibility. 1053 * 1054 * @return {@code true} if the device supports hearing aid compatibility. 1055 */ 1056 boolean isHearingAidCompatibilitySupported(); 1057 1058 /** 1059 * Get IMS Registration Status 1060 */ 1061 boolean isImsRegistered(); 1062 1063 /** 1064 * Returns the Status of Wi-Fi Calling 1065 */ 1066 boolean isWifiCallingAvailable(); 1067 1068 /** 1069 * Returns the Status of Volte 1070 */ 1071 boolean isVolteAvailable(); 1072 1073 /** 1074 * Returns the Status of VT (video telephony) 1075 */ 1076 boolean isVideoTelephonyAvailable(); 1077 1078 /** 1079 * Returns the unique device ID of phone, for example, the IMEI for 1080 * GSM and the MEID for CDMA phones. Return null if device ID is not available. 1081 * 1082 * @param callingPackage The package making the call. 1083 * <p>Requires Permission: 1084 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1085 */ 1086 String getDeviceId(String callingPackage); 1087 1088 /** 1089 * Returns the IMEI for the given slot. 1090 * 1091 * @param slotIndex - device slot. 1092 * @param callingPackage The package making the call. 1093 * <p>Requires Permission: 1094 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1095 */ 1096 String getImeiForSlot(int slotIndex, String callingPackage); 1097 1098 /** 1099 * Returns the device software version. 1100 * 1101 * @param slotIndex - device slot. 1102 * @param callingPackage The package making the call. 1103 * <p>Requires Permission: 1104 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} 1105 */ 1106 String getDeviceSoftwareVersionForSlot(int slotIndex, String callingPackage); 1107 1108 /** 1109 * Returns the subscription ID associated with the specified PhoneAccount. 1110 */ 1111 int getSubIdForPhoneAccount(in PhoneAccount phoneAccount); 1112 1113 void factoryReset(int subId); 1114 1115 /** 1116 * An estimate of the users's current locale based on the default SIM. 1117 * 1118 * The returned string will be a well formed BCP-47 language tag, or {@code null} 1119 * if no locale could be derived. 1120 */ 1121 String getLocaleFromDefaultSim(); 1122 1123 /** 1124 * Requests the modem activity info asynchronously. 1125 * The implementor is expected to reply with the 1126 * {@link android.telephony.ModemActivityInfo} object placed into the Bundle with the key 1127 * {@link android.telephony.TelephonyManager#MODEM_ACTIVITY_RESULT_KEY}. 1128 * The result code is ignored. 1129 */ 1130 oneway void requestModemActivityInfo(in ResultReceiver result); 1131 1132 /** 1133 * Get the service state on specified subscription 1134 * @param subId Subscription id 1135 * @param callingPackage The package making the call 1136 * @return Service state on specified subscription. 1137 */ 1138 ServiceState getServiceStateForSubscriber(int subId, String callingPackage); 1139 1140 /** 1141 * Returns the URI for the per-account voicemail ringtone set in Phone settings. 1142 * 1143 * @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the 1144 * voicemail ringtone. 1145 * @return The URI for the ringtone to play when receiving a voicemail from a specific 1146 * PhoneAccount. 1147 */ 1148 Uri getVoicemailRingtoneUri(in PhoneAccountHandle accountHandle); 1149 1150 /** 1151 * Sets the per-account voicemail ringtone. 1152 * 1153 * <p>Requires that the calling app is the default dialer, or has carrier privileges, or 1154 * has permission {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}. 1155 * 1156 * @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the 1157 * voicemail ringtone. 1158 * @param uri The URI for the ringtone to play when receiving a voicemail from a specific 1159 * PhoneAccount. 1160 */ 1161 void setVoicemailRingtoneUri(String callingPackage, 1162 in PhoneAccountHandle phoneAccountHandle, in Uri uri); 1163 1164 /** 1165 * Returns whether vibration is set for voicemail notification in Phone settings. 1166 * 1167 * @param accountHandle The handle for the {@link PhoneAccount} for which to retrieve the 1168 * voicemail vibration setting. 1169 * @return {@code true} if the vibration is set for this PhoneAccount, {@code false} otherwise. 1170 */ 1171 boolean isVoicemailVibrationEnabled(in PhoneAccountHandle accountHandle); 1172 1173 /** 1174 * Sets the per-account preference whether vibration is enabled for voicemail notifications. 1175 * 1176 * <p>Requires that the calling app is the default dialer, or has carrier privileges, or 1177 * has permission {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE}. 1178 * 1179 * @param phoneAccountHandle The handle for the {@link PhoneAccount} for which to set the 1180 * voicemail vibration setting. 1181 * @param enabled Whether to enable or disable vibration for voicemail notifications from a 1182 * specific PhoneAccount. 1183 */ 1184 void setVoicemailVibrationEnabled(String callingPackage, 1185 in PhoneAccountHandle phoneAccountHandle, boolean enabled); 1186 1187 /** 1188 * Returns a list of packages that have carrier privileges. 1189 */ 1190 List<String> getPackagesWithCarrierPrivileges(); 1191 1192 /** 1193 * Return the application ID for the app type. 1194 * 1195 * @param subId the subscription ID that this request applies to. 1196 * @param appType the uicc app type, 1197 * @return Application ID for specificied app type or null if no uicc or error. 1198 */ 1199 String getAidForAppType(int subId, int appType); 1200 1201 /** 1202 * Return the Electronic Serial Number. 1203 * 1204 * Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission 1205 * 1206 * @param subId the subscription ID that this request applies to. 1207 * @return ESN or null if error. 1208 * @hide 1209 */ 1210 String getEsn(int subId); 1211 1212 /** 1213 * Return the Preferred Roaming List Version 1214 * 1215 * Requires that the calling app has READ_PRIVILEGED_PHONE_STATE permission 1216 * @param subId the subscription ID that this request applies to. 1217 * @return PRLVersion or null if error. 1218 * @hide 1219 */ 1220 String getCdmaPrlVersion(int subId); 1221 1222 /** 1223 * Get snapshot of Telephony histograms 1224 * @return List of Telephony histograms 1225 * Requires Permission: 1226 * {@link android.Manifest.permission#MODIFY_PHONE_STATE MODIFY_PHONE_STATE} 1227 * Or the calling app has carrier privileges. 1228 */ 1229 List<TelephonyHistogram> getTelephonyHistograms(); 1230 1231 /** 1232 * Set the allowed carrier list for slotIndex 1233 * Require system privileges. In the future we may add this to carrier APIs. 1234 * 1235 * @return The number of carriers set successfully. Should match length of 1236 * carriers on success. 1237 */ 1238 int setAllowedCarriers(int slotIndex, in List<CarrierIdentifier> carriers); 1239 1240 /** 1241 * Get the allowed carrier list for slotIndex. 1242 * Require system privileges. In the future we may add this to carrier APIs. 1243 * 1244 * @return List of {@link android.service.carrier.CarrierIdentifier}; empty list 1245 * means all carriers are allowed. 1246 */ 1247 List<CarrierIdentifier> getAllowedCarriers(int slotIndex); 1248 1249 /** 1250 * Action set from carrier signalling broadcast receivers to enable/disable metered apns 1251 * Permissions android.Manifest.permission.MODIFY_PHONE_STATE is required 1252 * @param subId the subscription ID that this action applies to. 1253 * @param enabled control enable or disable metered apns. 1254 * @hide 1255 */ 1256 void carrierActionSetMeteredApnsEnabled(int subId, boolean visible); 1257 1258 /** 1259 * Action set from carrier signalling broadcast receivers to enable/disable radio 1260 * Permissions android.Manifest.permission.MODIFY_PHONE_STATE is required 1261 * @param subId the subscription ID that this action applies to. 1262 * @param enabled control enable or disable radio. 1263 * @hide 1264 */ 1265 void carrierActionSetRadioEnabled(int subId, boolean enabled); 1266 1267 /** 1268 * Get aggregated video call data usage since boot. 1269 * Permissions android.Manifest.permission.READ_NETWORK_USAGE_HISTORY is required. 1270 * @return total data usage in bytes 1271 * @hide 1272 */ 1273 long getVtDataUsage(); 1274 1275 /** 1276 * Policy control of data connection. Usually used when data limit is passed. 1277 * @param enabled True if enabling the data, otherwise disabling. 1278 * @param subId Subscription index 1279 * @hide 1280 */ 1281 void setPolicyDataEnabled(boolean enabled, int subId); 1282 1283 /** 1284 * Get Client request stats which will contain statistical information 1285 * on each request made by client. 1286 * @param callingPackage package making the call. 1287 * @param subId Subscription index 1288 * @hide 1289 */ 1290 List<ClientRequestStats> getClientRequestStats(String callingPackage, int subid); 1291 1292 /** 1293 * Set SIM card power state. Request is equivalent to inserting or removing the card. 1294 * @param slotIndex SIM slot id 1295 * @param powerUp True if powering up the SIM, otherwise powering down 1296 * @hide 1297 * */ 1298 void setSimPowerStateForSlot(int slotIndex, boolean powerUp); 1299 1300 /** 1301 * Returns a list of Forbidden PLMNs from the specified SIM App 1302 * Returns null if the query fails. 1303 * 1304 * 1305 * <p>Requires that the calling app has READ_PRIVILEGED_PHONE_STATE 1306 * 1307 * @param subId subscription ID used for authentication 1308 * @param appType the icc application type, like {@link #APPTYPE_USIM} 1309 */ 1310 String[] getForbiddenPlmns(int subId, int appType); 1311} 1312