RanchiMall/webAppServer
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sai Raj 2020-02-26 16:03:36 +05:30 committed by GitHub
parent f1857d8161
commit be2d4916f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -18,18 +18,18 @@ This server is used to get the appObjects and generalData for the webApp clients
#### sendGeneralData
webAppClient.sendGeneralData(message, type, options = {})
Sends a message to the cloud via webAppServer
message: content of the message
type: type of the message
* message: content of the message
* type: type of the message
#### requestGeneralData
webAppClient.requestGeneralData(type, vectorClock = '0')
Requests the generalData from webAppServer
type: type of the message
vectorClock: vectorClock after which the message should be requested (can be used with Date.now()) (default = '0')
Returns an object (set of generalData)
* type: type of the message
* vectorClock: vectorClock after which the message should be requested (can be used with Date.now()) (default = '0')
* Returns an object (set of generalData)
#### requestObjectData
webAppClient.requestObjectData(keyPath)
Requests the objectData/appObjects from webAppServer
path: (an Array) path of the required object (eg. \['Sample', Property1, property2..]
Returns an Object/Array (requested path)
* path: (an Array) path of the required object (eg. \['Sample', Property1, property2..]
* Returns an Object/Array (requested path)