SAMSUNG D FORUM B2B LOGO

search

KIOSK

GUIDE
top

B2BControl API

To use Samsung B2B API, 

<script type="text/javascript" src="$B2BAPIS/b2bapis/b2bapis.js"></script>

Should be loaded in index.html

'B2BControl::B2BControlManagerObject' interface

Public Attributes

readonly attribute B2BControlManager b2bcontrol

Details in English

Namespace forB2BControl API.

Returns

B2BControl API의 네임스페이스.

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Version

1.0

Since

2.4

Product

B2B

SDK Support

Y

'B2BControl::B2BControlManager' interface

Public Methods

DOMString getVersion ( )
This interface provides methods to get b2bcontrol module version. More...
void setSpeakerType ( B2BControlSpeakerType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set speaker type. More...
B2BControlSpeakerType getSpeakerType ( )
This interface provides methods to get speaker type. More...
void setCurrentTime ( DOMString currentTime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set current time. More...
DOMString getCurrentTime ( )
This interface provides methods to get current time. More...
void setLampSchedule ( B2BControlOnOffEnable Enable, DOMString Time, long Brightness, DOMString SecondTime, long SecondBrightness, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set LampSchedule. More...
DOMString getLampSchedule ( )
This interface provides methods to get LampSchedule. More...
DOMString getCurrentTemperature ( )
This interface provides methods to get current temperature. More...
void setAlarmTemperature ( long AlramTemperature, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set AlarmTemperature. More...
DOMString getAlarmTemperature ( )
This interface provides methods to get alarm Temperature. More...
void setIRLockOnOff ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set IR Lock. More...
B2BControlOnOffEnable getIRLockStatus ( )
This interface provides methods to get IR Lock status. More...
B2BControlOnOffEnable getIRLockOnOff ( )
This interface provides methods to get IR Lock status same as getIRLockStatus. More...
void setPanelMute ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Panel Mute. More...
B2BControlOnOffEnable getPanelMuteStatus ( )
This interface provides methods to get Panel mute status. More...
void setButtonLock ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Button Lock. More...
B2BControlOnOffEnable getButtonLockStatus ( )
This interface provides methods to get Button Lock status. More...
void setIPConfigType ( B2BControlIPType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set IP Config type. More...
B2BControlIPType getIPConfigType ( )
This interface provides methods to get IP Config type. More...
DOMString getSerialNumber ( )
This interface provides methods to get Serial Number. More...
void setSafetyScreen ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set safety screen. More...
B2BControlOnOffEnable getSafetyScreen ( )
This interface provides methods to get safety screen. More...
void setSafetyLock ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Safety Lock. More...
B2BControlOnOffEnable getSafetyLock ( )
This interface provides methods to get safety lock status. More...
void setOsdMute ( B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Osd Mute. More...
B2BControlOnOffEnable getOsdMute ( )
This interface provides methods to get Osd Mute. More...
void setNetPIP ( B2BControlOnOffEnable Enable, SourceType SOURCE, DOMString RECT, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set PIP Play, If it should be run with video content, video api should be called first. More...
int getNetPIP ( )
This interface provides methods to get Net PIP Status. More...
void rebootDevice ( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to reboot device. More...
void setPowerOff ( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set power off. More...
void setIPAddress ( DOMString IP, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set IP Address. More...
DOMString getIPAddress ( )
This interface provides methods to get IP Address. More...
void setSubnetMask ( DOMString subnetMask, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set subnet mask. More...
DOMString getSubNetMask ( )
This interface provides methods to get subnet mask. More...
void setGatewayAddress ( DOMString gateWay, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set gateway address. More...
DOMString getGatewayAddress ( )
This interface provides methods to get gateway address. More...
void setDNSServer ( DOMString dns, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set DNS Server. More...
DOMString getDNSServer ( )
This interface provides methods to get DNS Address. More...
DOMString getMACAddress ( )
This interface provides methods to get mac address. More...
DOMString getProxyserverInfo ( )
This interface provides methods to get Proxy server information. More...
void setProxyserverInfo ( DOMString strURL, DOMString strPort, DOMString strID, DOMString strPW, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Proxy server information. More...
void captureScreen ( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to capture screen. More...
void setURLLauncherAddress ( DOMString url, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set URL Lancher address. More...
DOMString getURLLauncherAddress ( )
This interface provides methods to get URL Launcher's address. More...
void setSourceOrientation ( B2BControlSourceType type, B2BControlDEGREE degree, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set source orientation. More...
B2BControlDEGREE getSourceOrientation ( B2BControlSourceType type )
This interface provides methods to get source orientation. More...
void setOnTimer ( B2BControlTimerType type, DOMString ontime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set onTimer. More...
DOMString getOnTimer ( B2BControlTimerType type )
This interface provides methods to get onTimer. More...
void setOffTimer ( B2BControlTimerType timer, DOMString offtime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set off Timer. More...
DOMString getOffTimer ( B2BControlTimerType type )
This interface provides methods to get off Timer. More...
void setOnTimerRepeat ( B2BControlTimerType type, DOMString time, B2BControlTimerRepeatSet repeatType, TimerDay day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Timer repeatly. More...
DOMString getOnTimerRepeat ( TimerType type )
This interface provides methods to get timer repeatly. More...
void setOffTimerRepeat ( TimerType type, DOMString offtime, TimerRepeatSet repeatType, B2BControlTimerDay day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set off timer repeatly. More...
DOMString getOffTimerRepeat ( B2BControlTimerType type )
This interface provides methods to get off timer repeatly. More...
void setOnTimerVolume ( B2BControlTimerType type, long volume, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set timer volume. More...
DOMString getOnTimerVolume ( B2BControlTimerType type )
This interface provides methods to get timer volume. More...
void setHolidayToTimer ( B2BControlTimerOnOffEnable enable, B2BControlTimerType type, B2BControlTimerHolidayOnOff holidayEnable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set holiday's timer. More...
B2BControlTimerHolidayOnOff getHolidayToTimer ( B2BControlTimerOnOffEnable enable, B2BControlTimerType type )
This interface provides methods to get holiday setting value. More...
void setHolidayList ( DOMString option, DOMString start_month, DOMString start_day, DOMString end_month, DOMString end_day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set holiday list. More...
DOMString getHolidayList ( )
This interface provides methods to get holiday list. More...
int getSystemUpTime ( )
This interface provides methods to get system up time. More...
void updateFirmware ( DOMString SoftwareID, DOMString SWUFileName, DOMString SWVersion, DOMString SWURL, long SWTotalBytes, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to update firmware. More...
DOMString getFirmwareVersion ( )
This interface provides methods to get firware version, submicom. More...
void setAutoPowerOn ( B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set AutoPowerOn. More...
B2BControlOnOffEnable getAutoPowerOn ( )
This interface provides methods to get AutoPowerOn. More...
void setMaxPowerSaving ( B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set MaxPowerSaving. More...
B2BControlOnOffEnable getMaxPowerSaving ( )
This interface provides methods to get MaxPowerSaving. More...
void setNetworkStandby ( B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set NetworkStandby. More...
B2BControlOnOffEnable getNetworkStandby ( )
This interface provides methods to get NetworkStandby. More...
void setEnergySavingMode ( B2BControlEnergySavingMode mode, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set EnergySavingMode. More...
B2BControlEnergySavingMode getEnergySavingMode ( )
This interface provides methods to get EnergySavingMode. More...
void setEcoSensor ( B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set EcoSensor. More...
B2BControlOnOffEnable getEcoSensor ( )
This interface provides methods to get EcoSensor. More...
void setNoSignalPowerOff ( B2BControlNoSignalPowerOff type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set NoSignalPowerOff. More...
B2BControlNoSignalPowerOff getNoSignalPowerOff ( )
This interface provides methods to get NoSignalPowerOff status. More...
void setStandby ( B2BControlStandby type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Standby. More...
B2BControlStandby getStandby ( )
This interface provides methods to get Standby status. More...
void setPCConnection ( B2BControlPCConnection type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set PCConnection. More...
B2BControlPCConnection getPCConnection ( )
This interface provides methods to get PCConnection status. More...
void setUpdateFirmwareProgressChangeListener ( UpdateFirmwareProgressChangedCallback listener )
This method add the async event listener to the module for Firmware update progress. More...
void unsetUpdateFirmwareProgressChangeListener ( )
This method remove the async event listener to the module for Firmware update progress. More...
void setForwardMessageListener ( ForwardMessageCallback listener )
This method add the async event listener to the module for Forward Message send from SDAP server. More...
void setNTPUse ( B2BControlNTP mode, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set NTPUse. More...
B2BControlNTP getNTPUse ( )
This interface provides methods to get NTPUse status. More...
void setNTPServerAddress ( DOMString address, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set NTPServer address. More...
DOMString getNTPServerAddress ( )
This interface provides methods to get NTPServerAddress. More...
void setCurrentTimeZone ( DOMString timezone, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set TimeZone. More...
DOMString getCurrentTimeZone ( )
This interface provides methods to get TimeZone. More...
DOMString deleteAppPrivateInfo ( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to delete app's private Information. More...
DOMString setHotelID ( DOMString HotelID, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set hotel own id. More...
DOMString getHotelID ( )
This interface provides methods to get hotel own id. More...
void collectLogs ( DOMString Operation, DOMString serverUrl, boolean downloadScript, DOMString scriptUrl, long Logduration, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to start and stop device logs upload on remote server. More...
void setMagicInfoServerUrl ( B2BControlInternetProtocolType ssl, DOMString magicInfoServerAddress, DOMString magicInfoServerPortNumber, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set MagicInfo server address and port. More...
DOMString getMagicInfoServerUrl ( )
This interface provides methods to get MagicInfo server url. More...
void setURLLauncherTimeOut ( B2BControlTimeoutSetting type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set Timeout of url launcher. More...
B2BControlTimeoutSetting getURLLauncherTimeOut ( )
This interface provides methods to get time out waiting vaule. More...
void setLanguage ( B2BControlLanguageType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError )
This interface provides methods to set OSD Language. More...
B2BControlLanguageType getLanguage ( )
This interface provides methods to OSD Language. More...

Public Methods

DOMString getVersion()

   This interface provides methods to get b2bcontrol module version.

Details in English

get b2bcontrol module version.

Returns

DOMString b2bcontrol plug-in's version.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var Version = null;
try {
Version = b2bapis.b2bcontrol.getVersion();
} catch (e) {
console.log("[getVersion] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== Version){
console.log("[getVersion] call syncFunction type: " + Version);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setSpeakerType(B2BControlSpeakerType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set speaker type.

Details in English

To select audio speaker type

Returns

N/A

Parameters

type
   string,SpeakerType enum vlaue
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = "TV";
var onSuccess = function(val) {
console.log("[setSpeakerType] " + " success " + val);
}
var onError = function(error) {
console.log("[setSpeakerType] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setSpeakerType(type, onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlSpeakerType getSpeakerType()

   This interface provides methods to get speaker type.

Details in English

get current speaker type of SET

Returns

B2BControlSpeakerType, Speaker type of set

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var SpeakerType = null;
try {
SpeakerType = b2bapis.b2bcontrol.getSpeakerType();
} catch (e) {
console.log("[getSpeakerType] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== SpeakerType){
console.log("[getSpeakerType] call syncFunction type: " + SpeakerType);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setCurrentTime(DOMString currentTime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set current time.

Details in English

set current time to SET

Returns

N/A

Parameters

currentTime
   year:month:day:hour:minute:second
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setCurrentTime] success : " + val );
}
var onError = function(error) {
console.log("[setCurrentTime] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setCurrentTime] ");
//2015= year, 12= month, 25= day, 15=hour, 56= minute, 40= second
b2bapis.b2bcontrol.setCurrentTime("2015:12:25:15:56:40", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getCurrentTime()

   This interface provides methods to get current time.

Details in English

get current time.

Returns

DOMString Current Time, year:month:day:hour:minute:second

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var CurrentTime = null;
try {
CurrentTime = b2bapis.b2bcontrol.getCurrentTime();
} catch (e) {
console.log("[getCurrentTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== CurrentTime){
console.log("[getCurrentTime] call syncFunction type: " + CurrentTime);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setLampSchedule(B2BControlOnOffEnable Enable, DOMString Time, long Brightness, DOMString SecondTime, long SecondBrightness, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set LampSchedule.

Details in English

Set the LampSchedule of SET

Returns

N/A

Parameters

Enable
   on/off
Time
   hour:minute
Brightness
   level of brightness
SecondTime
   second hour:minute
SecondBrightness
   level of bightness
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setLampSchedule] success : " + val);
}
var onError = function(error) {
console.log("[setLampSchedule] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setLampSchedule] ");
b2bapis.b2bcontrol.setLampSchedule("ON","10:30",100,"20:30",50, onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getLampSchedule()

   This interface provides methods to get LampSchedule.

Details in English

get LampSchedule of SET

Returns

DOMString Lamp Schedule

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var LampSchedule = null;
try {
LampSchedule = b2bapis.b2bcontrol.getLampSchedule();
} catch (e) {
console.log("[getLampSchedule] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== LampSchedule){
console.log("[getLampSchedule] call syncFunction type: " + LampSchedule);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getCurrentTemperature()

   This interface provides methods to get current temperature.

Details in English

get current temperature of SET

Returns

DOMString Current temperature

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var CurrentTemperature = null;
try {
CurrentTemperature = b2bapis.b2bcontrol.getCurrentTemperature();
} catch (e) {
console.log("[getCurrentTemperature] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== CurrentTemperature){
console.log("[getCurrentTemperature] call syncFunction type: " + CurrentTemperature);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setAlarmTemperature(long AlramTemperature, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set AlarmTemperature.

Details in English

Set the alarm to occur when the temperature reaches a certain level.

Returns

N/A

Parameters

AlramTemperature
   of alram set
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter
B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var onSuccess = function(val) {
console.log("[setAlarmTemperature] success : " + val);
}
var onError = function(error) {
console.log("[setAlarmTemperature] code :" + error.code + " error name: " + 
error.name + " message " + error.message);
}
console.log("[setAlarmTemperature] ");
b2bapis.b2bcontrol.setAlarmTemperature(100, onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getAlarmTemperature()

   This interface provides methods to get alarm Temperature.

Details in English

Gets the set alarm temperature.

Returns

DOMString temperature of alram set

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var AlarmTemperature = null;
try {
AlarmTemperature = b2bapis.b2bcontrol.getAlarmTemperature();
} catch (e) {
console.log("[getAlarmTemperature] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== AlarmTemperature){
console.log("[getAlarmTemperature] call syncFunction type: " + AlarmTemperature);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setIRLockOnOff(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set IR Lock.

Details in English

set IR Lock

Returns

N/A

Parameters

Enable
   OnOffEnable,on/off
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setIRLockOnOff] success : " + val);
}
var onError = function(error) {
console.log("[setIRLockOnOff] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setIRLockOnOff] ");
b2bapis.b2bcontrol.setIRLockOnOff("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getIRLockStatus()

   This interface provides methods to get IR Lock status.

Details in English

get IR lock setting state

Returns

B2BControlOnOffEnable ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var IRLockOnOff = null;
try {
IRLockOnOff = b2bapis.b2bcontrol.getIRLockStatus();
} catch (e) {
console.log("[getIRLockStatus] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== IRLockOnOff){
console.log("[getIRLockStatus] call syncFunction type: " + IRLockOnOff);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getIRLockOnOff()

   This interface provides methods to get IR Lock status same as getIRLockStatus.

Details in English

get IR lock setting state same asgetIRLockStatus

Returns

B2BControlOnOffEnable ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var IRLockOnOff = null;
try {
IRLockOnOff = b2bapis.b2bcontrol.getIRLockOnOff();
} catch (e) {
console.log("[getIRLockOnOff] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== IRLockOnOff){
console.log("[getIRLockOnOff] call syncFunction type: " + IRLockOnOff);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setPanelMute(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Panel Mute.

Details in English

Set the panel mute state of the device.

Returns

N/A

Parameters

Enable
   OnOffEnable,on/off
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setPanelMute] success : " + val);
}
var onError = function(error) {
console.log("[setPanelMute] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setPanelMute] ");
b2bapis.b2bcontrol.setPanelMute("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.1

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getPanelMuteStatus()

   This interface provides methods to get Panel mute status.

Details in English

Get Current Panel Mute state

Returns

B2BControlOnOffEnable ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var PanelMuteOnOff = null;
try {
PanelMuteOnOff = b2bapis.b2bcontrol.getPanelMuteStatus();
} catch (e) {
console.log("[getPanelMuteStatus] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== PanelMuteOnOff){
console.log("[getPanelMuteStatus] call syncFunction type: " + PanelMuteOnOff);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setButtonLock(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Button Lock.

Details in English

Set the button lock state of the device.

Returns

N/A

Parameters

Enable
   OnOffEnable,on/off
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setButtonLock] success : " + val);
}
var onError = function(error) {
console.log("[setButtonLock] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setButtonLock] ");
b2bapis.b2bcontrol.setButtonLock("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.1

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getButtonLockStatus()

   This interface provides methods to get Button Lock status.

Details in English

Get Current Button Lock status

Returns

B2BControlOnOffEnable ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var ButtonLockOnOff = null;
try {
ButtonLockOnOff = b2bapis.b2bcontrol.getButtonLockStatus();
} catch (e) {
console.log("[getButtonLockStatus] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== ButtonLockOnOff){
console.log("[getButtonLockStatus] call syncFunction type: " + ButtonLockOnOff);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setIPConfigType(B2BControlIPType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set IP Config type.

Details in English

To set the IP Confige typeSTATIC which means enter manually and DYNAMIC as obtain automatically

Returns

N/A

Parameters

type
   Network config type of device
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function() {
console.log("[setIPConfigType] success ");
}
var onError = function(error) {
console.log("[setIPConfigType] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
IPflag = b2bcontrol.getIPConfigType(); *
if(IPflag === "STATIC")
{ 
console.log("[setIPConfigType] DYNAMIC");
b2bcontrol.setIPConfigType("DYNAMIC", onSuccess, onError);
}
else
{
console.log("[setIPConfigType] STATIC");
b2bcontrol.setIPConfigType("STATIC", onSuccess, onError);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.1

Since

2.4

SDK Support

Y

B2BControlIPType getIPConfigType()

   This interface provides methods to get IP Config type.

Details in English

Get current ip config type of the Device.

Returns

DOMString, STATIC or DYNAMIC

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var IPConfigType = null;
try {
console.log("[getIPConfigType] b2bcontrol object : "+b2bcontrol); 
IPConfigType = b2bcontrol.getIPConfigType();
} catch (e) {
console.log("[getIPConfigType] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== IPConfigType){
console.log("[getIPConfigType] call syncFunction type: " + IPConfigType);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getSerialNumber()

   This interface provides methods to get Serial Number.

Details in English

Get the unique number of the product.

Returns

DOMString Set's serial Number

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var SerialNumber = null;
try {
SerialNumber = b2bapis.b2bcontrol.getSerialNumber();
} catch (e) {
console.log("[getSerialNumber] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== SerialNumber){
console.log("[getSerialNumber] call syncFunction type: " + SerialNumber);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setSafetyScreen(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set safety screen.

Details in English

Provides screen protection settings.

Returns

N/A

Parameters

Enable
   OnOffEnable, ON/OFF
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setSafetyScreen] success : " + val);
}
var onError = function(error) {
console.log("[setSafetyScreen] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setSafetyScreen] ");
b2bapis.b2bcontrol.setSafetyScreen("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getSafetyScreen()

   This interface provides methods to get safety screen.

Details in English

Get the screen protection setting status.

Returns

B2BControlOnOffEnable Safety status, ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var SafetyScreen = null;
try {
SafetyScreen = b2bapis.b2bcontrol.getSafetyScreen();
} catch (e) {
console.log("[getSafetyScreen] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== SafetyScreen){
console.log("[getSafetyScreen] call syncFunction type: " + SafetyScreen);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setSafetyLock(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Safety Lock.

Details in English

set Safery Lock

Returns

N/A

Parameters

Enable
   OnOffEnable,ON/OFF
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setSafetyLock] success : " + val);
}
var onError = function(error) {
console.log("[setSafetyLock] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setSafetyLock] ");
b2bapis.b2bcontrol.setSafetyLock("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getSafetyLock()

   This interface provides methods to get safety lock status.

Details in English

get safery lock status

Returns

B2BControlOnOffEnable Safety status, ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var SafetyLock = null;
try {
SafetyLock = b2bapis.b2bcontrol.getSafetyLock();
} catch (e) {
console.log("[getSafetyLock] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== SafetyLock){
console.log("[getSafetyLock] call syncFunction type: " + SafetyLock);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOsdMute(B2BControlOnOffEnable Enable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Osd Mute.

Details in English

Set On Screen Display Mute status such as source info ,no signal, mdc, download display message

Returns

N/A

Parameters

Enable
   OsdStatus, ON/OFF
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setOsdMute] success : " + val);
}
var onError = function(error) {
console.log("[setOsdMute] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOsdMute] ");
b2bapis.b2bcontrol.setOsdMute("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getOsdMute()

   This interface provides methods to get Osd Mute.

Details in English

Get Osd Mute Status of Set

Returns

B2BControlOnOffEnable OSD Status, ON/OFF

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OsdMute = null;
try {
OsdMute = b2bapis.b2bcontrol.getOsdMute();
} catch (e) {
console.log("[getOsdMute] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OsdMute){
console.log("[getOsdMute] call syncFunction type: " + OsdMute);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setNetPIP(B2BControlOnOffEnable Enable, SourceType SOURCE, DOMString RECT, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set PIP Play, If it should be run with video content, video api should be called first.

Details in English

To Set basic information for PIP Play.

Returns

N/A

Parameters

Enable
   OnOffEnable, ON/OFF
SOURCE
   type
RECT
   PIP's rect(left:right:width:height)
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setNetPIP] success : " + val);
}
var onError = function(error) {
console.log("[setNetPIP] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setNetPIP] ");
b2bapis.b2bcontrol.setNetPIP("ON","TV","600:200:520:400", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

int getNetPIP()

   This interface provides methods to get Net PIP Status.

Details in English

get Net PIP Status

Returns

int PIP setting Status, 0 is disable, 1 is enable

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var readPIPStatus = null;
try { 
readPIPStatus = b2bcontrol.getNetPIP();
} catch (e) {
console.log("[getPIPStatus] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== readPIPStatus){
console.log("[getPIPStatus] call syncFunction type: " + readPIPStatus);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void rebootDevice( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to reboot device.

Details in English

Power off the Set and re start

Returns

N/A

Parameters

onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[rebootDevice] success : " + val);
}
var onError = function(error) {
console.log("[rebootDevice] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[rebootDevice] ");
b2bapis.b2bcontrol.rebootDevice(onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setPowerOff( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set power off.

Details in English

ser power off

Returns

N/A

Parameters

onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setPowerOff] success : " + val);
}
var onError = function(error) {
console.log("[setPowerOff] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setPowerOff] ");
b2bapis.b2bcontrol.setPowerOff(onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setIPAddress(DOMString IP, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set IP Address.

Details in English

Set theNetwork IP of the Set.

Returns

N/A

Parameters

IP
   Value, 000.000.000.000
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setIPAddress] success : " + val);
}
var onError = function(error) {
console.log("[setIPAddress] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setIPAddress] ");
b2bapis.b2bcontrol.setIPAddress("107.108.109.110", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getIPAddress()

   This interface provides methods to get IP Address.

Details in English

Get the IP value of the Set

Returns

DOMString Set's IP Address

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var IPAddress = null;
try {
IPAddress = b2bapis.b2bcontrol.getIPAddress();
} catch (e) {
console.log("[getIPAddress] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== IPAddress){
console.log("[getIPAddress] call syncFunction type: " + IPAddress);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setSubnetMask(DOMString subnetMask, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set subnet mask.

Details in English

Set Subnet mask value of the Set

Returns

N/A

Parameters

subnetMask
   Value,000.000.000.000
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setSubnetMask] success : " + val);
}
var onError = function(error) {
console.log("[setSubnetMask] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setSubnetMask] ");
b2bapis.b2bcontrol.setSubnetMask("255.255.255.0", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getSubNetMask()

   This interface provides methods to get subnet mask.

Details in English

Get subnet mask of the Set

Returns

DOMString Subnetmask value

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var subNetMask = null;
try {
subNetMask = b2bapis.b2bcontrol.getSubNetMask();
} catch (e) {
console.log("[getSubNetMask] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== subNetMask){
console.log("[getSubNetMask] call syncFunction type: " + subNetMask);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setGatewayAddress(DOMString gateWay, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set gateway address.

Details in English

Set gateway address value of the Set

Returns

N/A

Parameters

gateWay
   Value,000,000,000,000
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setGatewayAddress] success : " + val);
}
var onError = function(error) {
console.log("[setGatewayAddress] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setGatewayAddress] ");
b2bapis.b2bcontrol.setGatewayAddress("107.108.109.1", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getGatewayAddress()

   This interface provides methods to get gateway address.

Details in English

Get gateway address value of the Set

Returns

DOMString Gateway addresss

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var GatewayAddress = null;
try {
GatewayAddress = b2bapis.b2bcontrol.getGatewayAddress();
} catch (e) {
console.log("[getGatewayAddress] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== GatewayAddress){
console.log("[getGatewayAddress] call syncFunction type: " + GatewayAddress);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setDNSServer(DOMString dns, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set DNS Server.

Details in English

Set DNS Server Address of the Set

Returns

N/A

Parameters

dns
   Value, 000,000,000,000
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setDNSServer] success : " + val);
}
var onError = function(error) {
console.log("[setDNSServer] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setDNSServer] ");
b2bapis.b2bcontrol.setDNSServer("107.108.109.1", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getDNSServer()

   This interface provides methods to get DNS Address.

Details in English

Get DNS Address value of the Set

Returns

DOMString DNS Address

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var DNSServer = null;
try {
DNSServer = b2bapis.b2bcontrol.getDNSServer();
} catch (e) {
console.log("[getDNSServer] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== DNSServer){
console.log("[getDNSServer] call syncFunction type: " + DNSServer);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getMACAddress()

   This interface provides methods to get mac address.

Details in English

Get mac address value of the Set

Returns

DOMString Set's Mac address, If there is no parameter, then it will return WIRED

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var MACAddress = null;
var MACAddress_WIRED = null;
var MACAddress_WIRELESS = null;
try {
MACAddress_WIRED = b2bapis.b2bcontrol.getMACAddress();
MACAddress_WIRED = b2bapis.b2bcontrol.getMACAddress("WIRED");
MACAddress_WIRELESS = b2bapis.b2bcontrol.getMACAddress("WIRELESS");
} catch (e) {
console.log("[getMACAddress] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== MACAddress){
console.log("[getMACAddress] call syncFunction type: " + MACAddress);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getProxyserverInfo()

   This interface provides methods to get Proxy server information.

Details in English

Get Proxy server information of the Set

Returns

DOMString Proxy server information

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var ProxyserverInfo = null;
try {
ProxyserverInfo = b2bapis.b2bcontrol.getProxyserverInfo();
} catch (e) {
console.log("[getProxyserverInfo] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== ProxyserverInfo){
console.log("[getProxyserverInfo] call syncFunction type: " + ProxyserverInfo);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setProxyserverInfo(DOMString strURL, DOMString strPort, DOMString strID, DOMString strPW, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Proxy server information.

Details in English

Set Proxy server information of the Set

Returns

N/A

Parameters

strURL
   string, proxy server's address
strPort
   string, proxy server's port number
strID
   string, proxy server's user id
strPW
   string, proxy server's user password
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setProxyserverInfo] success : " + val);
}
var onError = function(error) {
console.log("[setProxyserverInfo] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setProxyserverInfo] ");
b2bapis.b2bcontrol.setProxyServerInfo("","","10.20.30.40","9998", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void captureScreen( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to capture screen.

Details in English

capture screen(Saved path: /opt/share/magicinfo/PepperAPIScreenCapture.jpg

Returns

N/A

Parameters

onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[captureScreen] success : " + val);
}
var onError = function(error) {
console.log("[captureScreen] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[captureScreen] ");
b2bapis.b2bcontrol.captureScreen(onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setURLLauncherAddress(DOMString url, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set URL Lancher address.

Details in English

URL Launcher Sets the URL to be entered in the application

Returns

N/A

Parameters

url
   string,URL Launcher application's url
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setURLLauncherAddress] success : " + val);
}
var onError = function(error) {
console.log("[setURLLauncherAddress] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setURLLauncherAddress] ");
b2bapis.b2bcontrol.setURLLauncherAddress("http://10.88.43.36:8080/New2016/Test/", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getURLLauncherAddress()

   This interface provides methods to get URL Launcher's address.

Details in English

Get URL Launcher's address

Returns

DOMString URL Launcher application's url

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var URLLauncherAddress = null;
try {
URLLauncherAddress = b2bapis.b2bcontrol.getURLLauncherAddress();
} catch (e) {
console.log("[getURLLauncherAddress] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== URLLauncherAddress){
console.log("[getURLLauncherAddress] call syncFunction type: " + URLLauncherAddress);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setSourceOrientation(B2BControlSourceType type, B2BControlDEGREE degree, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set source orientation.

Details in English

Set source orientation of the Set

Returns

N/A

Parameters

type
   string, source type
degree
   Set source's Degree value
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setSourceOrientation] success : " + val);
}
var onError = function(error) {
console.log("[setSourceOrientation] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setSourceOrientation] ");
b2bapis.b2bcontrol.setSourceOrientation("TV","DEGREE_0", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlDEGREE getSourceOrientation(B2BControlSourceType type)

   This interface provides methods to get source orientation.

Details in English

Get source orientation of the Set

Returns

B2BControlSourceType Degree of set's orientation

Parameters

type
   string, source type what user want to know this orientation

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var onSuccess = function(val) {
console.log("[getSourceOrientation] success : " + val);
}
var onError = function(error) {
console.log("[getSourceOrientation] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[getSourceOrientation] ");
b2bapis.b2bcontrol.getSourceOrientation("TV");

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOnTimer(B2BControlTimerType type, DOMString ontime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set onTimer.

Details in English

Sets the one-time timer of the Set

Returns

N/A

Parameters

type
   TimerType
ontime
   time set,hour:minute
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter

Remark

Frequent calls to set timer api may cause internal eeprom problems inside the SET. Please use according to the hardware specification. 
var onSuccess = function(val) {
console.log("[setOnTimer] success : " + val);
}
var onError = function(error) {
console.log("[setOnTimer] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOnTimer] ");
b2bapis.b2bcontrol.setOnTimer("TIMER6","21:30", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getOnTimer(B2BControlTimerType type)

   This interface provides methods to get onTimer.

Details in English

Retrieves the value set in the Timer

Returns

DOMString Set's ontimer type & time

Parameters

type
   TimerType, timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OnTimer = null;
try {
OnTimer = b2bapis.b2bcontrol.getOnTimer("TIMER2");
} catch (e) {
console.log("[getOnTimer] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OnTimer){
console.log("[getOnTimer] call syncFunction type: " + OnTimer);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOffTimer(B2BControlTimerType timer, DOMString offtime, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set off Timer.

Details in English

Set the one-time Timer off value.

Returns

N/A

Parameters

timer
   type
offtime
   set,hour:minute
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setOffTimer] success : " + val);
}
var onError = function(error) {
console.log("[setOffTimer] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOffTimer] ");
b2bapis.b2bcontrol.setOffTimer("TIMER6","21:30", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getOffTimer(B2BControlTimerType type)

   This interface provides methods to get off Timer.

Details in English

Retrieves the set Off timer value.

Returns

DOMString Off timer's setting value

Parameters

type
   timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OffTimer = null;
try {
OffTimer = b2bapis.b2bcontrol.getOffTimer("TIMER5");
} catch (e) {
console.log("[getOffTimer] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OffTimer){
console.log("[getOffTimer] call syncFunction type: " + OffTimer);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOnTimerRepeat(B2BControlTimerType type, DOMString time, B2BControlTimerRepeatSet repeatType, TimerDay day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Timer repeatly.

Details in English

Set the Ontimer set continuously.

Returns

N/A

Parameters

type
   string,timer name
time
   set
repeatType
   enum value
day
   enume value TimerDay:TimerDay (In case of repeat type is MANUAL, then user should input this param)
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setOnTimerRepeat] success : " + val);
}
var onError = function(error) {
console.log("[setOnTimerRepeat] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOnTimerRepeat] ");
b2bapis.b2bcontrol.setOnTimerRepeat("TIMER6","12:30","TIMER_MANUAL","SUN:MON:TUE:FRI", onSuccess, onError);
b2bapis.b2bcontrol.setOnTimerRepeat("TIMER7","15:30","TIMER_MON_SAT","", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getOnTimerRepeat(TimerType type)

   This interface provides methods to get timer repeatly.

Details in English

Retrieves the periodically set value of the Timer.

Returns

DOMString Set's onTimer value

Parameters

type
   timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OnTimerRepeat = null;
try {
OnTimerRepeat = b2bapis.b2bcontrol.getOnTimerRepeat("TIMER3");
} catch (e) {
console.log("[OnTimerRepeat] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== getOnTimerRepeat){
console.log("[OnTimerRepeat] call syncFunction type: " + OnTimerRepeat);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOffTimerRepeat(TimerType type, DOMString offtime, TimerRepeatSet repeatType, B2BControlTimerDay day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set off timer repeatly.

Details in English

Set the Offtimer set continuously.

Returns

N/A

Parameters

type
   string,timer name
offtime
   set
repeatType
   enum value
day
   enume value, TimerDay:TimerDay (In case of repeat type is MANUAL, then user should input this param)
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setOffTimerRepeat] success : " + val);
}
var onError = function(error) {
console.log("[setOffTimerRepeat] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOffTimerRepeat] ");
b2bapis.b2bcontrol.setOffTimerRepeat("TIMER7","14:00","TIMER_MANUAL","SUN:MON:TUE:FRI", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getOffTimerRepeat(B2BControlTimerType type)

   This interface provides methods to get off timer repeatly.

Details in English

Get off timer repeatly

Returns

DOMString List of off timer values

Parameters

type
   timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OffTimerRepeat = null;
try {
OffTimer = b2bapis.b2bcontrol.getOffTimerRepeat("TIMER6");
} catch (e) {
console.log("[getOffTimerRepeat] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OffTimerRepeat){
console.log("[getOffTimerRepeat] call syncFunction type: " + OffTimerRepeat);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setOnTimerVolume(B2BControlTimerType type, long volume, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set timer volume.

Details in English

Set timer volume of the Set

Returns

N/A

Parameters

type
   TimerType enum value
volume
   level
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setOnTimerVolume] success : " + val);
}
var onError = function(error) {
console.log("[setOnTimerVolume] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setOnTimerVolume] ");
b2bapis.b2bcontrol.setOnTimerVolume("TIMER7" ,10, onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getOnTimerVolume(B2BControlTimerType type)

   This interface provides methods to get timer volume.

Details in English

Get timer volume

Returns

DOMString Timer's volume level

Parameters

type
   timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OnTimerVolume = null;
try {
OnTimerVolume = b2bapis.b2bcontrol.getOnTimerVolume("TIMER1");
} catch (e) {
console.log("[getOnTimerVolume] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OnTimerVolume){
console.log("[getOnTimerVolume] call syncFunction type: " + OnTimerVolume);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setHolidayToTimer(B2BControlTimerOnOffEnable enable, B2BControlTimerType type, B2BControlTimerHolidayOnOff holidayEnable, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set holiday's timer.

Details in English

Set TIMER to not operate on holidays.

Returns

N/A

Parameters

enable
   TimerOnOffEnable, ON/OFF
type
   TimerType
holidayEnable
   string,holiday's enable
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setHolidayToTimer] success : " + val);
}
var onError = function(error) {
console.log("[setHolidayToTimer] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setHolidayToTimer] ");
b2bapis.b2bcontrol.setHolidayToTimer("OFF_TIMER", "TIMER1", "HOLIDAY_OFF", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

B2BControlTimerHolidayOnOff getHolidayToTimer(B2BControlTimerOnOffEnable enable, B2BControlTimerType type)

   This interface provides methods to get holiday setting value.

Details in English

get hoilday setting value

Returns

B2BControlTimerHolidayOnOff This timer's holiday timer set

Parameters

enable
   TimerOnOffEnable type
type
   TimerType timer name

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var HolidayToTimer = null;
try {
HolidayToTimer = b2bapis.b2bcontrol.getHolidayToTimer("ON_TIMER","TIMER1");
} catch (e) {
console.log("[getHolidayToTimer] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== HolidayToTimer){
console.log("[getHolidayToTimer] call syncFunction type: " + HolidayToTimer);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void setHolidayList(DOMString option, DOMString start_month, DOMString start_day, DOMString end_month, DOMString end_day, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set holiday list.

Details in English

Add a holiday list where the Timer will not work.

Returns

N/A

Parameters

option
   string, ADD/DELETE
start_month
   string, start month
start_day
   string, start day
end_month
   string, end month
end_day
   string, edn day
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setHolidayList] success : " + val);
}
var onError = function(error) {
console.log("[setHolidayList] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[setHolidayList] ");
b2bapis.b2bcontrol.setHolidayList("ADD","1","31","2","28",onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getHolidayList()

   This interface provides methods to get holiday list.

Details in English

Get holiday list of the Set

Returns

DOMString Holiday list of timer

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var HolidayList = null;
try {
HolidayList = b2bapis.b2bcontrol.getHolidayList();
} catch (e) {
console.log("[getHolidayList] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== HolidayList){
console.log("[getHolidayList] call syncFunction type: " + HolidayList);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

int getSystemUpTime()

   This interface provides methods to get system up time.

Details in English

Get Time until the system is powered on stable

Returns

int taken time

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var SystemUpTime = null;
try {
SystemUpTime = b2bapis.b2bcontrol.getSystemUpTime();
} catch (e) {
console.log("[getSystemUpTime] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== SystemUpTime){
console.log("[getSystemUpTime] call syncFunction type: " + SystemUpTime);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

void updateFirmware(DOMString SoftwareID, DOMString SWUFileName, DOMString SWVersion, DOMString SWURL, long SWTotalBytes, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to update firmware.

Details in English

updat firmware

Returns

N/A

Parameters

SoftwareID
   string, software ID
SWUFileName
   string, file name
SWVersion
   string, software version
SWURL
   string,software file path
SWTotalBytes
   int, file's bytes
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[updateFirmware] success : " + val);
}
var onError = function(error) {
console.log("[updateFirmware] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[updateFirmware] ");
var SoftwareID = "0";
var SWUFileName = "upgrade.bem";
var SWVersion = "T-HKMLAKUC 0227.20";
var SWURL = "http://10.88.43.36:8080/New2016/Saurabh/swupdate/T-HKMLAKUC_0227_20/image/upgrade.bem";
var SWTotalBytes = 1007396825;
b2bapis.b2bcontrol.updateFirmware(SoftwareID, SWUFileName, SWVersion, SWURL, SWTotalBytes, onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.0

Since

2.4

SDK Support

Y

DOMString getFirmwareVersion()

   This interface provides methods to get firware version, submicom.

Details in English

Get firmware, submicom version of the Set

Returns

DOMString Version of firmware and submicom, like mainVersion;subVersion1;subVersion2;subVersion3

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var FirmwareVersion = null;
try {
FirmwareVersion = b2bapis.b2bcontrol.getFirmwareVersion();
} catch (e) {
console.log("[getFirmwareVersion] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
// In case of firmware version only, ex) T-MHTKAUC-0320
// In case of submicom versino also, ex) T-MHTKAUC-0320;t-ktm2elakus-1019_D;SE18S type-10 
}
if(null !== FirmwareVersion){
console.log("[getFirmwareVersion] call syncFunction type: " + FirmwareVersion);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.8

Since

2.4

SDK Support

Y

void setAutoPowerOn(B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set AutoPowerOn.

Details in English

Control the auto power on option

Returns

N/A

Parameters

onoff
   enum B2BControlOnOffEnable
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = null;
var onSuccess = function(val) {
console.log("[setAutoPowerOn] " + " success " + val);
}
var onError = function(error) {
console.log("[setAutoPowerOn] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setAutoPowerOn("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getAutoPowerOn()

   This interface provides methods to get AutoPowerOn.

Details in English

Get current selected option for AutoPowerOn

Returns

B2BControlOnOffEnable

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var AutoPowerOn = null;
try {
AutoPowerOn = b2bapis.b2bcontrol.getAutoPowerOn();
} catch (e) {
console.log("[getAutoPowerOn] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== AutoPowerOn){
console.log("[getAutoPowerOn] call syncFunction type: " + AutoPowerOn);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setMaxPowerSaving(B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set MaxPowerSaving.

Details in English

Control the MaxPowerSaving option of the device

Returns

N/A

Parameters

onoff
   enum B2BControlOnOffEnable
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = null;
var onSuccess = function(val) {
console.log("[setMaxPowerSaving] " + " success " + val);
}
var onError = function(error) {
console.log("[setMaxPowerSaving] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setMaxPowerSaving("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getMaxPowerSaving()

   This interface provides methods to get MaxPowerSaving.

Details in English

Get current selected option for MaxPowerSaving

Returns

B2BControlOnOffEnable

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var MaxPowerSaving = null;
try {
MaxPowerSaving = b2bapis.b2bcontrol.getMaxPowerSaving();
} catch (e) {
console.log("[getMaxPowerSaving] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== MaxPowerSaving){
console.log("[getMaxPowerSaving] call syncFunction type: " + MaxPowerSaving);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setNetworkStandby(B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set NetworkStandby.

Details in English

Control the NetworkStandby option of the device

Returns

N/A

Parameters

onoff
   enum B2BControlOnOffEnable
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = null;
var onSuccess = function(val) {
console.log("[setNetworkStandby] " + " success " + val);
}
var onError = function(error) {
console.log("[setNetworkStandby] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setNetworkStandby("ON", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getNetworkStandby()

   This interface provides methods to get NetworkStandby.

Details in English

Get current selected option for NetworkStandby

Returns

B2BControlOnOffEnable

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var NetworkStandby = null;
try {
NetworkStandby = b2bapis.b2bcontrol.getNetworkStandby();
} catch (e) {
console.log("[getNetworkStandby] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NetworkStandby){
console.log("[getNetworkStandby] call syncFunction type: " + NetworkStandby);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setEnergySavingMode(B2BControlEnergySavingMode mode, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set EnergySavingMode.

Details in English

Control the EnergySavingMode option of the device

Returns

N/A

Parameters

mode
   B2BControlEnergySavingMode
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = null;
var onSuccess = function(val) {
console.log("[setEnergySavingMode] " + " success " + val);
}
var onError = function(error) {
console.log("[setEnergySavingMode] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setEnergySavingMode("OFF", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlEnergySavingMode getEnergySavingMode()

   This interface provides methods to get EnergySavingMode.

Details in English

Get current selected option for EnergySavingMode

Returns

B2BControlEnergySavingMode

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var EnergySavingMode = null;
try {
EnergySavingMode = b2bapis.b2bcontrol.getEnergySavingMode();
} catch (e) {
console.log("[getEnergySavingMode] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== EnergySavingMode){
console.log("[getEnergySavingMode] call syncFunction type: " + EnergySavingMode);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setEcoSensor(B2BControlOnOffEnable onoff, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set EcoSensor.

Details in English

Control the EcoSensor option of the device

Returns

N/A

Parameters

onoff
   B2BControlOnOffEnable
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var type = null;
var onSuccess = function(val) {
console.log("[setEcoSensor] " + " success " + val);
}
var onError = function(error) {
console.log("[setEcoSensor] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setEcoSensor("OFF", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlOnOffEnable getEcoSensor()

   This interface provides methods to get EcoSensor.

Details in English

Get current selected option for EcoSensor

Returns

B2BControlOnOffEnable

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var EcoSensor = null;
try {
EcoSensor = b2bapis.b2bcontrol.getEcoSensor();
} catch (e) {
console.log("[getEcoSensor] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== EcoSensor){
console.log("[getEcoSensor] call syncFunction type: " + EcoSensor);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setNoSignalPowerOff(B2BControlNoSignalPowerOff type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set NoSignalPowerOff.

Details in English

Set the NoSignalPowerOff item of the device

Returns

N/A

Parameters

type
   string, enum B2BControlNoSignalPowerOff
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setNoSignalPowerOff] success : " + val);
}
var onError = function(error) {
console.log("[setNoSignalPowerOff] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setNoSignalPowerOff("OFF", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlNoSignalPowerOff getNoSignalPowerOff()

   This interface provides methods to get NoSignalPowerOff status.

Details in English

Get NoSignalPowerOff status of Device

Returns

B2BControlNoSignalPowerOff

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var NoSignalPowerOff = null;
try {
NoSignalPowerOff = b2bapis.b2bcontrol.getNoSignalPowerOff();
} catch (e) {
console.log("[getNoSignalPowerOff] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NoSignalPowerOff){
console.log("[getNoSignalPowerOff] call syncFunction type: " + NoSignalPowerOff);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setStandby(B2BControlStandby type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Standby.

Details in English

Set the Standby item of the device

Returns

N/A

Parameters

type
   string, enum B2BControlStandby
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setStandby] success : " + val);
}
var onError = function(error) {
console.log("[setStandby] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setStandby("OFF", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlStandby getStandby()

   This interface provides methods to get Standby status.

Details in English

Get Standby status of the Device

Returns

B2BControlStandby

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var Standby = null;
try {
Standby = b2bapis.b2bcontrol.getStandby();
} catch (e) {
console.log("[getStandby] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== Standby){
console.log("[getStandby] call syncFunction type: " + Standby);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setPCConnection(B2BControlPCConnection type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set PCConnection.

Details in English

Set the device's PCConnection entry

Returns

N/A

Parameters

type
   enum B2BControlPCConnection
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setPCConnection] success : " + val);
}
var onError = function(error) {
console.log("[setPCConnection] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setPCConnection("RJ45", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

B2BControlPCConnection getPCConnection()

   This interface provides methods to get PCConnection status.

Details in English

Get PCConnection status of the Device

Returns

B2BControlPCConnection

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var PCConnection = null;
try {
PCConnection = b2bapis.b2bcontrol.getPCConnection();
} catch (e) {
console.log("[getPCConnection] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== PCConnection){
console.log("[getPCConnection] call syncFunction type: " + PCConnection);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setUpdateFirmwareProgressChangeListener( UpdateFirmwareProgressChangedCallback listener)

   This method add the async event listener to the module for Firmware update progress.

Details in English

This method add the async event listener to the module for Firmware update progress.

Returns

N/A

Parameters

listener
   : callback function should be provided in this.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method. 
function setUpdateFirmwareProgressChangeListener() {
var onchange = function(data) {
console.log("[UpdateFirmwareProgressChangedCallback] progress :" + data + " changed");
}
try {
b2bapis.b2bcontrol.setUpdateFirmwareProgressChangeListener(onchange);
} catch (e) {
console.log("setUpdateFirmwareProgressChangeListener exception [" + e.code + "] name: " + e.name + " message: " + e.message););
}
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void unsetUpdateFirmwareProgressChangeListener()

   This method remove the async event listener to the module for Firmware update progress.

Details in English

This method remove the async event listener to the module for Firmware update progress.

Returns

N/A

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method. 
function unsetUpdateFirmwareProgressChangeListener() {
try {
console.log("begin unsetUpdateFirmwareProgressChangeListener");
b2bapis.b2bcontrol.unsetUpdateFirmwareProgressChangeListener();
} catch (e) {
console.log("unsetUpdateFirmwareProgressChangeListener exception [" + e.code + "] name: " + e.name + " message: " + e.message);
return;
}
console.log("unsetUpdateFirmwareProgressChangeListener success");
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setForwardMessageListener(ForwardMessageCallback listener)

   This method add the async event listener to the module for Forward Message send from SDAP server.

Details in English

This method add the async event listener to the module for Forward Message send from SDAP server.

Returns

N/A

Parameters

listener
   : callback function should be provided in this.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method. 
var onchange = function(data) {
console.log("[setForwardMessageListener] Message data :" + data);
}
try {
b2bapis.b2bcontrol.setForwardMessageListener(onchange);
} catch (e) {
console.log("setForwardMessageListener exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.2

Since

2.4

SDK Support

Y

void setNTPUse(B2BControlNTP mode, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set NTPUse.

Details in English

Set the NTPUse item of the device

Returns

N/A

Parameters

mode
   Set the NTP feature USE or UNUSE
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setNTPUse] success : " + val);
}
var onError = function(error) {
console.log("[setNTPUse] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setNTPUse("USE", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

B2BControlNTP getNTPUse()

   This interface provides methods to get NTPUse status.

Details in English

get NTPUse status

Returns

B2BControlNTP

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var NTPUse = null;
try {
NTPUse = b2bapis.b2bcontrol.getNTPUse();
} catch (e) {
console.log("[getNTPUse] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NTPUse){
console.log("[getNTPUse] call syncFunction type: " + NTPUse);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

void setNTPServerAddress(DOMString address, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set NTPServer address.

Details in English

Set NTP server address of Device

Returns

N/A

Parameters

address
   Set address of NTP Server
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setNTPServerAddress] success : " + val);
}
var onError = function(error) {
console.log("[setNTPServerAddress] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setNTPServerAddress("pool.ntp.org", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

DOMString getNTPServerAddress()

   This interface provides methods to get NTPServerAddress.

Details in English

Get NTPServerAddress of the Device

Returns

DOMString

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var NTPServerAddress = null;
try {
NTPServerAddress = b2bapis.b2bcontrol.getNTPServerAddress();
} catch (e) {
console.log("[getNTPServerAddress] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NTPServerAddress){
console.log("[getNTPServerAddress] call syncFunction type: " + NTPServerAddress);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

void setCurrentTimeZone(DOMString timezone, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set TimeZone.

Details in English

set TimeZone

Returns

N/A

Parameters

timezone
   Set time zone ex) "Asia/Seoul"
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setCurrentTimeZone] success : " + val);
}
var onError = function(error) {
console.log("[setCurrentTimeZone] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setCurrentTimeZone("Asia/Seoul", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

DOMString getCurrentTimeZone()

   This interface provides methods to get TimeZone.

Details in English

get TimeZone

Returns

DOMString

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var TimeZone = null;
try {
TimeZone = b2bapis.b2bcontrol.getCurrentTimeZone();
} catch (e) {
console.log("[getCurrentTimeZone] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NTPServerAddress){
console.log("[getCurrentTimeZone] call syncFunction type: " + TimeZone);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.3

Since

2.4

SDK Support

Y

DOMString deleteAppPrivateInfo( B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to delete app's private Information.

Details in English

delete app's private information

Returns

N/A

Parameters

onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[deleteAppPrivateInfo] success : " + val);
}
var onError = function(error) {
console.log("[deleteAppPrivateInfo] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.deleteAppPrivateInfo(onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.4

Since

3.0

SDK Support

Y

DOMString setHotelID(DOMString HotelID, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set hotel own id.

Details in English

enter the hotel id

Returns

N/A

Parameters

HotelID
   ID of the hotel own webapp
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[setHotelID] success : " + val);
}
var onError = function(error) {
console.log("[setHotelID] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setHotelID("QEDFDCXRED_NT",onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.5

Since

3.0

SDK Support

Y

DOMString getHotelID()

   This interface provides methods to get hotel own id.

Details in English

Get HotelID of Hotel Device

Returns

DOMString

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var hotelid = null;
try {
hotelid = b2bapis.b2bcontrol.getHotelID();
} catch (e) {
console.log("[getHotelID] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== NTPServerAddress){
console.log("[getHotelID] call syncFunction type: " + hotelid);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.5

Since

3.0

SDK Support

Y

void collectLogs(DOMString Operation, DOMString serverUrl, boolean downloadScript, DOMString scriptUrl, long Logduration, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to start and stop device logs upload on remote server.

Details in English

Log collection can be triggered remotely. And log will be uploaded on remote server URL passed through the API

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, if an input parameter is not compatible with its expected type

Returns

N/A

Parameters

Operation
   string , Start/Stop events will be sent to ep-log-manager
serverUrl
   string , Server URL information to upload captured logs
downloadScript
   boolean , It indicates whether to download debug script file from server or it is embedded in web app(false:Embedded script , true:download )
scriptUrl
   string , If debug script is to be downloaded from server
Logduration
   long , It indicated the duration for which ep-log-manager has to keep sending logs to server
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs. 
var onSuccess = function(val) {
console.log("[collectLogs] " + " success " + val);
}
var onError = function(error) {
console.log("[collectLogs] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
console.log("[collectLogs] ");
var Operation = "START";
var serverUrl = "107.109.204.54";
var downloadScript = false;
var scriptUrl = "";
var Logduration = 2; //In hours
b2bapis.b2bcontrol.collectLogs(Operation,serverUrl,downloadScript,scriptUrl,Logduration,onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.6

Since

4.0

SDK Support

Y

void setMagicInfoServerUrl(B2BControlInternetProtocolType ssl, DOMString magicInfoServerAddress, DOMString magicInfoServerPortNumber, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set MagicInfo server address and port.

Details in English

set MagicInfo server address and port.

Returns

N/A

Parameters

ssl
   server SSL of SET
magicInfoServerAddressMagicInfo
   server address of SET
magicInfoServerPortNumberMagicInfo
   server Port Number of MagicInfo server of SET
onSuccess
   Callback method to be invoked when this api success
onError
   optional Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter
B2bAPIException
   with error type InvalidValuesError, Invalid values scope 
var onSuccess = function(val) {
console.log("[setMagicInfoServerUrl] success : " + val);
}
var onError = function(error) {
console.log("[setMagicInfoServerUrl] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setMagicInfoServerUrl("http","10.88.43.36","8080",onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.7

Since

2.4

SDK Support

Y

DOMString getMagicInfoServerUrl()

   This interface provides methods to get MagicInfo server url.

Details in English

Get MagicInfo Server url of SET

Returns

DOMString

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var MagicInfoServerUrl = null;
try {
MagicInfoServerUrl = b2bapis.b2bcontrol.getMagicInfoServerUrl();
} catch (e) {
console.log("[getMagicInfoServerUrl] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== MagicInfoServerUrl){
console.log("[getMagicInfoServerUrl] call syncFunction type: " + MagicInfoServerUrl);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.7

Since

2.4

SDK Support

Y

void setURLLauncherTimeOut(B2BControlTimeoutSetting type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set Timeout of url launcher.

Details in English

Set Timeout of url launcher

Returns

N/A

Parameters

type
   string, enum B2BControlTimeoutSetting
onSuccess
   Callback method to be invoked when this api success
onError
   optional Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onError' parameter
B2bAPIException
   with error type InvalidValuesError, Invalid values scope 
var onSuccess = function(val) {
console.log("[setURLLauncherTimeOut] success : " + val);
}
var onError = function(error) {
console.log("[setURLLauncherTimeOut] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.setURLLauncherTimeOut("90SEC", onSuccess, onError);

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.8

Since

2.4

SDK Support

Y

B2BControlTimeoutSetting getURLLauncherTimeOut()

   This interface provides methods to get time out waiting vaule.

Details in English

Get time out value of url launcher setting

Returns

B2BControlTimeoutSetting

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var TIMEOUT = null;
try {
TIMEOUT = b2bapis.b2bcontrol.getURLLauncherTimeOut();
} catch (e) {
console.log("[getURLLauncherTimeOut] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== TIMEOUT){
console.log("[getURLLauncherTimeOut] call syncFunction type: " + TIMEOUT);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.8

Since

2.4

SDK Support

Y

void setLanguage(B2BControlLanguageType type, B2BControlSuccessCallback onSuccess, optional B2BControlErrorCallback ? onError)

   This interface provides methods to set OSD Language.

Details in English

Set the language of the device.

Returns

N/A

Parameters

type
   string, enum B2BControlLanguageType
onSuccess
   Callback method to be invoked when this api success
onError
   Callback method to be invoked when an error occurs.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter
B2bAPIException
   with error type InvalidValuesError, Invalid values scope

Remark

: If you change the language, App is reloaded. 
var onSuccess = function(val) {
console.log("[setLanguage] " + " success " + val);
}
var onError = function(error) {
console.log("[setLanguage] " + " code :" + error.code + " error name: " + error.name + " message " + error.message);
}
try {
b2bapis.b2bcontrol.setLanguage("en_US", onSuccess, onError); 
} catch (error) {
console.log("[setLanguage]error code = " + error.code);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.9

Since

3.0

Deprecated

5.0

SDK Support

Y

B2BControlLanguageType getLanguage()

   This interface provides methods to OSD Language.

Details in English

Get current selected option for OSD Language

Returns

B2BControlLanguageType

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case. 
var OSDLanguage = null;
try {
OSDLanguage = b2bapis.b2bcontrol.getLanguage();
} catch (e) {
console.log("[getLanguage] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== OSDLanguage){
console.log("[getLanguage] call syncFunction type: " + OSDLanguage);
}

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

Version

1.9

Since

3.0

Deprecated

5.0

SDK Support

Y

'B2BControl::UpdateFirmwareProgressChangedCallback' interface

Public Methods

void onchange(int progress)

Details in English

This method is callback parameter.

Parameters

progress
   provide status

Returns

void

Parameters

listener
   : callback function should be provided in this.

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method. 
function setUpdateFirmwareProgressChangeListener() {
var onchange = function(data) {
console.log("[UpdateFirmwareProgressChangedCallback] progress :" + data + " changed");
}
try {
b2bapis.b2bcontrol.setUpdateFirmwareProgressChangeListener(onchange);
} catch (e) {
console.log("setUpdateFirmwareProgressChangeListener exception [" + e.code + "] name: " + e.name + " message: " + e.message););
}
}

Version

1.2

Since

2.4

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

SDK Support

Y

'B2BControl::B2BControlSuccessCallback' interface

Public Methods

void onsuccess( b2bResult data)

Details in English

This method is callback parameter.

Returns

void

Parameters

data
   provide status

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[deleteAppPrivateInfo] success : " + val);
}
var onError = function(error) {
console.log("[deleteAppPrivateInfo] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.deleteAppPrivateInfo(onSuccess, onError); 
b2bapis.b2bcontrol.deleteAppPrivateInfo(onSuccess, onError);

Version

1.0

Since

2.4

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

SDK Support

Y

'B2BControl::B2BControlErrorCallback' interface

Public Methods

void onerror( b2bError data)

Details in English

This method is callback parameter.

Returns

void
N/A

Exceptions

B2bAPIException
   with error type SecurityError, if the application does not have the privilege to call this method.
B2bAPIException
   with error type UnknownError in any other error case.
B2bAPIException
   with error type TypeMismatchError, Invalid ErrorCallback type passed for 'onerror' parameter 
var onSuccess = function(val) {
console.log("[deleteAppPrivateInfo] success : " + val);
}
var onError = function(error) {
console.log("[deleteAppPrivateInfo] code :" + error.code + " error name: " + error.name + " message " + error.message);
}
b2bapis.b2bcontrol.deleteAppPrivateInfo(onSuccess, onError);

Parameters

data
   provide status

Version

1.0

Since

2.4

Privilege Level

Public

Privilege

http://developer.samsung.com/privilege/b2bcontrol

Product

B2B

SDK Support

Y

COPYRIGHT © SAMSUNG ELECTRONICS CO.,LTD. ALL RIGHTS RESERVED.

관련사이트 바로가기
위로가기