Network API

Retrieves the device network module version.

DOMString getVersion();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Network plugin module version

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

var version = null;
try {
  version = webapis.network.getVersion();
} catch (e) {
  console.log("getVersion exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != version) {
  console.log("[getVersion] version: " + version);
}

Checks whether the device is connected to a network gateway.

boolean isConnectedToGateway();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• boolean : Boolean value:
  true: Gateway connected
  false: Gateway is not connected

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

var gatewayStatus = null;
try {
  gatewayStatus = webapis.network.isConnectedToGateway();
} catch (e) {
  console.error("isConnectedToGateway exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != gatewayStatus) {
  console.log("[isConnectedToGateway] gatewayStatus: " + gatewayStatus);
}

Retrieves the device's IP configuration mode.

NetworkIpMode getIpMode();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• NetworkIpMode : unsigned long Network IP mode
  "NONE":0
  "STATIC": 1
  "DYNAMIC": 2
  "AUTO": 3
  "FIXED": 4
  "UNKNOWN": 5

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

var ipMode = null;
var retVal = null;
try {
  retVal = webapis.network.getIpMode();
} catch (e) {
  console.log("getIPMode exception [" + e.code + "] message: " + e.message);
}

if (null != retVal) {
  switch(retVal) {
    case webapis.network.NetworkIpMode.STATIC :
    ipMode = "STATIC";
    break;
    case webapis.network.NetworkIpMode.DYNAMIC:
    ipMode = "DYNAMIC";
    break;
    case webapis.network.NetworkIpMode.AUTO :
    ipMode = "AUTO";
    break;
    case webapis.network.NetworkIpMode.FIXED :
    ipMode = "FIXED";
    break;
    case webapis.network.NetworkIpMode.NONE :
    ipMode = "NONE";
    break;
    case webapis.network.NetworkIpMode.UNKNOWN :
    ipMode = "UNKNOWN";
    break;
    default:
    ipMode = "Error";
  }
  console.log("[getIPMode] ipMode: " + ipMode);
}

Retrieves the device's configured subnet mask address.

DOMString getSubnetMask();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Subnet mask address for the currently-configured network
  Example: 255.255.255.0

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var netMask = null;
try {
  netMask = webapis.network.getSubnetMask();
} catch (e) {
  console.log("getSubnetMask exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != netMask) {
  console.log("[getSubnetMask] netMask: " + netMask);
}

Retrieves the device's configured gateway address.

DOMString getGateway();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Gateway address for the currently-configured network
  Example: 192.168.0.1

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var gateway = null;
try {
  gateway = webapis.network.getGateway();
} catch (e) {
  console.log("getGateway exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != gateway) {
  console.log("[getGateway] gateway: " + gateway);
}

Retrieves the network device's MAC address.

DOMString getMac();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString MAC address for the currently-configured network
  Example: 50:B7:A3:C2:96:11

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var mac = null;
try {
  mac = webapis.network.getMac();
} catch (e) {
  console.log("getMAC exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != mac) {
  console.log("[getMAC] mac: " + mac);
}

Retrieves the device's configured DNS address.

DOMString getDns();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString DNS address for the currently-configured network
  Example: 192.168.0.1

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var dns = null;
try {
  dns = webapis.network.getDns();
} catch (e) {
  console.log("getDNS exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != dns) {
  console.log("[getDNS] dns: " + dns);
}

Retrieves the device's configured IP address.

DOMString getIp();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString IP address for the currently-configured network
  Example: 192.168.0.11

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var ip = null;
try {
  ip = webapis.network.getIp();
} catch (e) {
  console.log("getIp exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

if (null != ip) {
  console.log("[getIp] ip: " + ip);
}

Retrieves the device's configured name when device is connected to a network.

DOMString getTVName();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Device Name for any connected network
  Example: Tizen_Device

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 4.0

Code Example :

var tvname = null;
try {
  tvname = webapis.network.getTVName();
} catch (e) {
  console.log("getTVName exception [" + e.code + "] mname: " + e.name + " message: " + e.message);
}

if (null != tvname) {
  console.log("[getTVName] tvname : " + tvname);
}

Retrieves the device's currently-active connection type.

NetworkActiveConnectionType getActiveConnectionType();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• NetworkActiveConnectionType : unsigned long Currently-active network connection type:
  "DISCONNECTED": 0
  "WIFI": 1
  "CELLULAR": 2
  "ETHERNET": 3

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

var connType = null;
var retVal = null;
try {
  retVal = webapis.network.getActiveConnectionType();
} catch (e) {
  console.error("getActiveConnectionType exception [" + e.code + "] message: " + e.message );
}

if (null != retVal) {
  switch(retVal) {
    case webapis.network.NetworkActiveConnectionType.DISCONNECTED :
    connType = "DISCONNECTED";
    break;
    case webapis.network.NetworkActiveConnectionType.WIFI :
    connType = "WIFI";
    break;
    case webapis.network.NetworkActiveConnectionType.CELLULAR :
    connType = "CELLULAR";
    break;
    case webapis.network.NetworkActiveConnectionType.ETHERNET :
    connType = "ETHERNET";
    break;
    default:
    connType = "Error";
  }
  console.log("[getActiveConnectionType] Active Connection Type: "
  + connType);
}

Registers an asynchronous event listener.

unsigned long addNetworkStateChangeListener(NetworkStateChangedCallback listener);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Parameters :

• listener : Callback method. For example: listenerID = network.addNetworkStateChangeListener(onChange);

Return Value :

• unsigned long : unsigned long Application async listener ID

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.

Since : 2.3

Code Example :

var onChange = function(data) {
  console.log("[NetworkStateChangedCallback] data :" + data + " changed");
}
try {
  listenerID = webapis.network.addNetworkStateChangeListener(onChange);
} catch (e) {
  console.log("addNetworkStateChangeListener exception [" + e.code
  + "] name: " + e.name + " message: " + e.message);
}
if (listenerID > -1) {
  console.log("addNetworkStateChangeListener success listener ID ["
  + listenerID + "] ");
}

Unregisters an asynchronous event listener.

void removeNetworkStateChangeListener(unsigned long listenerId);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Parameters :

• listenerId : ListenerID to be removed

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type InvalidValuesError, if the listenerId value is not the same as the value generated by addNetworkStateChangeListener. (Since plugin version 3.0)

Since : 2.3

Code Example :

try {
  console.log("begin removeNetworkStateChangeListener listenerID: " + listenerID);
  webapis.network.removeNetworkStateChangeListener(listenerID);
} catch (e) {
  console.log("removeNetworkStateChangeListener exception [" + e.code
  + "] name: " + e.name + " message: " + e.message);
  return;
}
console.log("removeNetworkStateChangeListener success");

Retrieves the Wi-Fi network SSID. Works only when the active connection type is Wi-Fi.

DOMString getWiFiSsid();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Wi-Fi network SSID
  Example: Strawbarry

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a Wi-Fi connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var WiFiSSID = null;
try {
  WiFiSSID = webapis.network.getWiFiSsid();
} catch (e) {
  console.log("getWiFiSSID exception [" + e.code + "] name: " + e.name
  + " message: " + e.message);
}

if (null != WiFiSSID) {
  console.log("[getWiFiSSID] WiFiSSID: " + WiFiSSID);
}

Retrieves the Wi-Fi signal strength. Works only when the active connection type is Wi-Fi.

long getWiFiSignalStrengthLevel();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• long : long Signal strength level. Valid values are 1 to 5. Signal strength is strongest when the value is 5.
  8dBm
  8 ~ -77dBm
  7 ~ -66dBm
  6 ~ -55dBm
  5dBm

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a Wi-Fi connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var WiFiSignalStrengthLevel = null;
try {
  WiFiSignalStrengthLevel = webapis.network.getWiFiSignalStrengthLevel();
} catch (e) {
  console.log("getWiFiSignalStrengthLevel exception [" + e.code
  + "] name: " + e.name + " message: " + e.message);
}

if (null != WiFiSignalStrengthLevel) {
  console.log("[getWiFiSignalStrengthLevel] WiFiSignalStrengthLevel: "
  + WiFiSignalStrengthLevel);
}

Retrieves the Wi-Fi security mode. Works only when the active connection type is Wi-Fi.

NetworkWiFiSecurityMode getWiFiSecurityMode();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• NetworkWiFiSecurityMode : unsigned long Wi-Fi security mode
  "WEP": 1
  "WPA_PSK": 2
  "WPA2_PSK": 3
  "EAP": 4
  "NONE": 5
  "UNKNOWN": 6

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a Wi-Fi connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var WiFiSecurityMode = null;
try {
  WiFiSecurityMode = webapis.network.getWiFiSecurityMode();
} catch (e) {
  console.log("getWiFiSecurityMode exception [" + e.code + "] name: "
  + e.name + " message: " + e.message);
}

if (null != WiFiSecurityMode) {
  console.log("[getWiFiSecurityMode] WiFiSecurityMode: " + WiFiSecurityMode);
}

Retrieves the Wi-Fi encryption type. Works only when the active connection type is Wi-Fi.

NetworkWiFiEncryptionType getWiFiEncryptionType();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• NetworkWiFiEncryptionType : unsigned long Wi-Fi encryption type
  "WEP": 1
  "TKIP": 2
  "AES": 3
  "TKIP_AES_MIXED": 4
  "NONE": 5
  "UNKNOWN": 6

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a Wi-Fi connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var WiFiEncryptionType = null;
try {
  WiFiEncryptionType = webapis.network.getWiFiEncryptionType();
} catch (e) {
  console.log("getWiFiEncryptionType exception [" + e.code + "] name: "
  + e.name + " message: " + e.message);
}

if (null != WiFiEncryptionType) {
  console.log("[getWiFiEncryptionType] WiFiEncryptionType: "
  + WiFiEncryptionType);
}

Retrieves the device's configured secondary DNS address.

DOMString getSecondaryDns();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• DOMString : DOMString Secondary DNS address
  Example: 192.168.0.100

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 2.3

Code Example :

var secondaryDNS = null;
try {
  secondaryDNS = webapis.network.getSecondaryDns();
} catch (e) {
  console.error("getSecondaryDNS exception [" + e.code + "] name: " + e.name
  + " message: " + e.message);
}

if (null != secondaryDNS) {
  console.log("[getSecondaryDNS] secondaryDNS: " + secondaryDNS);
}

Sets the DHCP option 60 vendor string. Works only when the active connection type is wired. The vendor string is updated when Udhcpc is restarted or relaunched.

void setDhcpOption60Field(DOMString vendorName);

Product : TV, AV, B2B

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/network.dhcpoption60

Parameters :

• vendorName : DHCP option 60 vendor name string

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)
  • with error type InvalidStateError, if the active connection type is Wi-Fi. (Since plugin version 3.0)
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type. (Since plugin version 3.0)

Since : 2.3

Code Example :

try {
  webapis.network.setDhcpOption60Field("Cisco");
} catch (e) {
  console.error("setDHCPOption60Field exception [" + e.code + "] message: " + e.message);
}

console.log("[setDHCPOption60Field] DHCPOption60Field:Success ");

Sets the DHCP option 60 vendor string to the default value, "udhcpc1.21.1". Works only when the active connection type is wired. The vendor string is updated when Udhcpc is restarted or relaunched.

void removeDhcpOption60Field();

Product : TV, AV, B2B

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/network.dhcpoption60

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)
  • with error type InvalidStateError, if the active connection type is Wi-Fi. (Since plugin version 3.0)

Since : 2.3

Code Example :

try {
  webapis.network.removeDhcpOption60Field();
} catch (e) {
  console.error("removeDHCPOption60Field exception [" + e.code + "] message: " + e.message );
}

console.log("[removeDHCPOption60Field] DHCPOption60Field:Success ");

Retrieves the DHCP option 60 vendor string. Works only when the active connection type is wired.

DOMString getCurrentDhcpOption60Field();

Product : TV, AV, B2B

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/network.dhcpoption60

Return Value :

• DOMString : DOMString Vendor-specific string. Default value is "default".
  Example: If setDhcpOption60Field = "cisco" then getCurrentDhcpOption60Field = "cisco".

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)
  • with error type InvalidStateError, if the active connection type is Wi-Fi. (Since plugin version 3.0)

Since : 2.3

Code Example :

var DHCPOption60Field = null;
try {
  DHCPOption60Field = webapis.network.getCurrentDhcpOption60Field();
} catch (e) {
  console.error("getCurrentDHCPOption60Field exception [" + e.code
  + "] name: " + e.name + " message: " + e.message);
}

if (null != DHCPOption60Field) {
  console.log("[getCurrentDHCPOption60Field] DHCPOption60Field: "
  + DHCPOption60Field);
}

Retrieves the DHCP option 60 vendor string currently used by Udhcp. Works only when the active connection type is wired.

DOMString checkCurrentIpWith60Field();

Product : TV, AV, B2B

Privilege Level : Partner

Privilege : http://developer.samsung.com/privilege/network.dhcpoption60

Return Value :

• DOMString : DOMString Vendor string
  Example: If Udhcpc is running with the default string "udhcpc1.21.1", after calling setDhcpOption60Field = "cisco", checkCurrentIpWith60Field= "udhcpc1.21.1"

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)
  • with error type InvalidStateError, if the active connection type is Wi-Fi. (Since plugin version 3.0)

Since : 2.3

Code Example :

var DHCPOption60Field = null;
try {
  DHCPOption60Field = webapis.network.checkCurrentIpWith60Field();
} catch (e) {
  console.error("checkCurrentIPwith60Field exception [" + e.code + "] name: "
  + e.name + " message: " + e.message);
}

if (null != DHCPOption60Field) {
  console.log("[checkCurrentIPwith60Field] DHCPOption60Field: "
  + DHCPOption60Field);
}

Set the PEAP certification file path for PEAP base AP connection.

void setEAPCAfilePath(DOMString path);

Product : B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Parameters :

• path : PEAP certification file path

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if invalid DOMString type passed for 'path' parameter
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 6.5

Code Example :

var err = false;
try {
  webapis.network.setEAPCAfilePath("/opt/usr/home/owner/share/Root_test/ca.der");
} catch (e) {
  console.error("setEAPCAfilePath exception [" + e.code + "] name: " + e.name + " message: " + e.message);
  err = true;
}
if (err != true) {
  console.log("[setEAPCAfilePath] SUCCESS");
}

sets the username and password.

void setEAPPassphrase(DOMString name, DOMString password);

Product : B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Parameters :

• name : to be set
• password : to be set

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if invalid DOMString type passed for 'name' and 'password' parameter
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 6.5

Code Example :

var err = false;
try {
  webapis.network.setEAPPassphrase("testing11", "password11");
} catch (e) {
  console.error("setEAPPassphrase exception [" + e.code + "] name: " + e.name + " message: " + e.message);
  err = true;
}
if (err != true) {
  console.log("[setEAPPassphrase] SUCCESS");
}

Retrieves the Wi-Fi network Frequency. Works only when the active connection type is Wi-Fi.

long getWiFiFrequency();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Return Value :

• long : Wi-Fi network Frequency (MHz)

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a Wi-Fi connection is not available.

Since : 6.0

Code Example :

var WiFiFrequency = null;
try {
  WiFiFrequency = webapis.network.getWiFiFrequency();
} catch (e) {
  console.log("getWiFiFrequency exception [" + e.code
  + "] name: " + e.name + " message: " + e.message);
}

if (null != WiFiFrequency) {
  console.log("[getWiFiFrequency] WiFiFrequency: "
  + WiFiFrequency);
}

Callback method for gateway connection state change notifications.

void onchange(NetworkState state);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/network.public

Parameters :

• state : Connection state

Exceptions :

• WebAPIException
  • with error type SecurityError, if the application does not have the privilege to call this method.
  • with error type InvalidStateError, if a network connection is not available. (Since plugin version 3.0)

Since : 3.0

Code Example :

var Gatewaystatus =null;
var onChange = function(data) {
  if(data == webapis.network.NetworkState.GATEWAY_CONNECTED){
    Gatewaystatus ="GATEWAY_CONNECTED";
  }
  else if(data == webapis.network.NetworkState.GATEWAY_DISCONNECTED){
    Gatewaystatus ="GATEWAY_DISCONNECTED";
  }
  else{
    Gatewaystatus ="Status UNKNOWN";
  }
  console.log("[NetworkStateChangedCallback] data :" + data +"  "+ Gatewaystatus);
}