JavaScript API - Revision history

Andreimios at 15:54, 3 February 2015

2015-02-03T15:54:12Z

Andreimios at 15:21, 3 February 2015

2015-02-03T15:21:50Z

Andreimios at 16:06, 19 November 2014

2014-11-19T16:06:42Z

Andreimios at 13:38, 10 October 2014

2014-10-10T13:38:36Z

Andreimios at 11:17, 10 October 2014

2014-10-10T11:17:30Z

Andreimios at 12:22, 6 October 2014

2014-10-06T12:22:45Z

Andreimios at 08:54, 6 October 2014

2014-10-06T08:54:42Z

Andreimios at 08:53, 6 October 2014

2014-10-06T08:53:10Z

Andreimios at 08:42, 6 October 2014

2014-10-06T08:42:09Z

Andreimios at 08:41, 6 October 2014

2014-10-06T08:41:41Z

@@ Line 583: / Line 583: @@
 * {string} variable - name of the variable
 * {*} value - new value for the variable
-* {object} context Optional - a set of options which can be:
+* {object} options Optional - a set of options which can be:
 - onSuccess: {function} to be called if the call succedes
@@ Line 592: / Line 592: @@
 - dynamic: {Boolean} true - state variable will be set in lu_status (default); false - state variable will be set in user_data
 ==== setDeviceStateVariable(deviceId, service, variable, value, onSuccess, onFailure, context) ====
@@ Line 607: / Line 625: @@
 * {*} onSuccess Optional - function to be called if the call is successfull
 * {*} onFailure Optional - function to be called if the call fails
-* {object} context Optional - context in which to execute the functions of success and/or failure
+* {object} options Optional - a set of options which can be:
 === Events ===

@@ Line 355: / Line 355: @@
 * {object} value for a given variable
 ==== {Object|Boolean} getDeviceTemplate(deviceId) ====
@@ Line 394: / Line 410: @@
 * {*}
-==== {*} getListOfDevices() ====
+==== {Array} getListOfDevices() ====
 - Returns the list of devices from userdata
@@ Line 433: / Line 449: @@
 * {*|Object}
 ==== {*} getSysinfo() ====
@@ Line 522: / Line 570: @@
 * {*} onFailure Optional - function to be called if the call fails
 * {object} context Optional - context in which to execute the functions of success and/or failure
 ==== setDeviceStateVariable(deviceId, service, variable, value, onSuccess, onFailure, context) ====

@@ Line 264: / Line 264: @@
 * {Object}
 ==== {string} getCpanelContent() ====
@@ Line 292: / Line 302: @@
 * {*} onFailure Optional - function to be called if the call fails
 * {object} context Optional - context in which to execute the functions of success and/or failure
 ==== {number} getDeviceIndex(deviceId) ====
@@ Line 381: / Line 401: @@
 * {*}
 ==== getLuSdata(onSuccess, onFailure, context) ====
@@ Line 405: / Line 433: @@
 * {*|Object}
 ==== {*} getUserData() ====
@@ Line 415: / Line 453: @@
 * {*} object containing userdata
 ==== registerEventHandler(eventName, object, functionName) ====

← Older revision		Revision as of 13:38, 10 October 2014
Line 648:		Line 648:
	** parameters: idForDeviceWhichOpenedTheCpanel		** parameters: idForDeviceWhichOpenedTheCpanel

		+	=== Migration Walkthrough for plugins with JS ===
		+
		+	With the introduction of our new JavaScript API, plugin mechanism slightly changed. In order to keep a backward compatibility with the UI5 version, there are a couple of thing a developer should do :
		+
		+	* '''Update the JS file using the JavaScript API'''
		+
		+	* '''Update the JSON file with proper calls for JavaScript functions'''
		+
		+	For UI5 version, the JavaScript functions were called in JSON file like this :
		+
		+	'''"ScriptName": "Your_JS_File.js",'''
		+
		+	'''"Function": "Your_Function_Name"'''
		+
		+	Example: Home Care Plugin - JSON file:
		+
		+	<source lang="javascript">
		+	{
		+	"Label": {
		+	"lang_tag": "users",
		+	"text": "Users"
		+	},
		+	"TopNavigationTab": "1",
		+	"Position": "0",
		+	"TabType": "javascript",
		+	"ScriptName": "J_HomeCare.js",
		+	"Function": "ShowUsers"
		+	},
		+	</source>
		+
		+	For UI7, the JavaScript functions are called like this :
		+
		+	'''"ScriptName": "Your_JS_File_for_UI7.js",'''
		+
		+	'''"Function": "Your_Class_Name.Your_Function_Name"'''
		+
		+	Example:
		+
		+	<source lang="javascript">
		+	{
		+	"Label": {
		+	"lang_tag": "users",
		+	"text": "Users"
		+	},
		+	"TopNavigationTab": "1",
		+	"Position": "0",
		+	"TabType": "javascript",
		+	"ScriptName": "J_HomeCare_UI7.js",
		+	"Function": "HomeCare.ShowUsers"
		+	},
		+	</source>
		+
		+	By now, you should be asking yourself: "How plugin will work on UI5 if I update these files?". If you answer by yourself and the answer is : "It won't work", you are right. For this you will need to do an additional step:
		+
		+	*'''Create different JSON and JS files and perform a check in your Luup code'''
		+	**As you can see in the above example for JSON file, our choice was to add "''_UI7''" for our JS file : "''J_HomeCare_UI7.js''". We suggest you to do the same, but this is not a requirement. We did the same with JSON file : "''D_HomeCare_UI7.json''"
		+	**In order to use the new JSON and JS files in UI7 instead of UI5 versions, "device_json" attribute of your device must set with the JSON file for UI7. For this, you can use the following function:
		+	<source lang="lua">
		+	local function checkVersion()
		+	local ui7Check = luup.variable_get(SID, "UI7Check", lug_device) or ""
		+	if ui7Check == "" then
		+	luup.variable_set(SID, "UI7Check", "false", lug_device)
		+	ui7Check = "false"
		+	end
		+	if( luup.version_branch == 1 and luup.version_major == 7 and ui7Check == "false") then
		+	luup.variable_set(SID, "UI7Check", "true", lug_device)
		+	luup.attr_set("device_json", "Your_UI7_JSON_File", lug_device)
		+	luup.reload()
		+	end
		+	end
		+	</source>
		+	''SID'' - your Service ID; ''lug_device'' - your device ID;
		+	**Call ''checkVersion()'' in your initialization function, before doing something else.

	=== HomeCare Plugin - updated for UI7 ===		=== HomeCare Plugin - updated for UI7 ===

@@ Line 649: / Line 649: @@
-=== Example files for UI7 ===
+=== HomeCare Plugin - updated for UI7 ===
-We use the HomeCare plugin for example. Below you can download the JSON and JavaScript files for both UI5 and UI7:
+We use the HomeCare plugin as example for what need to be added/updated for UI7. Below you can download plugin files:
 [[File:HomeCare.zip]]

← Older revision		Revision as of 12:22, 6 October 2014
Line 647:		Line 647:
	** fired before closing the cpanel to allow plugins to cleanup their data		** fired before closing the cpanel to allow plugins to cleanup their data
	** parameters: idForDeviceWhichOpenedTheCpanel		** parameters: idForDeviceWhichOpenedTheCpanel
		+
		+
		+	=== Example files for UI7 ===
		+
		+	We use the HomeCare plugin for example. Below you can download the JSON and JavaScript files for both UI5 and UI7:
		+
		+	[[File:HomeCare.zip]]

← Older revision		Revision as of 08:53, 6 October 2014
Line 474:		Line 474:
	* {*} onFailure Optional - function to be called if the call fails		* {*} onFailure Optional - function to be called if the call fails
	* {object} context Optional - context in which to execute the functions of success and/or failure		* {object} context Optional - context in which to execute the functions of success and/or failure
		+
		+	=== Events ===
		+
		+	The list of available events can be obtained with the following command:
		+
		+	'''api.getListOfSupportedEvents()'''
		+
		+	* on_startup_showModalLoading
		+	** triggered before loading resources in the browser
		+	*on_startup_luStatusLoaded
		+	** triggered after luStatus was successfully parsed
		+	** parameter: luStatusObject
		+	* on_startup_show2gInterface
		+	** triggered after requesting account devices only if UI is not in ‘local mode’ and ‘slowConnection’ flag is set
		+	* on_ui_requireSave
		+	** triggered if user data was changed and save wasn’t issued
		+	* on_ui_userDataFirstLoaded
		+	** fired if user data was loaded for the first time
		+	* on_ui_staticDataAdded
		+	** fired if static_data was added to user data
		+	** parameter: staticDataObject
		+	* on_ui_staticDataChanged
		+	** fired if static_data was changed after parsing user data
		+	** parameter: changedStaticDataObject
		+	* on_ui_staticDataRemoved
		+	** fired if static_data was removed after parsing user data
		+	** parameter: idForRemovedStaticDataObject
		+	* on_ui_setupDeviceAdded
		+	** fired if new setup device (menu item) is added
		+	** parameter: setupDeviceObject
		+	* on_ui_setupDeviceChanged
		+	** fired if setup device (menu item) is changed
		+	** parameter: changedSetupDeviceObject
		+	* on_ui_setupDeviceRemoved
		+	** fired if setup device (menu item) is removed
		+	** parameter: idForRemovedSetupDeviceObject
		+	* on_ui_sectionAdded
		+	** triggered when new section is added
		+	** parameter: sectionObject
		+	* on_ui_sectionChanged
		+	** fired after section was changed
		+	** parameter: changedSectionObject
		+	* on_ui_sectionRemoved
		+	** fired after section was removed
		+	** parameter: idForRemovedSectionObject
		+	* on_ui_roomAdded
		+	** fired when new room was added to user data
		+	** parameter: roomObject
		+	* on_ui_roomChanged
		+	** fired after room was changed
		+	** parameter: changedRoomObject
		+	* on_ui_roomRemoved
		+	** fired after room was removed from user data
		+	** parameter: idForRemovedRoomObject
		+	* on_ui_deviceAdded
		+	** fired after device was added to user data
		+	** parameter: deviceObject
		+	*** wrapper object for
		+	**** device: this is the actual object representing the device
		+	**** deviceTemplate: object with the static data associated to this device type
		+	* on_ui_deviceChanged
		+	** fired after device was found changed in user data
		+	** parameter: changedDeviceObject
		+	*** wrapper object for
		+	**** device: this is the actual object representing the device
		+	**** deviceTemplate: object with the static data associated to this device type
		+	* on_ui_deviceRemoved
		+	** fired after device was found removed from user data
		+	** parameter: idForRemovedDeviceObject
		+	* on_ui_deviceJobsReceived
		+	** fired when jobs are found for a device in lu_status
		+	** parameter: deviceObjectFromLuStatus
		+	* on_ui_sceneAdded
		+	** fired after scene was added
		+	** parameter: sceneObject
		+	* on_ui_sceneChanged
		+	** fired after scene was changed
		+	** parameter: changedSceneObject
		+	* on_ui_sceneChanged
		+	** fired when scene is removed
		+	** parameter: idForRemovedSceneObject
		+	* on_ui_pluginAdded
		+	** triggered when plugin is added to user data
		+	** parameter: pluginObject
		+	* on_ui_pluginChanged
		+	** triggered when plugin is changed
		+	** parameter: changedPluginObject
		+	* on_ui_pluginRemoved
		+	** triggered when plugin is removed
		+	** parameter: idForRemovedPluginObject
		+	* on_ui_extraSubmenuItemAdded
		+	** triggered when extra submenu item is added
		+	** parameter: extraSubmenuItemObject
		+	*** wrapper for:
		+	**** submenuItem: object containing submenu item
		+	**** deviceType: string which contains the type of device for which the submenu item is added
		+	* on_ui_extraSubmenuItemChanged
		+	** triggered when extra submenu item is changed
		+	** parameter: changedExtraSubmenuItemObject
		+	*** wrapper for:
		+	**** oldObj: contains previous submenu item
		+	**** newObj: wrapper for:
		+	***** submenuItem: object containing submenu item
		+	***** deviceType: string which contains the type of device for which the submenu item is added
		+	* on_ui_extraSubmenuItemRemoved:
		+	** triggered when an extra submenu item is removed
		+	** parameter: idForRemovedExtraSubmenuItemObject
		+	* on_ui_cardAdded
		+	** triggered when card is added to user data
		+	** parameter: cardObject
		+	* on_ui_cardChanged
		+	** triggered when card is found changed in user data
		+	** parameter: changedCardObject
		+	* on_ui_cardRemoved
		+	** triggered when card is removed from user data
		+	** parameter: idForRemovedCardObject
		+	* on_ui_jobsUpdated
		+	** triggered when job is updated in lu_status
		+	** parameter: luStatusJobsObject
		+	* on_ui_deviceStatusChanged
		+	** triggered when device status is changed
		+	** parameter: deviceObjectFromLuStatus
		+	* on_ui_syncClock
		+	** triggered after lu_status is parsed
		+	** parameter: luStatusLocalTime
		+	* on_ui_initFinished
		+	** fired when init has finished (UI should be ready now)
		+	* on_ui_setUserAuthenticated
		+	** fired after login is successful
		+	* on_ui_saveFinished
		+	** fired after save is finished
		+	* on_ui_initNotLogged
		+	** triggered if user is not logged in
		+	* on_ui_alertsUpdated
		+	** fired after alert list was updated
		+	* on_ui_refreshDashboardCards
		+	** triggered when dashboard cards are refreshed
		+	* on_ui_engineAvailable
		+	** triggered if engine is not busy
		+	* on_ui_2GEnabled
		+	** triggered when parsing lu_status if 2G is enabled
		+	* on_ui_userDataSetTemperatureFormat
		+	** triggered after temperature format is set in user data
		+	** parameter: userDataObject
		+	* on_ui_userDataLoaded
		+	** triggered after user data parsing is completed
		+	* on_parseUserData
		+	** triggered when user data parsing is started
		+	* on_ui_accountUnitsLoaded
		+	** fired after account lis from MMS was successfully loaded
		+	* accountInformationLoaded
		+	** triggered after account information is loaded
		+	** parameter: accountInfoObject
		+	* on_ui_finishDrawingMenu
		+	** triggered after parsing of user data setup devices has finished
		+	* on_ui_deviceTypeChanged
		+	** triggered if device type for a device has changed
		+	** parameter: deviceObject
		+	*** wrapper object for
		+	**** device: this is the actual object representing the device
		+	**** deviceTemplate: object with the static data associated to this device type
		+	* on_ui_hideModalLoading
		+	** triggered each time a time consuming job finishes (so that UI can hide modal loading)
		+	* on_ui_showUserDataSaveFailure
		+	** triggered if user data save has failed
		+	* on_ui_showErrorMessage
		+	** fired if application has error message to send to the UI
		+	* on_ui_cpanel_before_close
		+	** fired before closing the cpanel to allow plugins to cleanup their data
		+	** parameters: idForDeviceWhichOpenedTheCpanel

← Older revision		Revision as of 08:42, 6 October 2014
Line 474:		Line 474:
	* {*} onFailure Optional - function to be called if the call fails		* {*} onFailure Optional - function to be called if the call fails
	* {object} context Optional - context in which to execute the functions of success and/or failure		* {object} context Optional - context in which to execute the functions of success and/or failure
−
−	~~=== Events ===~~
−
−	~~The list of available events can be obtained with the following command:~~
−
−	~~'''api.getListOfSupportedEvents()'''~~

← Older revision		Revision as of 08:41, 6 October 2014
Line 474:		Line 474:
	* {*} onFailure Optional - function to be called if the call fails		* {*} onFailure Optional - function to be called if the call fails
	* {object} context Optional - context in which to execute the functions of success and/or failure		* {object} context Optional - context in which to execute the functions of success and/or failure
		+
		+	=== Events ===
		+
		+	The list of available events can be obtained with the following command:
		+
		+	'''api.getListOfSupportedEvents()'''