Update README.md
This commit is contained in:
parent
42f493b01b
commit
59dfc6f449
62
README.md
62
README.md
@ -450,15 +450,15 @@ FP97cbzsgTjHn7eyBtKSVcbkSSxZ5jWYHM is the FLO ID of sender
|
|||||||
## 3. Data Types supported by the cloud
|
## 3. Data Types supported by the cloud
|
||||||
|
|
||||||
### User Data Types
|
### User Data Types
|
||||||
`General Data`: Message field can be in any user form.
|
* `General Data`: Message field can be in any user form.
|
||||||
`Object Data`: Message field can only be a JavaScript Object
|
* `Object Data`: Message field can only be a JavaScript Object
|
||||||
|
|
||||||
### System Data Type
|
### System Data Type
|
||||||
`Application Data`: Application data is the base on which General Data system and Object Data system has been created. The formats for General Data and Application Data are exactly the same. Users will never need to use Application Data. So we have deprecated Application Data.
|
* `Application Data`: Application data is the base on which General Data system and Object Data system has been created. The formats for General Data and Application Data are exactly the same. Users will never need to use Application Data. So we have deprecated Application Data.
|
||||||
|
|
||||||
Note:
|
Note:
|
||||||
`General Data:` Type field is mandatory
|
* `General Data:` Type field is mandatory
|
||||||
`Object Data:` Type field has been consumed to create object functionality
|
* `Object Data:` Type field has been consumed to create object functionality
|
||||||
|
|
||||||
|
|
||||||
## 4. General Data
|
## 4. General Data
|
||||||
@ -466,49 +466,49 @@ Note:
|
|||||||
### SEND DATA
|
### SEND DATA
|
||||||
Parameters while sending
|
Parameters while sending
|
||||||
|
|
||||||
`Message`: Actual Message to be sent
|
* `Message`: Actual Message to be sent
|
||||||
`Type`: User defined type (anything that user wants to classify as type)
|
* `Type`: User defined type (anything that user wants to classify as type)
|
||||||
|
|
||||||
#### Options
|
#### Options
|
||||||
`receiverID` - receiver of the data
|
* `receiverID` - receiver of the data
|
||||||
`application` - application using the data
|
* `application` - application using the data
|
||||||
`comment` - user comment of the data
|
* `comment` - user comment of the data
|
||||||
|
|
||||||
### REQUEST DATA
|
### REQUEST DATA
|
||||||
|
|
||||||
#### request options
|
#### request options
|
||||||
`receiverID` - receiver of the data
|
* `receiverID` - receiver of the data
|
||||||
`type` - type of the data ( a free user field)
|
* `type` - type of the data ( a free user field)
|
||||||
`senderIDs` - array of senderIDs
|
* `senderIDs` - array of senderIDs
|
||||||
`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
|
||||||
`upperVectorClock` - VC till which the data is to be requested
|
* `upperVectorClock` - VC till which the data is to be requested
|
||||||
`atVectorClock` - VC at which the data is to requested
|
* `atVectorClock` - VC at which the data is to requested
|
||||||
`mostRecent` - boolean (true: request only the recent data matching the pattern)
|
* `mostRecent` - boolean (true: request only the recent data matching the pattern)
|
||||||
|
|
||||||
## 5. ObjectData
|
## 5. ObjectData
|
||||||
|
|
||||||
### RESET or UPDATE operations
|
### RESET or UPDATE operations
|
||||||
Parameters while resetting or updating
|
Parameters while resetting or updating
|
||||||
`Object Data`
|
* `Object Data`
|
||||||
|
|
||||||
#### Options
|
#### Options
|
||||||
`receiverID` - receiver of the data
|
* `receiverID` - receiver of the data
|
||||||
`application` - application using the data
|
* `application` - application using the data
|
||||||
`comment` - comment of the data
|
* `comment` - comment of the data
|
||||||
|
|
||||||
### REQUEST DATA
|
### REQUEST DATA
|
||||||
|
|
||||||
#### request options
|
#### request options
|
||||||
`receiverID` - receiver of the data
|
* `receiverID` - receiver of the data
|
||||||
`senderIDs` - array of senderIDs
|
* `senderIDs` - array of senderIDs
|
||||||
`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
|
||||||
`upperVectorClock` - VC till which the data is to be requested
|
* `upperVectorClock` - VC till which the data is to be requested
|
||||||
`atVectorClock` - VC at which the data is to requested
|
* `atVectorClock` - VC at which the data is to requested
|
||||||
`mostRecent` - boolean (true: request only the recent data matching the pattern)
|
* `mostRecent` - boolean (true: request only the recent data matching the pattern)
|
||||||
|
|
||||||
## 5. Application Data
|
## 5. Application Data
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user