From 19ba736c22869ec678ce0a79858ab3624fedee1b Mon Sep 17 00:00:00 2001 From: pkanwar Date: Fri, 14 Oct 2016 19:40:13 -0700 Subject: [PATCH] Provide an API to make USSD calls and read the responses. Test: will be added in a subsequent CL. Bug: 30973910 Change-Id: Ic1214330ddf6846973d8bd28ee6ff1d28ae8c852 --- api/current.txt | 9 ++- api/system-current.txt | 9 ++- api/test-current.txt | 9 ++- .../android/telephony/TelephonyManager.java | 79 +++++++++++++++++- .../java/android/telephony/UssdResponse.aidl | 20 +++++ .../java/android/telephony/UssdResponse.java | 80 +++++++++++++++++++ .../internal/telephony/ITelephony.aidl | 9 +++ 7 files changed, 211 insertions(+), 4 deletions(-) create mode 100644 telephony/java/android/telephony/UssdResponse.aidl create mode 100644 telephony/java/android/telephony/UssdResponse.java diff --git a/api/current.txt b/api/current.txt index 9aa8c59dbf707..b162bb01b7bc4 100644 --- a/api/current.txt +++ b/api/current.txt @@ -37533,6 +37533,7 @@ package android.telephony { method public boolean isWorldPhone(); method public void listen(android.telephony.PhoneStateListener, int); method public java.lang.String sendEnvelopeWithStatus(java.lang.String); + method public void sendUssdRequest(java.lang.String, android.telephony.TelephonyManager.OnReceiveUssdResponseCallback, android.os.Handler); method public boolean setLine1NumberForDisplay(java.lang.String, java.lang.String); method public boolean setOperatorBrandOverride(java.lang.String); method public boolean setPreferredNetworkTypeToGlobal(); @@ -37597,6 +37598,12 @@ package android.telephony { field public static final java.lang.String VVM_TYPE_OMTP = "vvm_type_omtp"; } + public static abstract class TelephonyManager.OnReceiveUssdResponseCallback { + ctor public TelephonyManager.OnReceiveUssdResponseCallback(); + method public void onReceiveUssdResponse(java.lang.String, java.lang.CharSequence); + method public void onReceiveUssdResponseFailed(java.lang.String, int); + } + } package android.telephony.cdma { @@ -44024,8 +44031,8 @@ package android.view { field public static final int ROTATION_ANIMATION_CHANGED = 4096; // 0x1000 field public static final int ROTATION_ANIMATION_CROSSFADE = 1; // 0x1 field public static final int ROTATION_ANIMATION_JUMPCUT = 2; // 0x2 - field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int ROTATION_ANIMATION_ROTATE = 0; // 0x0 + field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int SCREEN_BRIGHTNESS_CHANGED = 2048; // 0x800 field public static final int SCREEN_ORIENTATION_CHANGED = 1024; // 0x400 field public static final int SOFT_INPUT_ADJUST_NOTHING = 48; // 0x30 diff --git a/api/system-current.txt b/api/system-current.txt index e6e5d38356574..09b5128c3590e 100644 --- a/api/system-current.txt +++ b/api/system-current.txt @@ -40673,6 +40673,7 @@ package android.telephony { method public void listen(android.telephony.PhoneStateListener, int); method public boolean needsOtaServiceProvisioning(); method public java.lang.String sendEnvelopeWithStatus(java.lang.String); + method public void sendUssdRequest(java.lang.String, android.telephony.TelephonyManager.OnReceiveUssdResponseCallback, android.os.Handler); method public void setDataEnabled(boolean); method public void setDataEnabled(int, boolean); method public boolean setLine1NumberForDisplay(java.lang.String, java.lang.String); @@ -40763,6 +40764,12 @@ package android.telephony { field public static final java.lang.String VVM_TYPE_OMTP = "vvm_type_omtp"; } + public static abstract class TelephonyManager.OnReceiveUssdResponseCallback { + ctor public TelephonyManager.OnReceiveUssdResponseCallback(); + method public void onReceiveUssdResponse(java.lang.String, java.lang.CharSequence); + method public void onReceiveUssdResponseFailed(java.lang.String, int); + } + } package android.telephony.cdma { @@ -47206,8 +47213,8 @@ package android.view { field public static final int ROTATION_ANIMATION_CHANGED = 4096; // 0x1000 field public static final int ROTATION_ANIMATION_CROSSFADE = 1; // 0x1 field public static final int ROTATION_ANIMATION_JUMPCUT = 2; // 0x2 - field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int ROTATION_ANIMATION_ROTATE = 0; // 0x0 + field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int SCREEN_BRIGHTNESS_CHANGED = 2048; // 0x800 field public static final int SCREEN_ORIENTATION_CHANGED = 1024; // 0x400 field public static final int SOFT_INPUT_ADJUST_NOTHING = 48; // 0x30 diff --git a/api/test-current.txt b/api/test-current.txt index ee3cb0d66e4d0..9503830b8a236 100644 --- a/api/test-current.txt +++ b/api/test-current.txt @@ -37614,6 +37614,7 @@ package android.telephony { method public boolean isWorldPhone(); method public void listen(android.telephony.PhoneStateListener, int); method public java.lang.String sendEnvelopeWithStatus(java.lang.String); + method public void sendUssdRequest(java.lang.String, android.telephony.TelephonyManager.OnReceiveUssdResponseCallback, android.os.Handler); method public boolean setLine1NumberForDisplay(java.lang.String, java.lang.String); method public boolean setOperatorBrandOverride(java.lang.String); method public boolean setPreferredNetworkTypeToGlobal(); @@ -37678,6 +37679,12 @@ package android.telephony { field public static final java.lang.String VVM_TYPE_OMTP = "vvm_type_omtp"; } + public static abstract class TelephonyManager.OnReceiveUssdResponseCallback { + ctor public TelephonyManager.OnReceiveUssdResponseCallback(); + method public void onReceiveUssdResponse(java.lang.String, java.lang.CharSequence); + method public void onReceiveUssdResponseFailed(java.lang.String, int); + } + } package android.telephony.cdma { @@ -44260,8 +44267,8 @@ package android.view { field public static final int ROTATION_ANIMATION_CHANGED = 4096; // 0x1000 field public static final int ROTATION_ANIMATION_CROSSFADE = 1; // 0x1 field public static final int ROTATION_ANIMATION_JUMPCUT = 2; // 0x2 - field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int ROTATION_ANIMATION_ROTATE = 0; // 0x0 + field public static final int ROTATION_ANIMATION_SEAMLESS = 3; // 0x3 field public static final int SCREEN_BRIGHTNESS_CHANGED = 2048; // 0x800 field public static final int SCREEN_ORIENTATION_CHANGED = 1024; // 0x400 field public static final int SOFT_INPUT_ADJUST_NOTHING = 48; // 0x30 diff --git a/telephony/java/android/telephony/TelephonyManager.java b/telephony/java/android/telephony/TelephonyManager.java index 5b6319927731a..8b46250e10fac 100644 --- a/telephony/java/android/telephony/TelephonyManager.java +++ b/telephony/java/android/telephony/TelephonyManager.java @@ -16,7 +16,10 @@ package android.telephony; +import static com.android.internal.util.Preconditions.checkNotNull; + import android.annotation.Nullable; +import android.annotation.RequiresPermission; import android.annotation.SystemApi; import android.annotation.SdkConstant; import android.annotation.SdkConstant.SdkConstantType; @@ -27,11 +30,12 @@ import android.content.Intent; import android.net.ConnectivityManager; import android.net.Uri; import android.os.BatteryStats; -import android.os.ResultReceiver; import android.provider.Settings; import android.provider.Settings.SettingNotFoundException; import android.os.Bundle; +import android.os.Handler; import android.os.RemoteException; +import android.os.ResultReceiver; import android.os.ServiceManager; import android.os.SystemProperties; import android.service.carrier.CarrierIdentifier; @@ -792,6 +796,29 @@ public class TelephonyManager { */ public static final String VVM_TYPE_CVVM = "vvm_type_cvvm"; + /** + * @hide + */ + public static final String USSD_RESPONSE = "USSD_RESPONSE"; + + /** + * USSD return code success. + * @hide + */ + public static final int USSD_RETURN_SUCCESS = 100; + + /** + * USSD return code for failure case. + * @hide + */ + public static final int USSD_RETURN_FAILURE = -1; + + /** + * USSD return code for failure case. + * @hide + */ + public static final int USSD_ERROR_SERVICE_UNAVAIL = -2; + // // // Device Info @@ -4606,6 +4633,56 @@ public class TelephonyManager { return new int[0]; } + public static abstract class OnReceiveUssdResponseCallback { + /** + ** Called when USSD has succeeded. + **/ + public void onReceiveUssdResponse(String request, CharSequence response) {}; + + /** + ** Called when USSD has failed. + **/ + public void onReceiveUssdResponseFailed(String request, int failureCode) {}; + } + + /*

Requires permission: + * @link android.Manifest.permission#CALL_PHONE} + */ + @RequiresPermission(android.Manifest.permission.CALL_PHONE) + public void sendUssdRequest(String ussdRequest, + final OnReceiveUssdResponseCallback callback, Handler handler) { + checkNotNull(callback, "OnReceiveUssdResponseCallback cannot be null."); + + ResultReceiver wrappedCallback = new ResultReceiver(handler) { + @Override + protected void onReceiveResult(int resultCode, Bundle ussdResponse) { + Rlog.d(TAG, "USSD:" + resultCode); + checkNotNull(ussdResponse, "ussdResponse cannot be null."); + UssdResponse response = ussdResponse.getParcelable(USSD_RESPONSE); + + if (resultCode == USSD_RETURN_SUCCESS) { + callback.onReceiveUssdResponse(response.getUssdRequest(), + response.getReturnMessage()); + } else { + callback.onReceiveUssdResponseFailed(response.getUssdRequest(), resultCode); + } + } + }; + + try { + ITelephony telephony = getITelephony(); + if (telephony != null) { + telephony.handleUssdRequest(ussdRequest, wrappedCallback); + } + } catch (RemoteException e) { + Log.e(TAG, "Error calling ITelephony#sendUSSDCode", e); + UssdResponse response = new UssdResponse(ussdRequest, ""); + Bundle returnData = new Bundle(); + returnData.putParcelable(USSD_RESPONSE, response); + wrappedCallback.send(USSD_ERROR_SERVICE_UNAVAIL, returnData); + } + } + /** @hide */ @SystemApi public boolean handlePinMmi(String dialString) { diff --git a/telephony/java/android/telephony/UssdResponse.aidl b/telephony/java/android/telephony/UssdResponse.aidl new file mode 100644 index 0000000000000..add28a02ae100 --- /dev/null +++ b/telephony/java/android/telephony/UssdResponse.aidl @@ -0,0 +1,20 @@ +/* +** +** Copyright 2007, The Android Open Source Project +** +** Licensed under the Apache License, Version 2.0 (the "License"); +** you may not use this file except in compliance with the License. +** You may obtain a copy of the License at +** +** http://www.apache.org/licenses/LICENSE-2.0 +** +** Unless required by applicable law or agreed to in writing, software +** distributed under the License is distributed on an "AS IS" BASIS, +** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +** See the License for the specific language governing permissions and +** limitations under the License. +*/ + +package android.telephony; + +parcelable UssdResponse; diff --git a/telephony/java/android/telephony/UssdResponse.java b/telephony/java/android/telephony/UssdResponse.java new file mode 100644 index 0000000000000..5df681d4406ec --- /dev/null +++ b/telephony/java/android/telephony/UssdResponse.java @@ -0,0 +1,80 @@ +/* + * Copyright (C) 2006 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.telephony; + +import android.os.Parcel; +import android.os.Parcelable; +import android.text.TextUtils; + +/** + * Represents the Ussd response, including + * the message and the return code. + * @hide + */ +public final class UssdResponse implements Parcelable { + private CharSequence mReturnMessage; + private String mUssdRequest; + + + /** + * Implement the Parcelable interface + */ + @Override + public void writeToParcel(Parcel dest, int flags) { + dest.writeString(mUssdRequest); + TextUtils.writeToParcel(mReturnMessage, dest, 0); + } + + public String getUssdRequest() { + return mUssdRequest; + } + + public CharSequence getReturnMessage() { + return mReturnMessage; + } + + /** + * Implement the Parcelable interface + */ + @Override + public int describeContents() { + return 0; + } + + /** + * * Initialize the object from the request and return message. + */ + public UssdResponse(String ussdRequest, CharSequence returnMessage) { + mUssdRequest = ussdRequest; + mReturnMessage = returnMessage; + } + + public static final Parcelable.Creator CREATOR = new Creator() { + + @Override + public UssdResponse createFromParcel(Parcel in) { + String request = in.readString(); + CharSequence message = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); + return new UssdResponse(request, message); + } + + @Override + public UssdResponse[] newArray(int size) { + return new UssdResponse[size]; + } + }; +} diff --git a/telephony/java/com/android/internal/telephony/ITelephony.aidl b/telephony/java/com/android/internal/telephony/ITelephony.aidl index c72b32a7915b9..4c66be1955df2 100644 --- a/telephony/java/com/android/internal/telephony/ITelephony.aidl +++ b/telephony/java/com/android/internal/telephony/ITelephony.aidl @@ -271,6 +271,15 @@ interface ITelephony { */ boolean handlePinMmi(String dialString); + + /** + * Handles USSD commands. + * + * @param ussdRequest the USSD command to be executed. + * @param wrappedCallback receives a callback result. + */ + void handleUssdRequest(String ussdRequest, in ResultReceiver wrappedCallback); + /** * Handles PIN MMI commands (PIN/PIN2/PUK/PUK2), which are initiated * without SEND (so dial is not appropriate) for