ProductInfo API

Retrieves the plugin version number.

DOMString getVersion();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Plugin version

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getVersion();
  console.log(" version value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the firmware information.

DOMString getFirmware();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Firmware version

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getFirmware();
  console.log(" Firmware value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the DUID.

DOMString getDuid();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : DUID

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getDuid();
  console.log(" Duid value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the model code, such as "15_HAWKP".

DOMString getModelCode();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Model code

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getModelCode();
  console.log(" ModelCode value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the model name, such as "UJS9500".

DOMString getModel();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Model name

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getModel();
  console.log(" Model value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the infolink server type.

ProductInfoSiServerType getSmartTVServerType();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• ProductInfoSiServerType : Infolink server type

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getSmartTVServerType();
  console.log(" smart tv server type = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the infolink server version, such as "T-INFOLINK2014-1002".

DOMString getSmartTVServerVersion();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Infolink server version

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getSmartTVServerVersion();
  console.log(" smart tv server version = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Checks whether UdPanel is supported.

boolean isUdPanelSupported();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• boolean : Boolean value:
  true: Supported
  false: Not supported

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.isUdPanelSupported();
  console.log(" support = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Checks whether 8K panel is supported.

boolean is8KPanelSupported();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• boolean : Boolean value:
  true: Supported
  false: Not supported

Exceptions :

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

Since : 4.0

Code Example :

try {
  var value = webapis.productinfo.is8KPanelSupported();
  console.log(" support = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the full model name, such as UN65JS9500.

DOMString getRealModel();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Model name

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getRealModel();
  console.log(" ModelName value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Checks whether the product model is WALL.

boolean isWallModel();

Product : TV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• boolean : Boolean value:
  true: Wall Model
  false: Not Wall Model

Exceptions :

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

Since : 5.0

Code Example :

try {
  var value = webapis.productinfo.isWallModel();
  console.log(value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the local set.

DOMString getLocalSet();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : LocalSet value

Exceptions :

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

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getLocalSet();
  console.log(" LocalSet value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Retrieves the value for the specified system configuration key, such as service country code.

Any getSystemConfig(ProductInfoConfigKey key);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Parameters :

• key : Product info configuration key

Return Value :

• Any : System configuration value. Only for CONFIG_KEY_AOT_SUPPORT key the return type is boolean, the return type for other case is DOMString.

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type InvalidValuesError, if any of the input parameters contain an invalid value. (Since plugin version 3.0)
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.getSystemConfig(webapis.productinfo.ProductInfoConfigKey.CONFIG_KEY_DATA_SERVICE);
  console.log("SystemConfig value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Sets the value for the specified system configuration key.

void setSystemConfig(ProductInfoConfigKey key, DOMString value, optional SuccessCallback? onsuccess, optional ErrorCallback? onerror);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Parameters :

• key : Product info configuration key
• value : Value to set
• onsuccess [optional][nullable] : Callback method to invoke when the system configuration key value is successfully set
• onerror [optional][nullable] : Callback method to invoke if an error has occurred
  SecurityError, if the application does not have the privilege to call this method.

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type InvalidValuesError, if any of the input parameters contain an invalid value.
    If only setSystemConfig can set CONFIG_KEY_DATA_SERVICE or CONFIG_KEY_ACTIVE_CATEGORY (Since plugin version 3.0)
  • with error type NotSupportedError, if 'CONFIG_KEY_SERVICE_COUNTRY' is readonly (Deprecated since plugin version 3.0)
  • with error type NotSupportedError, if 'CONFIG_KEY_SHOPLOGO' is readonly (Deprecated since plugin version 3.0)

Since : 2.3

Code Example :

function onsuccess(data)  {
  console.log("SystemConfig data = " + data);
}
function onerror(error)  {
  console.log("error code : " + error.code);
}
try {
  webapis.productinfo.setSystemConfig(webapis.productinfo.ProductInfoConfigKey.CONFIG_KEY_DATA_SERVICE, value, onsuccess, onerror);
} catch (error) {
  console.log(" error code = " + error.code);
}

Registers a system configuration change listener.

unsigned long addSystemConfigChangeListener(ProductInfoConfigKey key, ProductInfoConfigChangeCallback listener);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Parameters :

• key : Productinfo configuration key
• listener : ProductInfoConfigChangeCallback listener

Return Value :

• unsigned long : Listener ID

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type InvalidValuesError, if any of the input parameters contain an invalid or unchangeable value. (Since plugin version 3.0)
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

try {
  var value = webapis.productinfo.addSystemConfigChangeListener(webapis.productinfo.ProductInfoConfigKey.CONFIG_KEY_DATA_SERVICE, listener);
  console.log(" add Listener value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Unregisters a system configuration change listener.

void removeSystemConfigChangeListener(unsigned long listenerId);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Parameters :

• listenerId : ProductInfoConfigChangeCallback ID

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type InvalidValuesError, if any of the input parameters contain an invalid value. (Since plugin version 3.0)
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

try {
  webapis.productinfo.removeSystemConfigChangeListener(listenerId);
  console.log(" removedListener value ");
} catch (error) {
  console.log(" error code = " + error.code);
}

Checks whether the device supports Ultra HD Premium features.

boolean isUHDAModel();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• boolean : Boolean value:
  true: Supported
  false: Not supported

Exceptions :

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

Since : 3.0

Code Example :

try {
  var value = webapis.productinfo.isUHDAModel();
  console.log(" support = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

This method check whether display rotator is supported or not.

boolean isDisplayRotatorSupported();

Product : TV

Privilege : N

Return Value :

• boolean : true if display rotator is supported, else false

Since : 5.5

Code Example :

var value = webapis.productinfo.isDisplayRotatorSupported();
console.log("display rotator is supported = " + value);

This method get an actual manufacturer's information

DOMString getLicensedVendor();

Product : TV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• DOMString : Actual manufacturer information

Exceptions :

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

Since : 6.0

Code Example :

try {
  var value = webapis.productinfo.getLicensedVendor();
  console.log(" getLicensedVendor value = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Checks whether OledPanel is supported.

boolean isOledPanelSupported();

Product : TV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Return Value :

• boolean : Boolean value:
  true: Supported
  false: Not supported

Exceptions :

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

Since : 8.0

Code Example :

try {
  var value = webapis.productinfo.isOledPanelSupported();
  console.log(" support = " + value);
} catch (error) {
  console.log(" error code = " + error.code);
}

Callback method for product info configuration changes.

void onchange(ProductInfoConfigKey key);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/productinfo

Parameters :

• key : Key of each ProductInfo config

Since : 2.3

Code Example :

var onchange = function (key){
  console.log(" changed key is = " + key);
}