1 /* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.internal.telephony.cat; 18 19 import android.annotation.UnsupportedAppUsage; 20 import android.content.ComponentName; 21 22 /** 23 * Interface for communication between STK App and CAT Telephony 24 * 25 * {@hide} 26 */ 27 public interface AppInterface { 28 29 /* 30 * Intent's actions which are broadcasted by the Telephony once a new CAT 31 * proactive command, session end, ALPHA during STK CC arrive. 32 */ 33 public static final String CAT_CMD_ACTION = 34 "com.android.internal.stk.command"; 35 public static final String CAT_SESSION_END_ACTION = 36 "com.android.internal.stk.session_end"; 37 public static final String CAT_ALPHA_NOTIFY_ACTION = 38 "com.android.internal.stk.alpha_notify"; 39 40 //This is used to send ALPHA string from card to STK App. 41 public static final String ALPHA_STRING = "alpha_string"; 42 43 // This is used to send refresh-result when MSG_ID_ICC_REFRESH is received. 44 public static final String REFRESH_RESULT = "refresh_result"; 45 //This is used to send card status from card to STK App. 46 public static final String CARD_STATUS = "card_status"; 47 //Intent's actions are broadcasted by Telephony once IccRefresh occurs. 48 public static final String CAT_ICC_STATUS_CHANGE = 49 "com.android.internal.stk.icc_status_change"; 50 51 // Permission required by STK command receiver 52 public static final String STK_PERMISSION = "android.permission.RECEIVE_STK_COMMANDS"; 53 54 // Only forwards cat broadcast to the system default stk app getDefaultSTKApplication()55 public static ComponentName getDefaultSTKApplication() { 56 return ComponentName.unflattenFromString("com.android.stk/.StkCmdReceiver"); 57 } 58 59 /* 60 * Callback function from app to telephony to pass a result code and user's 61 * input back to the ICC. 62 */ onCmdResponse(CatResponseMessage resMsg)63 void onCmdResponse(CatResponseMessage resMsg); 64 65 /* 66 * Enumeration for representing "Type of Command" of proactive commands. 67 * Those are the only commands which are supported by the Telephony. Any app 68 * implementation should support those. 69 * Refer to ETSI TS 102.223 section 9.4 70 */ 71 public static enum CommandType { 72 @UnsupportedAppUsage 73 DISPLAY_TEXT(0x21), 74 @UnsupportedAppUsage 75 GET_INKEY(0x22), 76 @UnsupportedAppUsage 77 GET_INPUT(0x23), 78 @UnsupportedAppUsage 79 LAUNCH_BROWSER(0x15), 80 @UnsupportedAppUsage 81 PLAY_TONE(0x20), 82 @UnsupportedAppUsage 83 REFRESH(0x01), 84 @UnsupportedAppUsage 85 SELECT_ITEM(0x24), 86 @UnsupportedAppUsage 87 SEND_SS(0x11), 88 @UnsupportedAppUsage 89 SEND_USSD(0x12), 90 @UnsupportedAppUsage 91 SEND_SMS(0x13), 92 RUN_AT(0x34), 93 @UnsupportedAppUsage 94 SEND_DTMF(0x14), 95 @UnsupportedAppUsage 96 SET_UP_EVENT_LIST(0x05), 97 @UnsupportedAppUsage 98 SET_UP_IDLE_MODE_TEXT(0x28), 99 @UnsupportedAppUsage 100 SET_UP_MENU(0x25), 101 @UnsupportedAppUsage 102 SET_UP_CALL(0x10), 103 @UnsupportedAppUsage 104 PROVIDE_LOCAL_INFORMATION(0x26), 105 @UnsupportedAppUsage 106 LANGUAGE_NOTIFICATION(0x35), 107 @UnsupportedAppUsage 108 OPEN_CHANNEL(0x40), 109 @UnsupportedAppUsage 110 CLOSE_CHANNEL(0x41), 111 @UnsupportedAppUsage 112 RECEIVE_DATA(0x42), 113 @UnsupportedAppUsage 114 SEND_DATA(0x43), 115 @UnsupportedAppUsage 116 GET_CHANNEL_STATUS(0x44); 117 118 private int mValue; 119 CommandType(int value)120 CommandType(int value) { 121 mValue = value; 122 } 123 value()124 public int value() { 125 return mValue; 126 } 127 128 /** 129 * Create a CommandType object. 130 * 131 * @param value Integer value to be converted to a CommandType object. 132 * @return CommandType object whose "Type of Command" value is {@code 133 * value}. If no CommandType object has that value, null is 134 * returned. 135 */ 136 @UnsupportedAppUsage fromInt(int value)137 public static CommandType fromInt(int value) { 138 for (CommandType e : CommandType.values()) { 139 if (e.mValue == value) { 140 return e; 141 } 142 } 143 return null; 144 } 145 } 146 } 147