From 0436d7f6a9f6956a68ed0316cb0419bc2e14ef30 Mon Sep 17 00:00:00 2001 From: Andrzej Popowski Date: Tue, 26 Jan 2016 10:54:02 +0100 Subject: [PATCH] [Systeminfo] - upgrade of API Reference and Programming Guide Change-Id: Ice4cedfc95841b7f6b6d786669eb0269833c2162 Signed-off-by: Andrzej Popowski --- .../html/web/tizen/system/system_info_w.htm | 12 ++- .../html/device_api/mobile/tizen/systeminfo.html | 101 ++++++++++++++++----- .../html/device_api/wearable/tizen/systeminfo.html | 92 +++++++++++++++---- 3 files changed, 162 insertions(+), 43 deletions(-) diff --git a/org.tizen.guides/html/web/tizen/system/system_info_w.htm b/org.tizen.guides/html/web/tizen/system/system_info_w.htm index 12a41b7..d6b4256 100644 --- a/org.tizen.guides/html/web/tizen/system/system_info_w.htm +++ b/org.tizen.guides/html/web/tizen/system/system_info_w.htm @@ -171,6 +171,16 @@ tr.images td { Provides information about the cellular network. With this property, you can, for example, retrieve the network details that allow your application to access the network. + SystemInfoEthernetNetwork (in mobile applications) + ETHERNET_NETWORK + Provides information about the ethernet network. With this property, you can, for example, retrieve the network details that allow your application to access the network. + + + SystemInfoNetProxyNetwork (in mobile and wearable applications) + NET_PROXY_NETWORK + Provides information about the proxy type network. With this property, you can, for example, retrieve the network details that allow your application to access the network. + + SystemInfoSIM (in mobile and wearable applications) SIM Provides information about the device SIM card, such as the operator name and the mobile country code (MCC). @@ -225,4 +235,4 @@ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga - \ No newline at end of file + diff --git a/org.tizen.web.apireference/html/device_api/mobile/tizen/systeminfo.html b/org.tizen.web.apireference/html/device_api/mobile/tizen/systeminfo.html index 852eecd..23c6aab 100644 --- a/org.tizen.web.apireference/html/device_api/mobile/tizen/systeminfo.html +++ b/org.tizen.web.apireference/html/device_api/mobile/tizen/systeminfo.html @@ -49,6 +49,8 @@ SIM
  • STORAGE
  • +NET_PROXY_NETWORK (Since: 3.0)
    • +
  • WIFI_NETWORK

    • @@ -68,6 +70,9 @@ Not all above properties may be available on every Tizen device. For instance, a

  • SIM - tizen.systeminfo.getCapability("http://tizen.org/feature/network.telephony")
  • +NET_PROXY_NETWORK - tizen.systeminfo.getCapability("http://tizen.org/feature/network.net_proxy" +)
    • +
  • WIFI_NETWORK - tizen.systeminfo.getCapability("http://tizen.org/feature/network.wifi")

    • @@ -134,13 +139,15 @@ For more information on the SystemInfo features, see SystemInfoCellularNetwork -

  • 2.20. SystemInfoSIM +
  • 2.20. SystemInfoNetProxyNetwork +
    • +
  • 2.21. SystemInfoSIM
    • -
  • 2.21. SystemInfoPeripheral +
  • 2.22. SystemInfoPeripheral
    • -
  • 2.22. SystemInfoMemory +
  • 2.23. SystemInfoMemory
    • -
  • 2.23. SystemInfoCameraFlash +
  • 2.24. SystemInfoCameraFlash
    • @@ -247,6 +254,10 @@ For more information on the SystemInfo features, see SystemInfoNetProxyNetwork + + + SystemInfoPeripheral @@ -267,7 +278,7 @@ For more information on the SystemInfo features, see The device property identifier. -
      enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };
    +
      enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };

    Since: 2.0 @@ -284,17 +295,23 @@ For more information on the SystemInfo features, see Remark : MEMORY is supported since Tizen 2.3

    +

    Remark : + NET_PROXY_NETWORK is supported since Tizen 3.0 +

    1.2. SystemInfoNetworkType

    Data Network Type.
    -
      enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "UNKNOWN" };
    +
      enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "NET_PROXY", "UNKNOWN" };

    Since: 2.0 -

    +

    +

    Remark : +NET_PROXY is supported since Tizen 3.0 +

    1.3. SystemInfoDeviceOrientationStatus

    @@ -372,9 +389,9 @@ upside down, in other words rotated 180 degrees
    Device Profile.
    -

    Deprecated. +

    Deprecated. "MOBILE_FULL" and "MOBILE_WEB" are deprecated since 2.3. Beginning with Tizen 2.3, "MOBILE" is returned instead of "MOBILE_FULL". -

    + 

      enum SystemInfoProfile { "MOBILE_FULL", "MOBILE_WEB", "MOBILE", "WEARABLE" };

    Since: @@ -530,9 +547,9 @@ and for subscribing notifications of system information changes.

    Gets the capabilities of the device.
    -

    Deprecated. +

    Deprecated. Deprecated since 2.3. Instead, use getCapability(). -

    + 

    SystemInfoDeviceCapability getCapabilities();

    @@ -930,7 +947,7 @@ NotSupportedError - If the given property is not supported. (since Ti

  • options [optional] [nullable]: - An object containing the various options for fetching the properties requested. See details. + An object containing the various options for fetching the properties requested. See details.
  • errorCallback [optional] [nullable]: @@ -1119,9 +1136,9 @@ parameters contain an invalid value.
    SystemInfoDeviceCapability object.
    -

    Deprecated. +

    Deprecated. Deprecated since 2.3. Instead, use getCapability() to query device capabilities. -

    + 

      [NoInterfaceObject] interface SystemInfoDeviceCapability {
     readonly attribute boolean bluetooth;
 
@@ -2385,9 +2402,9 @@ The following values are supported:
 boolean isRemoveable
    
  true if this unit can be removed from the system (such as an sdcard unplugged), false otherwise.
             
    
-
    Deprecated.
+
    Deprecated.
  Deprecated since 2.1. Instead, use isRemovable.
-            
    
+            
    
 
    
             Since: 
  1.0
@@ -3010,8 +3027,34 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
    • +
    +

    2.20. SystemInfoNetProxyNetwork

    +
    +This property reflects the information of the net_proxy network in this system. +
    +
     [NoInterfaceObject] interface SystemInfoNetProxyNetwork : SystemInfoProperty {
+readonly attribute DOMString status;
+};
    +

    +Since: +3.0 +

    +
    +

    Attributes

    +
    • + readonly +DOMString status
      +Represents the status (ON or OFF) of the net_proxy network. +
      +

      +Since: +3.0 +

      +
    +
    +
    -

    2.20. SystemInfoSIM

    +

    2.21. SystemInfoSIM

    This property reflects the information of the SIM card information.
    @@ -3250,7 +3293,7 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
    -

    2.21. SystemInfoPeripheral

    +

    2.22. SystemInfoPeripheral

    This property reflects the peripheral information of the current device.
    @@ -3277,7 +3320,7 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
    -

    2.22. SystemInfoMemory

    +

    2.23. SystemInfoMemory

    This property represents information about the memory state on the device system.
    @@ -3305,7 +3348,7 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
    -

    2.23. SystemInfoCameraFlash

    +

    2.24. SystemInfoCameraFlash

    The SystemInfoCameraFlash provides the way to control the attached the camera flash.
    @@ -3512,15 +3555,23 @@ To guarantee the running of the application on a device which supports Wi-Fi, de

  • http://tizen.org/feature/network.wifi
    • +
    +

    +

    +To guarantee the running of the application on a device which supports network proxy for internet connection, declare the following feature requirements in the config file: +

    +

    +
  • http://tizen.org/feature/network.net_proxy
    • +

    - For more information, see Application Filtering. + For more information, see Application Filtering..

    4. Full WebIDL

    module SystemInfo {
 
-  enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };
+  enum SystemInfoPropertyId { "BATTERY", "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY", "CAMERA_FLASH" };
 
-  enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "UNKNOWN" };
+  enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "NET_PROXY", "UNKNOWN" };
 
   enum SystemInfoDeviceOrientationStatus { "PORTRAIT_PRIMARY", "PORTRAIT_SECONDARY", "LANDSCAPE_PRIMARY", "LANDSCAPE_SECONDARY" };
 
@@ -3841,6 +3892,10 @@ To guarantee the running of the application on a device which supports Wi-Fi, de
     readonly attribute DOMString imei raises(WebAPIException);
   };
 
+  [NoInterfaceObject] interface SystemInfoNetProxyNetwork : SystemInfoProperty {
+    readonly attribute DOMString status;
+  };
+
   [NoInterfaceObject] interface SystemInfoSIM : SystemInfoProperty {
     readonly attribute SystemInfoSimState state raises(WebAPIException);
 
diff --git a/org.tizen.web.apireference/html/device_api/wearable/tizen/systeminfo.html b/org.tizen.web.apireference/html/device_api/wearable/tizen/systeminfo.html
index a227461..441d7cc 100644
--- a/org.tizen.web.apireference/html/device_api/wearable/tizen/systeminfo.html
+++ b/org.tizen.web.apireference/html/device_api/wearable/tizen/systeminfo.html
@@ -17,7 +17,7 @@
 This API also provides interfaces and methods that can retrieve statuses of hardware devices, get the value of selected properties, and subscribe to asynchronous notifications of changes for selected values.
         
    
         
    
-The following provides an overview of the tree data structure:
+Web applications can use this API to access the following system properties:
         
    
         
      
           
    • 
@@ -43,6 +43,8 @@ ETHERNET_NETWORK (Since: 2.4)          
      • 
           
    • 
 CELLULAR_NETWORK          
      • 
           
    • 
+NET_PROXY_NETWORK (Since: 3.0) 
      • 
+			
    • 
 SIM          
      • 
           
    • 
 PERIPHERAL          
      • 
@@ -62,6 +64,8 @@ Not all above properties may be available on every Tizen device. For instance, a
           
    • 
  CELLULAR_NETWORK - tizen.systeminfo.getCapability("http://tizen.org/feature/network.telephony")          
      • 
           
    • 
+ NET_PROXY_NETWORK - tizen.systeminfo.getCapability("http://tizen.org/feature/network.net_proxy") 
      • 
+          
    • 
  SIM              - tizen.systeminfo.getCapability("http://tizen.org/feature/network.telephony")          
      • 
         
    
         
    
@@ -128,11 +132,13 @@ For more information on the SystemInfo features, see SystemInfoCellularNetwork
 
-
  • 2.20. SystemInfoSIM
+
  • 2.20. SystemInfoNetProxyNetwork
+
    • 
+
  • 2.21. SystemInfoSIM
 
    • 
-
  • 2.21. SystemInfoPeripheral
+
  • 2.22. SystemInfoPeripheral
 
    • 
-
  • 2.22. SystemInfoMemory
+
  • 2.23. SystemInfoMemory
 
    • 
 
 
@@ -235,6 +241,10 @@ For more information on the SystemInfo features, see SystemInfoNetProxyNetwork
+
+
+
 SystemInfoSIM
 
 
@@ -255,7 +265,7 @@ For more information on the SystemInfo features, see 
  The device property identifier.
           
-
      enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };
    
+
      enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };
    
 
    
             Since: 
  2.0
@@ -269,16 +279,22 @@ For more information on the SystemInfo features, see  Remark : 
  ETHERNET_NETWORK is supported since Tizen 2.4
           
    
+
     Remark : 
+ NET_PROXY_NETWORK is supported since Tizen 3.0
+          
    
 
 
    
 
    1.2. SystemInfoNetworkType
    
 
    
  Data Network Type.
           
    
-
      enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "UNKNOWN" };
    
+
      enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "NET_PROXY", "UNKNOWN" };
    
 
    
             Since: 
  2.0
+
    
+
     Remark : 
+NET_PROXY is supported since Tizen 3.0
           
    
 
    
 
    
@@ -357,9 +373,9 @@ upside down, in other words rotated 180 degrees              
 
    
  Device Profile.
           
    
-
    Deprecated.
+
    Deprecated.
  "MOBILE_FULL" and "MOBILE_WEB" are deprecated since 2.3. Beginning with Tizen 2.3, "MOBILE" is returned instead of "MOBILE_FULL".
-          
    
+          
    
 
      enum SystemInfoProfile { "MOBILE_FULL", "MOBILE_WEB", "MOBILE", "WEARABLE" };
    
 
    
             Since: 
@@ -515,9 +531,9 @@ and for subscribing notifications of system information changes.
 
    
  Gets the capabilities of the device.
             
    
-
    Deprecated.
+
    Deprecated.
  Deprecated since 2.3. Instead, use getCapability().
-            
    
+            
    
 
    SystemInfoDeviceCapability getCapabilities();
              
    
 
    
@@ -1046,9 +1062,9 @@ parameters contain an invalid value.
 
    
  SystemInfoDeviceCapability object.
           
    
-
    Deprecated.
+
    Deprecated.
  Deprecated since 2.3. Instead, use getCapability() to query device capabilities.
-          
    
+          
    
 
      [NoInterfaceObject] interface SystemInfoDeviceCapability {
     readonly attribute boolean bluetooth;
 
@@ -2312,9 +2328,9 @@ The following values are supported:
 boolean isRemoveable
    
  true if this unit can be removed from the system (such as an sdcard unplugged), false otherwise.
             
    
-
    Deprecated.
+
    Deprecated.
  Deprecated since 2.1. Instead, use isRemovable.
-            
    
+            
    
 
    
             Since: 
  1.0
@@ -2937,8 +2953,34 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
 
 
    
 
+
    
+
    2.20. SystemInfoNetProxyNetwork
    
+
    
+This property reflects the information of the net_proxy network in this system.
+
    
+
     [NoInterfaceObject] interface SystemInfoNetProxyNetwork : SystemInfoProperty {
+  readonly attribute DOMString status;
+};
    
+
    
+Since: 
+3.0
+
    
+
    
+
    Attributes
    
+
    • 
+ readonly
+DOMString status
      
+Represents the status (ON or OFF) of the net_proxy network.
+
      
+
      
+Since: 
+3.0
+
      
+
    
+
    
+
    
 
    
-
    2.20. SystemInfoSIM
    
+
    2.21. SystemInfoSIM
    
 
    
  This property reflects the information of the SIM card information.
           
    
@@ -3177,7 +3219,7 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
 
    
 
 
    
-
    2.21. SystemInfoPeripheral
    
+
    2.22. SystemInfoPeripheral
    
 
    
  This property reflects the peripheral information of the current device.
           
    
@@ -3204,7 +3246,7 @@ identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UM
 
    
 
 
    
-
    2.22. SystemInfoMemory
    
+
    2.23. SystemInfoMemory
    
 
    
  This property represents information about the memory state on the device system.
           
    
@@ -3251,15 +3293,23 @@ To guarantee the running of this application on a device which supports telephon
            
    
 
  • http://tizen.org/feature/network.telephony
    • 
 
+
    
+
    
+            
    
+To guarantee the running of this application on a device which supports net_proxy feature, declare the following feature requirements in the config file:
+            
    
+           
    
+
  • http://tizen.org/feature/network.net_proxy
    • 
+
    
 
    
                     For more information, see Application Filtering.
 
 
    4. Full WebIDL
    
 
    module SystemInfo {
 
-  enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };
+  enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "ETHERNET_NETWORK", "CELLULAR_NETWORK", "NET_PROXY_NETWORK", "SIM", "PERIPHERAL", "MEMORY" };
 
-  enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "UNKNOWN" };
+  enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "NET_PROXY", "UNKNOWN" };
 
   enum SystemInfoDeviceOrientationStatus { "PORTRAIT_PRIMARY", "PORTRAIT_SECONDARY", "LANDSCAPE_PRIMARY", "LANDSCAPE_SECONDARY" };
 
@@ -3580,6 +3630,10 @@ To guarantee the running of this application on a device which supports telephon
     readonly attribute DOMString imei raises(WebAPIException);
   };
 
+  [NoInterfaceObject] interface SystemInfoNetProxyNetwork : SystemInfoProperty {
+    readonly attribute DOMString status;
+  };
+
   [NoInterfaceObject] interface SystemInfoSIM : SystemInfoProperty {
     readonly attribute SystemInfoSimState state raises(WebAPIException);
 
-- 
2.7.4