API: echo → KvsAPI class

class KvsAPI

Key-Value Store API for Echo

Constructor

Constructor Parameters Returns

Constructor	Parameters	Returns
`KvsAPI( parameters )`	Parameters: `parameters <Object>` object for options parameters.consumerKey parameters.consumerSecret parameters.authMethod : optional, in ['oauth','basic']. Default 'oauth'


                      KvsAPI(
                      parameters
                      )

Parameters:

parameters <Object> object for options
- parameters.consumerKey
- parameters.consumerSecret
- parameters.authMethod : optional, in ['oauth','basic']. Default 'oauth'

Methods

Methods Returns Description

Methods	Returns	Description
`del kvs.key : key of the value to retrieve kvs.public : (optional) indicate if the KV pair is public or not ( callback )`	`void`	↑ Delete KV pair Parameters: `callback <function>` callback
`get( kvs, appkey, callback )`	`void`	↑ Fetch data from the Echo Key-Value Store. Parameters: `kvs <object>` Key of the value to retrieve. Specify: kvs.key : key of the value to retrieve kvs.public : (optional) indicate if the KV pair is public or not `appkey <string>` : customer application key `callback <function>` callback
`put( kvs, callback )`	`void`	↑ Put data into the Echo Key-Value database to store the third-party widgets' arbitrary data elements permanently. Parameters: `kvs <object>` Key-Value pair to store. Specify: kvs.key : key kvs.value : value kvs.public : (optional, boolean) indicates if value is public or not (default: false) `callback <function>` callback


                          del

kvs.key : key of the value to retrieve
kvs.public : (optional) indicate if the KV pair is public or not
(
                          callback
                          )


                          void

↑ Delete KV pair

Parameters:

callback <function> callback


                          get(
                          kvs, appkey, callback
                          )


                          void

↑ Fetch data from the Echo Key-Value Store.

Parameters:

kvs <object> Key of the value to retrieve. Specify:
- kvs.key : key of the value to retrieve
- kvs.public : (optional) indicate if the KV pair is public or not
appkey <string> : customer application key
callback <function> callback


                          put(
                          kvs, callback
                          )


                          void

↑ Put data into the Echo Key-Value database to store the third-party widgets' arbitrary data elements permanently.

Parameters:

kvs <object> Key-Value pair to store. Specify:
- kvs.key : key
- kvs.value : value
- kvs.public : (optional, boolean) indicates if value is public or not (default: false)
callback <function> callback