1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/dom/mobileconnection/interfaces/nsIDOMMobileConnection.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,698 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this file,
1.6 + * You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +#include "nsIDOMEventTarget.idl"
1.9 +
1.10 +interface nsIDOMEventListener;
1.11 +interface nsIDOMDOMRequest;
1.12 +interface nsIDOMMozMobileConnectionInfo;
1.13 +interface nsIDOMMozMobileNetworkInfo;
1.14 +interface nsIDOMMozMobileCellInfo;
1.15 +interface nsIDOMMozMobileCFInfo;
1.16 +interface nsIVariant;
1.17 +
1.18 +[scriptable, builtinclass, uuid(389ad352-4e43-4c1a-85e9-bae745554326)]
1.19 +interface nsIDOMMozMobileConnection : nsIDOMEventTarget
1.20 +{
1.21 + const long ICC_SERVICE_CLASS_VOICE = (1 << 0);
1.22 + const long ICC_SERVICE_CLASS_DATA = (1 << 1);
1.23 + const long ICC_SERVICE_CLASS_FAX = (1 << 2);
1.24 + const long ICC_SERVICE_CLASS_SMS = (1 << 3);
1.25 + const long ICC_SERVICE_CLASS_DATA_SYNC = (1 << 4);
1.26 + const long ICC_SERVICE_CLASS_DATA_ASYNC = (1 << 5);
1.27 + const long ICC_SERVICE_CLASS_PACKET = (1 << 6);
1.28 + const long ICC_SERVICE_CLASS_PAD = (1 << 7);
1.29 + const long ICC_SERVICE_CLASS_MAX = (1 << 7);
1.30 +
1.31 + /**
1.32 + * Call barring program.
1.33 + *
1.34 + * (0) all outgoing.
1.35 + * (1) outgoing international.
1.36 + * (2) outgoing international except to home country.
1.37 + * (3) all incoming.
1.38 + * (4) incoming when roaming outside the home country.
1.39 + */
1.40 + const long CALL_BARRING_PROGRAM_ALL_OUTGOING = 0;
1.41 + const long CALL_BARRING_PROGRAM_OUTGOING_INTERNATIONAL = 1;
1.42 + const long CALL_BARRING_PROGRAM_OUTGOING_INTERNATIONAL_EXCEPT_HOME = 2;
1.43 + const long CALL_BARRING_PROGRAM_ALL_INCOMING = 3;
1.44 + const long CALL_BARRING_PROGRAM_INCOMING_ROAMING = 4;
1.45 +
1.46 + /**
1.47 + * Calling line identification restriction constants.
1.48 + *
1.49 + * @see 3GPP TS 27.007 7.7 Defined values
1.50 + *
1.51 + * (0) Uses subscription default value.
1.52 + * (1) Restricts CLI presentation.
1.53 + * (2) Allows CLI presentation.
1.54 + */
1.55 + const long CLIR_DEFAULT = 0;
1.56 + const long CLIR_INVOCATION = 1;
1.57 + const long CLIR_SUPPRESSION = 2;
1.58 +
1.59 + /**
1.60 + * These two fields can be accessed by privileged applications with the
1.61 + * 'mobilenetwork' permission.
1.62 + */
1.63 + readonly attribute DOMString lastKnownNetwork;
1.64 + readonly attribute DOMString lastKnownHomeNetwork;
1.65 +
1.66 + /**
1.67 + * Information about the voice connection.
1.68 + */
1.69 + readonly attribute nsIDOMMozMobileConnectionInfo voice;
1.70 +
1.71 + /**
1.72 + * Information about the data connection.
1.73 + */
1.74 + readonly attribute nsIDOMMozMobileConnectionInfo data;
1.75 +
1.76 + /**
1.77 + * Integrated Circuit Card Identifier of the SIM this
1.78 + * mobile connection corresponds to.
1.79 + */
1.80 + readonly attribute DOMString iccId;
1.81 +
1.82 + /**
1.83 + * The selection mode of the voice and data networks.
1.84 + *
1.85 + * Possible values: null (unknown), 'automatic', 'manual'
1.86 + */
1.87 + readonly attribute DOMString networkSelectionMode;
1.88 +
1.89 + /**
1.90 + * The current radio state.
1.91 + *
1.92 + * Possible values: null (unknown), 'enabling', 'enabled', 'disabling',
1.93 + * 'disabled'
1.94 + */
1.95 + readonly attribute DOMString radioState;
1.96 +
1.97 + /**
1.98 + * Array of network types that are supported by this radio.
1.99 + *
1.100 + * Possible values: 'gsm', 'wcdma', 'cdma', 'evdo', 'lte'
1.101 + */
1.102 + readonly attribute nsIVariant supportedNetworkTypes;
1.103 +
1.104 + /**
1.105 + * Search for available networks.
1.106 + *
1.107 + * If successful, the request's onsuccess will be called, and the request's
1.108 + * result will be an array of nsIDOMMozMobileNetworkInfo.
1.109 + *
1.110 + * Otherwise, the request's onerror will be called, and the request's error
1.111 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.112 + * or 'GenericFailure'.
1.113 + */
1.114 + nsIDOMDOMRequest getNetworks();
1.115 +
1.116 + /**
1.117 + * Manually selects the passed in network, overriding the radio's current
1.118 + * selection.
1.119 + *
1.120 + * If successful, the request's onsuccess will be called.
1.121 + * Note: If the network was actually changed by this request,
1.122 + * the 'voicechange' and 'datachange' events will also be fired.
1.123 + *
1.124 + * Otherwise, the request's onerror will be called, and the request's error
1.125 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.126 + * 'IllegalSIMorME', or 'GenericFailure'
1.127 + */
1.128 + nsIDOMDOMRequest selectNetwork(in nsIDOMMozMobileNetworkInfo network);
1.129 +
1.130 + /**
1.131 + * Tell the radio to automatically select a network.
1.132 + *
1.133 + * If successful, the request's onsuccess will be called.
1.134 + * Note: If the network was actually changed by this request, the
1.135 + * 'voicechange' and 'datachange' events will also be fired.
1.136 + *
1.137 + * Otherwise, the request's onerror will be called, and the request's error
1.138 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.139 + * 'IllegalSIMorME', or 'GenericFailure'
1.140 + */
1.141 + nsIDOMDOMRequest selectNetworkAutomatically();
1.142 +
1.143 + /**
1.144 + * Set preferred network type
1.145 + *
1.146 + * @param type
1.147 + * DOMString indicates the desired preferred network type.
1.148 + * Possible values: 'wcdma/gsm', 'gsm', 'wcdma', 'wcdma/gsm-auto',
1.149 + * 'cdma/evdo', 'cdma', 'evdo', 'wcdma/gsm/cdma/evdo',
1.150 + * 'lte/cdma/evdo', 'lte/wcdma/gsm',
1.151 + * 'lte/wcdma/gsm/cdma/evdo' or 'lte'.
1.152 + *
1.153 + * If successful, the request's onsuccess will be called.
1.154 + *
1.155 + * Otherwise, the request's onerror will be called, and the request's error
1.156 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.157 + * 'InvalidParameter', 'ModeNotSupported' or 'GenericFailure'
1.158 + *
1.159 + * TODO: param "type" should be a WebIDL enum when this interface is converted
1.160 + * to WebIDL
1.161 + */
1.162 + nsIDOMDOMRequest setPreferredNetworkType(in DOMString type);
1.163 +
1.164 + /**
1.165 + * Query current preferred network type
1.166 + *
1.167 + * If successful, the request's onsuccess will be called. And the request's
1.168 + * result will be a string indicating the current preferred network type.
1.169 + * The value will be either 'wcdma/gsm', 'gsm', 'wcdma', 'wcdma/gsm-auto',
1.170 + * 'cdma/evdo', 'cdma', 'evdo', 'wcdma/gsm/cdma/evdo', 'lte/cdma/evdo',
1.171 + * 'lte/wcdma/gsm', 'lte/wcdma/gsm/cdma/evdo' or 'lte'.
1.172 + *
1.173 + * Otherwise, the request's onerror will be called, and the request's error
1.174 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.175 + * or 'GenericFailure'
1.176 + */
1.177 + nsIDOMDOMRequest getPreferredNetworkType();
1.178 +
1.179 + /**
1.180 + * Set roaming preference
1.181 + *
1.182 + * @param mode
1.183 + * DOMString indicates the desired roaming preference.
1.184 + * Possible values: 'home', 'affiliated', or 'any'.
1.185 + *
1.186 + * If successful, the request's onsuccess will be called.
1.187 + *
1.188 + * Otherwise, the request's onerror will be called, and the request's error
1.189 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.190 + * 'IllegalSIMorME', 'InvalidParameter', or 'GenericFailure'
1.191 + *
1.192 + * TODO: param "mode" should be a WebIDL enum when this interface is converted
1.193 + * to WebIDL
1.194 + */
1.195 + nsIDOMDOMRequest setRoamingPreference(in DOMString mode);
1.196 +
1.197 + /**
1.198 + * Query current roaming preference
1.199 + *
1.200 + * If successful, the request's onsuccess will be called. And the request's
1.201 + * result will be a string indicating the current roaming preference.
1.202 + * The value will be either 'home', 'affiliated', or 'any'.
1.203 + *
1.204 + * Otherwise, the request's onerror will be called, and the request's error
1.205 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.206 + * 'IllegalSIMorME', or 'GenericFailure'
1.207 + */
1.208 + nsIDOMDOMRequest getRoamingPreference();
1.209 +
1.210 + /**
1.211 + * Set voice privacy preference.
1.212 + *
1.213 + * @param enabled
1.214 + * Boolean indicates the preferred voice privacy mode used in voice
1.215 + * scrambling in CDMA networks. 'True' means the enhanced voice security
1.216 + * is required.
1.217 + *
1.218 + * If successful, the request's onsuccess will be called.
1.219 + *
1.220 + * Otherwise, the request's onerror will be called, and the request's error
1.221 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.222 + * 'IllegalSIMorME', 'InvalidParameter', or 'GenericFailure'
1.223 + */
1.224 + nsIDOMDOMRequest setVoicePrivacyMode(in bool enabled);
1.225 +
1.226 + /**
1.227 + * Query current voice privacy mode.
1.228 + *
1.229 + * If successful, the request's onsuccess will be called. And the request's
1.230 + * result will be a boolean indicating the current voice privacy mode.
1.231 + *
1.232 + * Otherwise, the request's onerror will be called, and the request's error
1.233 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.234 + * 'IllegalSIMorME', or 'GenericFailure'
1.235 + */
1.236 + nsIDOMDOMRequest getVoicePrivacyMode();
1.237 +
1.238 + /**
1.239 + * Send a MMI message.
1.240 + *
1.241 + * @param mmi
1.242 + * DOMString containing an MMI string that can be associated to a
1.243 + * USSD request or other RIL functionality.
1.244 + *
1.245 + * @return a nsIDOMDOMRequest
1.246 + * The request's result will be an object containing information
1.247 + * about the operation.
1.248 + *
1.249 + * In case that the MMI code requires sending an USSD request, the DOMrequest
1.250 + * 'success' event means that the RIL has successfully processed and sent the
1.251 + * USSD request to the network. The network reply will be reported via
1.252 + * 'onussdreceived' event. If the MMI code is not associated to a USSD but to
1.253 + * other RIL request its result, if one is needed, will be notified via the
1.254 + * returned DOMRequest 'success' or 'error' event.
1.255 + */
1.256 + nsIDOMDOMRequest sendMMI(in DOMString mmi);
1.257 +
1.258 + /**
1.259 + * Cancel the current MMI request if one exists.
1.260 + */
1.261 + nsIDOMDOMRequest cancelMMI();
1.262 +
1.263 + /**
1.264 + * Configures call forward options.
1.265 + *
1.266 + * @param CFInfo
1.267 + * An object containing the call forward rule to set.
1.268 + *
1.269 + * If successful, the request's onsuccess will be called.
1.270 + *
1.271 + * Otherwise, the request's onerror will be called, and the request's error
1.272 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.273 + * 'IllegalSIMorME', 'InvalidParameter', or 'GenericFailure'
1.274 + */
1.275 + nsIDOMDOMRequest setCallForwardingOption(in nsIDOMMozMobileCFInfo CFInfo);
1.276 +
1.277 + /**
1.278 + * Queries current call forward options.
1.279 + *
1.280 + * @param reason
1.281 + * Indicates the reason the call is being forwarded. It will be either
1.282 + * unconditional (0), mobile busy (1), no reply (2), not reachable (3),
1.283 + * all call forwarding (4), or all conditional call forwarding (5).
1.284 + *
1.285 + * If successful, the request's onsuccess will be called, and the request's
1.286 + * result will be an array of nsIDOMMozMobileCFInfo.
1.287 + *
1.288 + * Otherwise, the request's onerror will be called, and the request's error
1.289 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.290 + * 'InvalidParameter', or 'GenericFailure'.
1.291 + */
1.292 + nsIDOMDOMRequest getCallForwardingOption(in unsigned short reason);
1.293 +
1.294 + /**
1.295 + * Configures call barring option.
1.296 + *
1.297 + * @param option
1.298 + * An object containing the call barring rule to set.
1.299 + * @see MozCallBarringOption for the detail of info.
1.300 + *
1.301 + * If successful, the request's onsuccess will be called.
1.302 + *
1.303 + * Otherwise, the request's onerror will be called, and the request's error
1.304 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.305 + * 'IllegalSIMorME', 'InvalidParameter', or 'GenericFailure'
1.306 + */
1.307 + nsIDOMDOMRequest setCallBarringOption(in jsval option);
1.308 +
1.309 + /**
1.310 + * Queries current call barring status.
1.311 + *
1.312 + * @param info
1.313 + * An object containing the call barring rule to query. No need to
1.314 + * specify 'enabled' property.
1.315 + * @see MozCallBarringOption for the detail of info.
1.316 + *
1.317 + * If successful, the request's onsuccess will be called, and the request's
1.318 + * result will be an object of MozCallBarringOption with correct 'enabled'
1.319 + * property indicating the status of this rule.
1.320 + *
1.321 + * Otherwise, the request's onerror will be called, and the request's error
1.322 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.323 + * 'InvalidParameter', or 'GenericFailure'.
1.324 + */
1.325 + nsIDOMDOMRequest getCallBarringOption(in jsval option);
1.326 +
1.327 + /**
1.328 + * Change call barring facility password.
1.329 + *
1.330 + * @param info
1.331 + * An object containing information about pin and newPin, and,
1.332 + * this object must have both "pin" and "newPin" attributes
1.333 + * to change the call barring facility password.
1.334 + *
1.335 + * Example:
1.336 + *
1.337 + * changeCallBarringPassword({pin: "...",
1.338 + * newPin: "..."});
1.339 + */
1.340 + nsIDOMDOMRequest changeCallBarringPassword(in jsval info);
1.341 +
1.342 + /**
1.343 + * Configures call waiting options.
1.344 + *
1.345 + * @param enabled
1.346 + * Value containing the desired call waiting status.
1.347 + *
1.348 + * If successful, the request's onsuccess will be called.
1.349 + *
1.350 + * Otherwise, the request's onerror will be called, and the request's error
1.351 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.352 + * 'IllegalSIMorME', or 'GenericFailure'
1.353 + */
1.354 + nsIDOMDOMRequest setCallWaitingOption(in bool enabled);
1.355 +
1.356 + /**
1.357 + * Queries current call waiting options.
1.358 + *
1.359 + * If successful, the request's onsuccess will be called, and the request's
1.360 + * result will be a boolean indicating the call waiting status.
1.361 + *
1.362 + *
1.363 + * Otherwise, the request's onerror will be called, and the request's error
1.364 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.365 + * or 'GenericFailure'.
1.366 + */
1.367 + nsIDOMDOMRequest getCallWaitingOption();
1.368 +
1.369 + /**
1.370 + * Enables or disables the presentation of the calling line identity (CLI) to
1.371 + * the called party when originating a call.
1.372 + *
1.373 + * @param clirMode
1.374 + * Is one of the CLIR_* constants.
1.375 + *
1.376 + * If successful, the request's onsuccess will be called.
1.377 + *
1.378 + * Otherwise, the request's onerror will be called, and the request's error
1.379 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.380 + */
1.381 + nsIDOMDOMRequest setCallingLineIdRestriction(in unsigned short clirMode);
1.382 +
1.383 + /**
1.384 + * Queries current CLIR status.
1.385 + *
1.386 + * If successful, the request's onsuccess will be called, and the request's
1.387 + * result will be a DOMCLIRStatus dictionary containing CLIR 'n' and 'm'
1.388 + * parameter.
1.389 + *
1.390 + * Otherwise, the request's onerror will be called, and the request's error
1.391 + * will be either 'RadioNotAvailable', 'RequestNotSupported',
1.392 + * or 'GenericFailure'.
1.393 + */
1.394 + nsIDOMDOMRequest getCallingLineIdRestriction();
1.395 +
1.396 + /**
1.397 + * Exit emergency callback mode.
1.398 + *
1.399 + * If successful, the request's onsuccess will be called.
1.400 + *
1.401 + * Otherwise, the request's onerror will be called, and the request's error
1.402 + * will be either 'RequestNotSupported' or 'GenericFailure'.
1.403 + */
1.404 + nsIDOMDOMRequest exitEmergencyCbMode();
1.405 +
1.406 + /**
1.407 + * Set radio enabled/disabled.
1.408 + *
1.409 + * @param enabled
1.410 + * True to enable the radio.
1.411 + *
1.412 + * If successful, the request's onsuccess will be called.
1.413 + *
1.414 + * Otherwise, the request's onerror will be called, and the request's error
1.415 + * will be either 'InvalidStateError', 'RadioNotAvailable', or
1.416 + * 'GenericFailure'.
1.417 + *
1.418 + * Note: Request is not available when radioState is null, 'enabling', or
1.419 + * 'disabling'. Calling the function in above conditions will receive
1.420 + * 'InvalidStateError' error.
1.421 + */
1.422 + nsIDOMDOMRequest setRadioEnabled(in boolean enabled);
1.423 +
1.424 + /**
1.425 + * The 'voicechange' event is notified whenever the voice connection object
1.426 + * changes.
1.427 + */
1.428 + [implicit_jscontext] attribute jsval onvoicechange;
1.429 +
1.430 + /**
1.431 + * The 'datachange' event is notified whenever the data connection object
1.432 + * changes values.
1.433 + */
1.434 + [implicit_jscontext] attribute jsval ondatachange;
1.435 +
1.436 + /**
1.437 + * The 'ussdreceived' event is notified whenever a new USSD message is
1.438 + * received.
1.439 + */
1.440 + [implicit_jscontext] attribute jsval onussdreceived;
1.441 +
1.442 + /**
1.443 + * The 'dataerror' event is notified whenever the data connection object
1.444 + * receives an error from the RIL
1.445 + */
1.446 + [implicit_jscontext] attribute jsval ondataerror;
1.447 +
1.448 + /**
1.449 + * The 'oncfstatechange' event is notified whenever the call forwarding
1.450 + * state changes.
1.451 + */
1.452 + [implicit_jscontext] attribute jsval oncfstatechange;
1.453 +
1.454 + /**
1.455 + * The 'emergencycbmodechange' event is notified whenever the emergency
1.456 + * callback mode changes.
1.457 + */
1.458 + [implicit_jscontext] attribute jsval onemergencycbmodechange;
1.459 +
1.460 + /**
1.461 + * The 'onotastatuschange' event is notified whenever the ota provision status
1.462 + * changes.
1.463 + */
1.464 + [implicit_jscontext] attribute jsval onotastatuschange;
1.465 +
1.466 + /**
1.467 + * The 'oniccchange' event is notified whenever the iccid value
1.468 + * changes.
1.469 + */
1.470 + [implicit_jscontext] attribute jsval oniccchange;
1.471 +
1.472 + /**
1.473 + * The 'onradiostatechange' event is notified whenever the radio state
1.474 + * changes.
1.475 + */
1.476 + [implicit_jscontext] attribute jsval onradiostatechange;
1.477 +};
1.478 +
1.479 +[scriptable, uuid(49706beb-a160-40b7-b745-50f62e389a2c)]
1.480 +interface nsIDOMMozMobileConnectionInfo : nsISupports
1.481 +{
1.482 + /**
1.483 + * State of the connection.
1.484 + *
1.485 + * Possible values: 'notSearching', 'searching', 'denied', 'registered'.
1.486 + * null if the state is unknown.
1.487 + */
1.488 + readonly attribute DOMString state;
1.489 +
1.490 + /**
1.491 + * Indicates whether the connection is ready. This may be different
1.492 + */
1.493 + readonly attribute bool connected;
1.494 +
1.495 + /**
1.496 + * Indicates whether only emergency calls are possible.
1.497 + *
1.498 + * This flag is only relevant to voice connections and when 'connected' is
1.499 + * false.
1.500 + */
1.501 + readonly attribute bool emergencyCallsOnly;
1.502 +
1.503 + /**
1.504 + * Indicates whether the connection is going through a foreign operator
1.505 + * (roaming) or not.
1.506 + */
1.507 + readonly attribute bool roaming;
1.508 +
1.509 + /**
1.510 + * Network operator
1.511 + */
1.512 + readonly attribute nsIDOMMozMobileNetworkInfo network;
1.513 +
1.514 + /**
1.515 + * Type of connection.
1.516 + *
1.517 + * Possible values: 'gsm', 'cdma', gprs', 'edge', 'umts', 'hsdpa', 'evdo0',
1.518 + * 'evdoa', 'evdob', etc.
1.519 + */
1.520 + readonly attribute DOMString type;
1.521 +
1.522 + /**
1.523 + * Signal strength in dBm, or null if no service is available.
1.524 + */
1.525 + readonly attribute jsval signalStrength;
1.526 +
1.527 + /**
1.528 + * Signal strength, represented linearly as a number between 0 (weakest
1.529 + * signal) and 100 (full signal).
1.530 + */
1.531 + readonly attribute jsval relSignalStrength;
1.532 +
1.533 + /**
1.534 + * Cell location.
1.535 + */
1.536 + readonly attribute nsIDOMMozMobileCellInfo cell;
1.537 +
1.538 +};
1.539 +
1.540 +[scriptable, uuid(40018fc7-4c42-47b6-8de6-3591a9c622bc)]
1.541 +interface nsIDOMMozMobileNetworkInfo: nsISupports
1.542 +{
1.543 + /**
1.544 + * Short name of the network operator
1.545 + */
1.546 + readonly attribute DOMString shortName;
1.547 +
1.548 + /**
1.549 + * Long name of the network operator
1.550 + */
1.551 + readonly attribute DOMString longName;
1.552 +
1.553 + /**
1.554 + * Mobile Country Code (MCC) of the network operator
1.555 + */
1.556 + readonly attribute DOMString mcc;
1.557 +
1.558 + /**
1.559 + * Mobile Network Code (MNC) of the network operator
1.560 + */
1.561 + readonly attribute DOMString mnc;
1.562 +
1.563 + /**
1.564 + * State of this network operator.
1.565 + *
1.566 + * Possible values: 'available', 'connected', 'forbidden', or null (unknown)
1.567 + */
1.568 + readonly attribute DOMString state;
1.569 +};
1.570 +
1.571 +[scriptable, uuid(9750b3a7-d913-436e-95d4-7ef2973ec6a1)]
1.572 +interface nsIDOMMozMobileCellInfo: nsISupports
1.573 +{
1.574 + /**
1.575 + * Mobile Location Area Code (LAC) for GSM/WCDMA networks.
1.576 + *
1.577 + * Possible ranges from 0x0000 to 0xffff.
1.578 + * -1 if the LAC is unknown.
1.579 + */
1.580 + readonly attribute long gsmLocationAreaCode;
1.581 +
1.582 + /**
1.583 + * Mobile Cell ID for GSM/WCDMA networks.
1.584 + *
1.585 + * Possible ranges from 0x00000000 to 0xffffffff.
1.586 + * -1 if the cell id is unknown.
1.587 + */
1.588 + readonly attribute long long gsmCellId;
1.589 +
1.590 + /**
1.591 + * Base Station ID for CDMA networks.
1.592 + *
1.593 + * Possible ranges from 0 to 65535
1.594 + * -1 if the base station id is unknown.
1.595 + */
1.596 + readonly attribute long cdmaBaseStationId;
1.597 +
1.598 + /**
1.599 + * Base Station Latitude for CDMA networks.
1.600 + *
1.601 + * Possible ranges from -1296000 to 1296000.
1.602 + * -2147483648 if the latitude is unknown.
1.603 + *
1.604 + * @see 3GPP2 C.S0005-A v6.0.
1.605 + */
1.606 + readonly attribute long cdmaBaseStationLatitude;
1.607 +
1.608 + /**
1.609 + * Base Station Longitude for CDMA networks.
1.610 + *
1.611 + * Possible ranges from -2592000 to 2592000.
1.612 + * -2147483648 if the longitude is unknown.
1.613 + *
1.614 + * @see 3GPP2 C.S0005-A v6.0.
1.615 + */
1.616 + readonly attribute long cdmaBaseStationLongitude;
1.617 +
1.618 + /**
1.619 + * System ID for CDMA networks.
1.620 + *
1.621 + * Possible ranges from 0 to 32767.
1.622 + * -1 if the system id is unknown.
1.623 + */
1.624 + readonly attribute long cdmaSystemId;
1.625 +
1.626 + /**
1.627 + * Network ID for CDMA networks.
1.628 + *
1.629 + * Possible ranges from 0 to 65535.
1.630 + * -1 if the network id is unknown.
1.631 + */
1.632 + readonly attribute long cdmaNetworkId;
1.633 +};
1.634 +
1.635 +[scriptable, uuid(d1b35ad8-99aa-47cc-ab49-2e72b00e39df)]
1.636 +interface nsIDOMMozMobileCFInfo : nsISupports
1.637 +{
1.638 + /**
1.639 + * Call forwarding rule status.
1.640 + *
1.641 + * It will be either not active (false), or active (true).
1.642 + *
1.643 + * Note: Unused for setting call forwarding options. It reports
1.644 + * the status of the rule when getting how the rule is
1.645 + * configured.
1.646 + *
1.647 + * @see 3GPP TS 27.007 7.11 "status".
1.648 + */
1.649 + readonly attribute bool active;
1.650 +
1.651 + const long CALL_FORWARD_ACTION_DISABLE = 0;
1.652 + const long CALL_FORWARD_ACTION_ENABLE = 1;
1.653 + const long CALL_FORWARD_ACTION_QUERY_STATUS = 2;
1.654 + const long CALL_FORWARD_ACTION_REGISTRATION = 3;
1.655 + const long CALL_FORWARD_ACTION_ERASURE = 4;
1.656 +
1.657 + /**
1.658 + * Indicates what to do with the rule.
1.659 + *
1.660 + * One of the CALL_FORWARD_ACTION_* constants. It will be either disable (0),
1.661 + * enable (1), query status (2), registration (3), or erasure (4).
1.662 + *
1.663 + * @see 3GPP TS 27.007 7.11 "mode".
1.664 + */
1.665 + readonly attribute unsigned short action;
1.666 +
1.667 + const long CALL_FORWARD_REASON_UNCONDITIONAL = 0;
1.668 + const long CALL_FORWARD_REASON_MOBILE_BUSY = 1;
1.669 + const long CALL_FORWARD_REASON_NO_REPLY = 2;
1.670 + const long CALL_FORWARD_REASON_NOT_REACHABLE = 3;
1.671 + const long CALL_FORWARD_REASON_ALL_CALL_FORWARDING = 4;
1.672 + const long CALL_FORWARD_REASON_ALL_CONDITIONAL_CALL_FORWARDING = 5;
1.673 +
1.674 + /**
1.675 + * Indicates the reason the call is being forwarded.
1.676 + *
1.677 + * One of the CALL_FORWARD_REASON_* constants. It will be either
1.678 + * unconditional (0), mobile busy (1), no reply (2), not reachable (3),
1.679 + * all call forwarding (4), or all conditional call forwarding (5).
1.680 + *
1.681 + * @see 3GPP TS 27.007 7.11 "reason".
1.682 + */
1.683 + readonly attribute unsigned short reason;
1.684 +
1.685 + /**
1.686 + * Phone number of forwarding address.
1.687 + */
1.688 + readonly attribute DOMString number;
1.689 +
1.690 + /**
1.691 + * When "no reply" is enabled or queried, this gives the time in
1.692 + * seconds to wait before call is forwarded.
1.693 + */
1.694 + readonly attribute unsigned short timeSeconds;
1.695 +
1.696 + /**
1.697 + * Service for which the call forward is set up. It should be one of the
1.698 + * nsIDOMMozMobileConnection.ICC_SERVICE_CLASS_* values.
1.699 + */
1.700 + readonly attribute unsigned short serviceClass;
1.701 +};
