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

23
README.md
View File

@ -415,7 +415,7 @@ Note: Application Data results are not stored in local IndexedDB by Standard Op
## 4. GENERAL DATA PARAMETERS AND OPTIONS ## 4. GENERAL DATA PARAMETERS AND OPTIONS
### SEND DATA ### SEND GENERAL DATA
Parameters while sending Parameters while sending
* `Message`: Actual Message to be sent * `Message`: Actual Message to be sent
@ -430,15 +430,15 @@ Important: Never use senderIDs in SEND DATA options. The system automatically pi
Type is mandatory in SEND GENERAL DATA because without at least one data identifier like TYPE, the message cannot be retrieved back Type is mandatory in SEND GENERAL DATA because without at least one data identifier like TYPE, the message cannot be retrieved back
### REQUEST DATA ### REQUEST GENERAL DATA
Parameters while requesting Parameters while requesting
* `Type`: User defined type (retrieves all data of that type which the sender might have used in SEND DATA phase) * `Type`: User defined type (retrieves all data of that type which the sender might have used in SEND DATA phase)
#### request options #### request options
* `receiverID` - receiver FLO ID of the data * `receiverID` - receiver FLO ID of the data. ReceiverID is always a single value in our cloud design
* `senderIDs` - array of senderIDs * `senderIDs` - array of senderIDs. This must be in an array even if a single senderID is requested
* `application` - application of the data * `application` - application of the data
* `comment` - comment of the data * `comment` - comment of the data
* `lowerVectorClock` - VC from which the data is to be requested * `lowerVectorClock` - VC from which the data is to be requested
@ -456,7 +456,7 @@ If you want to use requests to give results from all types at one go, use Applic
## 5. OBJECT DATA PARAMETERS AND OPTIONS ## 5. OBJECT DATA PARAMETERS AND OPTIONS
### RESET or UPDATE operations ### RESET or UPDATE OBJECT DATA
Parameters while resetting or updating Parameters while resetting or updating
* `Object Name`: Name of the object with data populated in floGlobals.appObjects[objectName] * `Object Name`: Name of the object with data populated in floGlobals.appObjects[objectName]
@ -471,11 +471,14 @@ Note: Never use senderIDs in RESET and UPDATE. The system automatically picks th
Note: Type field is never used in RESET, UPDATE or REQUEST operations in Object Data. Type field is internally blocked for Object Data. Note: Type field is never used in RESET, UPDATE or REQUEST operations in Object Data. Type field is internally blocked for Object Data.
### REQUEST DATA ### REQUEST OBJECT DATA
#### Mandatory
`Object Name`
#### request options #### request options
* `receiverID` - receiver FLO ID of the data * `receiverID` - receiver FLO ID of the data. ReceiverID is always a single value in our cloud design.
* `senderIDs` - array of senderIDs * `senderIDs` - array of senderIDs. This must be in an array even if a single senderID is requested
* `application` - application of the data * `application` - application of the data
* `comment` - comment of the data * `comment` - comment of the data
* `lowerVectorClock` - VC from which the data is to be requested * `lowerVectorClock` - VC from which the data is to be requested
@ -488,7 +491,7 @@ Note: Type field is never used while RESET, UPDATE or REQUEST operations in Obje
## 6. APPLICATION DATA PARAMETERS, OPTIONS AND EXPLANATIONS ## 6. APPLICATION DATA PARAMETERS, OPTIONS AND EXPLANATIONS
### SEND DATA ### SEND APPLICATION DATA
Parameters while sending Parameters while sending
* `Message`: Actual Message to be sent * `Message`: Actual Message to be sent
@ -503,7 +506,7 @@ Important: Never use senderIDs in SEND DATA options. The system automatically pi
Type is mandatory in SEND APPLICATION DATA because without at least one data identifier like TYPE, the message cannot be retrieved back Type is mandatory in SEND APPLICATION DATA because without at least one data identifier like TYPE, the message cannot be retrieved back
### REQUEST DATA ### REQUEST APPLICATION DATA
#### Mandatory Parameters while requesting #### Mandatory Parameters while requesting
None None