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

Update README.md

Browse Source
This commit is contained in:
tripathyr 2020-07-05 17:15:35 +05:30 committed by GitHub
parent e065f688af
commit 70f8cd95b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -358,7 +358,7 @@ This module contains functions that interact with the supernode to send and retr
## FLO Cloud API operations ## FLO Cloud API operations
`floCloudAPI` operations can interact with floSupernode cloud to send and retrieve data for applications. floCloudAPI uses floSupernode module for backend interactions. `floCloudAPI` operations can interact with floSupernode cloud to send and retrieve data for applications. floCloudAPI uses floSupernode module for backend interactions.
#### Important: FLO Cloud API operations have all been promisified. All output needs to be handled using .then These operations do not return function return values. Once again, they resolve: they do not return. FLO Cloud API operations have all been promisified. All output needs to be handled using .then These operations do not return function return values. Once again, they resolve: they do not return.
#### sendGeneralData #### sendGeneralData
floCloudAPI.sendGeneralData(message, type, options = {}) floCloudAPI.sendGeneralData(message, type, options = {})
@ -378,7 +378,9 @@ This module contains functions that interact with the supernode to send and retr
`resetObjectData` resets the objectData to cloud. `resetObjectData` resets the objectData to cloud.
1. objectName - Name of the objectData to be reset 1. objectName - Name of the objectData to be reset
2. options - (optional, options detailed at end of module) 2. options - (optional, options detailed at end of module)
Note: value of objectData is taken from floGlobals.appObjects[objectName] Note: value of objectData is taken from floGlobals.appObjects[objectName]
The object data corresponding with Object Name must be defined in floGlobals.appObjects[objectName] before a reset can be done The object data corresponding with Object Name must be defined in floGlobals.appObjects[objectName] before a reset can be done
#### updateObjectData #### updateObjectData
@ -386,7 +388,9 @@ The object data corresponding with Object Name must be defined in floGlobals.app
`updateObjectData` updates the objectData to cloud. `updateObjectData` updates the objectData to cloud.
1. objectName - Name of the objectData to be updated 1. objectName - Name of the objectData to be updated
2. options - (optional, options detailed at end of module) 2. options - (optional, options detailed at end of module)
Note: value of objectData is taken from floGlobals.appObjects[objectName] Note: value of objectData is taken from floGlobals.appObjects[objectName]
The object data corresponding with Object Name must be defined in floGlobals.appObjects[objectName] before an update can be done The object data corresponding with Object Name must be defined in floGlobals.appObjects[objectName] before an update can be done
#### requestObjectData #### requestObjectData
@ -394,6 +398,7 @@ The object data corresponding with Object Name must be defined in floGlobals.app
`requestObjectData` requests application data from the cloud. `requestObjectData` requests application data from the cloud.
1. objectName - Name of the objectData to be requested 1. objectName - Name of the objectData to be requested
2. options - (optional, options detailed at end of module) 2. options - (optional, options detailed at end of module)
Note: The output is available at floGlobals.appObjects[objectName] after the promise is resolved Note: The output is available at floGlobals.appObjects[objectName] after the promise is resolved
#### sendApplicationData #### sendApplicationData