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 13:12:16 +05:30 committed by GitHub
parent 39a09be7d9
commit beebb5795a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -367,11 +367,16 @@ This module contains functions that interact with the supernode to send and retr
2. type - type of the data 2. type - type of the data
3. options - (optional, options detailed at end of module) 3. options - (optional, options detailed at end of module)
Note: type is mandatory while sending but optional while requesting in case of Application Data. This allows ApplicationData to span different types in retrieval.
#### requestApplicationData #### requestApplicationData
floCloudAPI.requestApplicationData(options = {}) floCloudAPI.requestApplicationData(options = {})
`requestApplicationData` requests application data from the cloud. `requestApplicationData` requests application data from the cloud.
1. options - (optional, options detailed at end of module) 1. options - (optional, options detailed at end of module)
Note: type is mandatory while sending but optional while requesting in case of Application Data. This allows ApplicationData to span different types in retrieval.
#### sendGeneralData #### sendGeneralData
floCloudAPI.sendGeneralData(message, type, options = {}) floCloudAPI.sendGeneralData(message, type, options = {})
`sendGeneralData` sends general data to the cloud. `sendGeneralData` sends general data to the cloud.
@ -390,26 +395,28 @@ 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 Note: value of objectData is taken from floGlobals.appObjects[objectName]
#### updateObjectData #### updateObjectData
floCloudAPI.updateObjectData(objectName, options = {}) floCloudAPI.updateObjectData(objectName, options = {})
`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 Note: value of objectData is taken from floGlobals.appObjects[objectName]
#### requestObjectData #### requestObjectData
floCloudAPI.requestObjectData(objectName, options = {}) floCloudAPI.requestObjectData(objectName, options = {})
`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 resolved output is available at floGlobals.appObjects[objectName]
#### options: #### options:
* send options: * send options:
* receiverID - received of the data * receiverID - received of the data
* application - application of the data * application - application of the data
* comment - comment of the data * comment - comment of the data
* request options * request options
* receiverID - received of the data * receiverID - received of the data