WebAPI/WebSTK: Difference between revisions

Jump to navigation Jump to search

WebAPI/WebSTK (view source)

Revision as of 23:27, 1 October 2014

3,269 bytes added ,  1 October 2014
no edit summary
No edit summary
 
(12 intermediate revisions by one other user not shown)
Line 3: Line 3:


= Status =
= Status =
Bugzilla : https://bugzilla.mozilla.org/show_bug.cgi?id=744714
Bugzilla : https://bugzilla.mozilla.org/show_bug.cgi?id=791161 <br>
Feature List: https://docs.google.com/spreadsheet/ccc?key=0AuvgnQ-Iwb6XdGV0aHZWdGdmZVEzZUxmZWNEaGJYWkE


= Interface =
= Interface =
Line 42: Line 43:
   * Command.
   * Command.
   *
   *
  * @param command
  *        Command received from ICC. See MozStkCommand.
   * @param response
   * @param response
   *        The response that will be sent to ICC.
   *        The response that will be sent to ICC.
   * @see nsIDOMMozStkResponse for the detail of response.
   * @see MozStkResponse for the detail of response.
   */
   */
   void sendStkResponse(in jsval response);
   void sendStkResponse(in jsval command, in jsval response);
</pre>
</pre>


=== Send Envelope Command ===
=== Send Envelope Command ===
Currently only support "Menu Selection"
Currently only support "Menu Selection", "Event Download"
<pre>
<pre>
   /**
   /**
Line 62: Line 65:
   void sendStkMenuSelection(in unsigned short itemIdentifier,
   void sendStkMenuSelection(in unsigned short itemIdentifier,
                             in boolean        helpRequested);
                             in boolean        helpRequested);
  /**
  * Send "Event Download" Envelope command to ICC.
  * ICC will not respond with any data for this command.
  *
  * @param event
  *        one of events below:
  *        - MozStkLocationEvent
  *        - MozStkCallEvent
  */
  void sendStkEventDownload(in jsval event);
</pre>
</pre>


Line 170: Line 184:
=== STK command ===
=== STK command ===
<pre>
<pre>
dictionary nsIDOMMozStkCommand
dictionary MozStkCommand
{
{
   /**
   /**
Line 191: Line 205:


   /**
   /**
   * options varies accrording to the typeOfCommand in nsIDOMMozStkCommand.
   * options varies accrording to the typeOfCommand in MozStkCommand.
  *
  * When typeOfCommand is
  * - STK_CMD_DISPLAY_TEXT
  * - STK_CMD_SET_UP_IDLE_MODE_TEXT
  * - STK_CMD_SEND_{SS|USSD|SMS|DTMF},
  * options is MozStkTextMessage.
  *
  * When typeOfCommand is
  * - STK_CMD_SELECT_ITEM
  * - STK_CMD_SET_UP_MENU
  * options is MozStkMenu.
   *
   *
   * When typeOfCommand is
   * When typeOfCommand is
   * - STK_DISPLAY_TEXT
   * - STK_CMD_GET_INKEY
   * - STK_SET_UP_IDLE_MODE_TEXT
   * - STK_CMD_GET_INPUT,
  * - STK_REFRESH
   * options is MozStkInput.
  * - STK_SEND_{SS|USSD|SMS|DTMF},
   * options is nsIDOMMozStkTextMessage.
   *
   *
   * When typeOfCommand is
   * When typeOfCommand is
   * - STK_SELECT_ITEM
   * - STK_CMD_LAUNCH_BROWSER
  * - STK_SET_UP_MENU
   * options is MozStkBrowserSetting.
   * options is nsIDOMMozStkMenu.
   *
   *
   * When typeOfCommand is
   * When typeOfCommand is
   * - STK_GET_INKEY
   * - STK_CMD_SET_UP_CALL
  * - STK_GET_INPUT,
   * options is MozStkSetUpCall.
   * options is nsIDOMMozStkInput.
   *
   *
   * When typeOfCommand is
   * When typeOfCommand is
   * - STK_LAUNCH_BROWSER
   * - STK_CMD_SET_UP_EVENT_LIST
   * options is nsIDOMMozStkBrowserSetting.
   * options is MozStkSetUpEventList.
   *
   *
   * When typeOfCommand is
   * When typeOfCommand is
   * - STK_SET_UP_CALL
   * - STK_CMD_PLAY_TONE
   * options is nsIDOMMozStkSetUpCall.
   * options is MozStkPlayTone.
  *
  * When typeOfCommand is
  * - STK_CMD_POLL_INTERVAL
  * options is MozStkDuration.
  *
  * When typeOfCommand is
  * - STK_CMD_POLL_OFF
  * options is null.
  *
  * When typeOfCommand is
  * - STK_CMD_REFRESH
  * options is null.
   */
   */
   jsval options;
   jsval options;
Line 225: Line 258:
===== Text Message =====
===== Text Message =====
<pre>
<pre>
dictionary nsIDOMMozStkTextMessage
dictionary MozStkTextMessage
{
{
   /**
   /**
Line 282: Line 315:
===== Menu =====
===== Menu =====
<pre>
<pre>
dictionary nsIDOMMozStkItem
dictionary MozStkItem
{
{
   /**
   /**
Line 300: Line 333:


<pre>
<pre>
dictionary nsIDOMMozStkMenu
dictionary MozStkMenu
{
{
   /**
   /**
   * Array of nsIDOMMozStkItem.
   * Array of MozStkItem.
   *
   *
   * @see TS 11.14, clause 12.9
   * @see TS 11.14, clause 12.9
   */
   */
   jsval items; // nsIDOMMozStkItem[]
   jsval items; // MozStkItem[]


   /**
   /**
Line 338: Line 371:
===== Input =====
===== Input =====
<pre>
<pre>
dictionary nsIDOMMozStkInput
dictionary MozStkInput
{
{
   /**
   /**
Line 426: Line 459:
===== Browser Settings =====
===== Browser Settings =====
<pre>
<pre>
dictionary nsIDOMMozStkBrowserSetting
dictionary MozStkBrowserSetting
{
{
   /**
   /**
   * Confirm message to launch browser.
   * Confirm message to launch browser.
   *
   *
   * @see nsIDOMMozStkTextMessage for the detail specification of
   * @see MozStkTextMessage for the detail specification of
   *      confirmMessage.
   *      confirmMessage.
   */
   */
Line 452: Line 485:
===== Set Up Call =====
===== Set Up Call =====
<pre>
<pre>
dictionary nsIDOMMozStkSetUpCall
dictionary MozStkSetUpCall
{
{
   /**
   /**
Line 462: Line 495:
   * The text message used in user confirmation phase.
   * The text message used in user confirmation phase.
   *
   *
   * @see nsIDOMMozStkTextMessage for the detail specification of
   * @see MozStkTextMessage for the detail specification of
   *      confirmMessage.
   *      confirmMessage.
   */
   */
Line 470: Line 503:
   * The text message used in call set up phase.
   * The text message used in call set up phase.
   *
   *
   * @see nsIDOMMozStkTextMessage for the detail specification of
   * @see MozStkTextMessage for the detail specification of
   *      callMessage.
   *      callMessage.
   */
   */
Line 482: Line 515:
=== STK response ===
=== STK response ===
<pre>
<pre>
dictionary nsIDOMMozStkResponse
dictionary MozStkResponse
{
{
  /**
  * commandNumber from MozStkCommand.
  *
  * @see nsIDOMMozStkCommand.commandNumber
  */
  unsigned short commandNumber;
  /**
  * One of nsIDOMMozStkCommand.typeOfCommand
  *
  * @see nsIDOMMozStkCommand.typeOfCommand
  */
  unsigned short typeOfCommand;
  /**
  * Qualifiers specific to the command.
  *
  * @see nsIDOMMozStkCommand.commandQualifier
  */
  unsigned short commandQualifier;
   /**
   /**
   * One of RESULT_*
   * One of RESULT_*
Line 513: Line 525:
   * The identifier of the item selected by user.
   * The identifier of the item selected by user.
   *
   *
   * @see nsIDOMMozStkItem.identifier
   * @see MozStkItem.identifier
   */
   */
   unsigned short itemIdentifier;
   unsigned short itemIdentifier;
Line 521: Line 533:
   */
   */
   DOMString input;
   DOMString input;
  /**
  * Alphabet encoding.
  *
  * @see nsIDOMMozStkInput.isUCS2
  */
  boolean isUCS2;


   /**
   /**
   * YES/NO response.
   * YES/NO response.
   *
   *
   * @see nsIDOMMozStkInput.isYesNoRequested
   * @see MozStkInput.isYesNoRequested
   */
   */
   boolean isYesNo;
   boolean isYesNo;
  /**
  * Packed or unpacked format.
  *
  * @see nsIDOMMozStkInput.isPacked
  */
  boolean isPacked;


   /**
   /**
Line 573: Line 571:
   const unsigned short STK_BROWSER_MODE_USING_EXISTING_BROWSER        = 0x02;
   const unsigned short STK_BROWSER_MODE_USING_EXISTING_BROWSER        = 0x02;
   const unsigned short STK_BROWSER_MODE_USING_NEW_BROWSER              = 0x03;
   const unsigned short STK_BROWSER_MODE_USING_NEW_BROWSER              = 0x03;
 
   /**
   /**
   * STK Proactive commands.
   * STK Proactive commands.
Line 580: Line 578:
   */
   */
   const unsigned short STK_CMD_REFRESH              = 0x01;
   const unsigned short STK_CMD_REFRESH              = 0x01;
  const unsigned short STK_CMD_POLL_INTERVAL        = 0x03;
  const unsigned short STK_CMD_POLL_OFF              = 0x04;
  const unsigned short STK_CMD_SET_UP_EVENT_LIST    = 0x05;
   const unsigned short STK_CMD_SET_UP_CALL          = 0x10;
   const unsigned short STK_CMD_SET_UP_CALL          = 0x10;
   const unsigned short STK_CMD_SEND_SS              = 0x11;
   const unsigned short STK_CMD_SEND_SS              = 0x11;
Line 586: Line 587:
   const unsigned short STK_CMD_SEND_DTMF            = 0x14;
   const unsigned short STK_CMD_SEND_DTMF            = 0x14;
   const unsigned short STK_CMD_LAUNCH_BROWSER        = 0x15;
   const unsigned short STK_CMD_LAUNCH_BROWSER        = 0x15;
  const unsigned short STK_CMD_PLAY_TONE            = 0x20;
   const unsigned short STK_CMD_DISPLAY_TEXT          = 0x21;
   const unsigned short STK_CMD_DISPLAY_TEXT          = 0x21;
   const unsigned short STK_CMD_GET_INKEY            = 0x22;
   const unsigned short STK_CMD_GET_INKEY            = 0x22;
Line 689: Line 691:
   /** Bearer Independent Protocol error */
   /** Bearer Independent Protocol error */
   const unsigned short STK_RESULT_BIP_ERROR                        = 0x3a;
   const unsigned short STK_RESULT_BIP_ERROR                        = 0x3a;
};
 
  /**
  * STK Event List
  */
  const unsigned short STK_EVENT_TYPE_MT_CALL                          = 0x00;
  const unsigned short STK_EVENT_TYPE_CALL_CONNECTED                  = 0x01;
  const unsigned short STK_EVENT_TYPE_CALL_DISCONNECTED                = 0x02;
  const unsigned short STK_EVENT_TYPE_LOCATION_STATUS                  = 0x03;
  const unsigned short STK_EVENT_TYPE_USER_ACTIVITY                    = 0x04;
  const unsigned short STK_EVENT_TYPE_IDLE_SCREEN_AVAILABLE            = 0x05;
  const unsigned short STK_EVENT_TYPE_CARD_READER_STATUS              = 0x06;
  const unsigned short STK_EVENT_TYPE_LANGUAGE_SELECTION              = 0x07;
  const unsigned short STK_EVENT_TYPE_BROWSER_TERMINATION              = 0x08;
  const unsigned short STK_EVENT_TYPE_DATA_AVAILABLE                  = 0x09;
  const unsigned short STK_EVENT_TYPE_CHANNEL_STATUS                  = 0x0a;
  const unsigned short STK_EVENT_TYPE_SINGLE_ACCESS_TECHNOLOGY_CHANGED = 0x0b;
  const unsigned short STK_EVENT_TYPE_DISPLAY_PARAMETER_CHANGED        = 0x0c;
  const unsigned short STK_EVENT_TYPE_LOCAL_CONNECTION                = 0x0d;
  const unsigned short STK_EVENT_TYPE_NETWORK_SEARCH_MODE_CHANGED      = 0x0e;
  const unsigned short STK_EVENT_TYPE_BROWSING_STATUS                  = 0x0f;
  const unsigned short STK_EVENT_TYPE_FRAMES_INFORMATION_CHANGED      = 0x10;
 
  /**
    * The service state of STK Location Status.
    */
  const unsigned short STK_SERVICE_STATE_NORMAL      = 0x00;
  const unsigned short STK_SERVICE_STATE_LIMITED    = 0x01;
  const unsigned short STK_SERVICE_STATE_UNAVAILABLE = 0x02;
 
  /**
  * Tone type.
  */
  const unsigned short STK_TONE_TYPE_DIAL_TONE                = 0x01;
  const unsigned short STK_TONE_TYPE_CALLED_SUBSCRIBER_BUSY  = 0x02;
  const unsigned short STK_TONE_TYPE_CONGESTION              = 0x03;
  const unsigned short STK_TONE_TYPE_RADIO_PATH_ACK          = 0x04;
  const unsigned short STK_TONE_TYPE_RADIO_PATH_NOT_AVAILABLE = 0x05;
  const unsigned short STK_TONE_TYPE_ERROR                    = 0x06;
  const unsigned short STK_TONE_TYPE_CALL_WAITING_TONE        = 0x07;
  const unsigned short STK_TONE_TYPE_RINGING_TONE            = 0x08;
  const unsigned short STK_TONE_TYPE_GENERAL_BEEP            = 0x10;
  const unsigned short STK_TONE_TYPE_POSITIVE_ACK_TONE        = 0x11;
  const unsigned short STK_TONE_TYPE_NEGATIVE_ACK_TONE        = 0x12;
 
  /**
  * Time unit
  */
  const unsigned short STK_TIME_UNIT_MINUTE      = 0x00;
  const unsigned short STK_TIME_UNIT_SECOND      = 0x01;
  const unsigned short STK_TIME_UNIT_TENTH_SECOND = 0x02;
}
</pre>
</pre>


Line 696: Line 748:
<pre>
<pre>
var icc = navigator.mozMobileConnection.icc;
var icc = navigator.mozMobileConnection.icc;
icc.onstkcommand = function (command) {
icc.onstkcommand = function (evt) {
  var command = evt.command
   switch (command.typeOfCommand) {
   switch (command.typeOfCommand) {
     case icc.STK_CMD_SET_UP_MENU:
     case icc.STK_CMD_SET_UP_MENU:
Line 708: Line 761:
== Menu Selection ==  
== Menu Selection ==  
<pre>
<pre>
function menuSelection(id, helpRequested) {
/**
   mozIcc.sendMenuSelection(id, helpRequested);
* onMenuSelected is the callback when some item of the menu is selected.
* @param id    The index of the item being selected.
* @param helpRequested    Request for help.
*/
function onMenuSelected(id, helpRequested) {
   var icc = navigator.mozMobileConnection.icc;
  icc.sendStkMenuSelection(id, helpRequested);
}
}
</pre>
</pre>
Line 717: Line 776:
// 'command' is got from onstkcommand
// 'command' is got from onstkcommand
// and assume it's a Select Item command.
// and assume it's a Select Item command.
var icc = navigator.mozMobileConnection.icc;
var response = {
var response = {
  commandNumber: command.commandNumber,
   resultCode : icc.STK_RESULT_OK,
  typeOfCommandL command.typeOfCommand,
   // 'id' is got from the choosed item identifier (menu.item[].identifier)
  commandQualifier: command.commandQualifier,
   resultCode : mozICC.STK_RESULT_OK,
   // 'id' is got from the chosen item identifier (menu.item[].identifier)
   itemIdentifier: id
   itemIdentifier: id
};
};
mozIcc.sendStkResponse(response);
mozIcc.sendStkResponse(command, response);
</pre>
</pre>


== Get Input ==
== Get Input ==
<pre>
<pre>
mozIcc.onstkcommand = function (command) {
var icc = navigator.mozMobileConnection.icc;
icc.onstkcommand = function (evt) {
  var command = evt.command
   switch (command.typeOfCommand) {
   switch (command.typeOfCommand) {
     case mozIcc.STK_CMD_GET_INPUT:
     case icc.STK_CMD_GET_INPUT:
       var input = command.options;
       var input = command.options;
       // create a TextInput-like UI according to 'input'
       // create a TextInput-like UI according to 'input'
Line 740: Line 799:


// onTextInput is the callback when user inputs complete.
// onTextInput is the callback when user inputs complete.
var icc = navigator.mozMobileConnection.icc;
function onTextInput(input) {
function onTextInput(input) {
   var response = {
   var response = {
    commandNumber: command.commandNumber,
    typeOfCommandL command.typeOfCommand,
    commandQualifier: command.commandQualifier,
     resultCode : mozICC.STK_RESULT_OK,
     resultCode : mozICC.STK_RESULT_OK,
     input: input
     input: input
   };
   };
   mozIcc.sendStkResponse(response);
   mozIcc.sendStkResponse(command, response);
}
}
</pre>
</pre>
Line 754: Line 811:
= TODO =
= TODO =
* Icon
* Icon
* Duration
* Timer
* Tone
* multi-SIM


= Reference =
= Reference =
Line 762: Line 817:
* TS 102.223
* TS 102.223
* http://www.kandroid.org/online-pdk/guide/stk.html
* http://www.kandroid.org/online-pdk/guide/stk.html
[[Category:Web APIs]]
Chaasof
Confirmed users
1,340

edits

Retrieved from "https://wiki.allizom.org/Special:MobileDiff/471450...1021316"

Navigation menu