Static

• ​Box.getSpace​

• ​Box.listSpaces​

Stateful

• ​space.public.get​

• ​space.private.get​

• ​space.public.all​

• ​space.private.all​

• ​space.public.getMetadata​

• ​space.private.getMetadata​

• ​space.public.log​

• ​space.private.log​

Static

Box.getSpace(address, name, opts)

Get the public data in a space of a given address with the given name

Kind: static method of Box Returns: Object - a json object with the public space data

Box.listSpaces(address, opts)

Get the names of all spaces a user has

Kind: static method of Box Returns: Object - an array with all spaces as strings

Stateful

The space object is an instance of a particular space. See the Auth section for how to create an instance of a space.

space.public.get(key, opts)

Get the value and optionally metadata of the given key

Kind: instance method of KeyValueStore Returns: String | Object - the value associated with the key, undefined if there's no such key

space.private.get(key, opts)

Get the value and optionally metadata of the given key

Kind: instance method of KeyValueStore Returns: String | Object - the value associated with the key, undefined if there's no such key

space.public.all(opts)

Get all values in the public store of the space, and optionally all its metadata.

Kind: instance method of KeyValueStore Returns: String | Object - the value associated with the key, undefined if there's no such key

space.private.all(opts)

Get all values in the private store of the space, and optionally all its metadata. This method requires the user to sign before gaining access.

Kind: instance method of KeyValueStore Returns: String | Object - the value associated with the key, undefined if there's no such key

space.public.getMetadata(key)

Get metadata for for a given key

Kind: instance method of KeyValueStore Returns: Metadata - Metadata for the key, undefined if there's no such key

space.private.getMetadata(key)

Get metadata for for a given key

Kind: instance method of KeyValueStore Returns: Metadata - Metadata for the key, undefined if there's no such key

space.public.log

Returns array of underlying log entries. In linearized order according to their Lamport clocks. Useful for generating a complete history of all operations on store.

Kind: instance property of KeyValueStore Returns: Array.<Object> - Array of ordered log entry objects

const log = store.log
 const entry = log[0]
 console.log(entry)
 // { op: 'PUT', key: 'Name', value: 'Botbot', timeStamp: '1538575416068' }

space.private.log

Returns array of underlying log entries. In linearized order according to their Lamport clocks. Useful for generating a complete history of all operations on store.

Kind: instance property of KeyValueStore Returns: Array.<Object> - Array of ordered log entry objects

const log = store.log
 const entry = log[0]
 console.log(entry)
 // { op: 'PUT', key: 'Name', value: 'Botbot', timeStamp: '1538575416068' }

​