Documents

Maintainer:	Jorin Vogel h.nosp@m.i@jori.nosp@m.n.in
Version:	0.1.3

This modue stores lists of documents. A document has the fields title, content and lastEdited.

Summary

Documents
Schemas
documents/text	A text document
Functions
privateList	List all private documents.
publicList	List all public documents.
listMethods
Functions
add	Create a new document
set	Update or create a document for a specified id.
remove	Remove a document for a specified id.
get	Get a document.
addRaw	Store a raw document of the specified contentType at shared/.
setRaw	Store a raw doccument of the specified contentType at shared/.

Schemas

documents/text

A text document

Properties

title	title of the document (string, required)
content	content of the document (string, required)
lastEdited	13-digit timestamp for when the document was last edited

Functions

privateList

privateList: function( path )

List all private documents.

Parameters

path	a pathstring where to scope the client to.

Returns

A privateClient scoped to the given path and extended with the listMethods. It also supports all BaseClient methods

publicList

publicList: function( path )

List all public documents.

Parameters

path	a pathstring where to scope the client to.

Returns

A publicClient scoped to the given path and extended with the listMethods. It also supports all BaseClient methods

listMethods

Summary

Functions
add	Create a new document
set	Update or create a document for a specified id.
remove	Remove a document for a specified id.
get	Get a document.
addRaw	Store a raw document of the specified contentType at shared/.
setRaw	Store a raw doccument of the specified contentType at shared/.

Functions

add

add: function( doc )

Create a new document

Parameters

doc	the document data to store as JSON object.

Returns

A promise, which will be fulfilled with the created document as JSON object. The created document also contains the newly created id property.

set

set: function( id,
doc )

Update or create a document for a specified id.

Parameters

id	the id the document is at.
doc	the document data to store as JSON object.

Returns

A promise, which will be fulfilled with the updated document.

remove

remove: function( id )

Remove a document for a specified id.

Parameters

id	the id the document is at.

Returns

A promise, which will be fulfilled when the change was made locally. After that, the change will propagate from local to remote through asynchronous synchronization.

get

get: function( id )

Get a document.

Parameters

id	the id of the document you want to get.

Returns

A promise, which will be fulfilled with the document as JSON object.

addRaw

addRaw: function( contentType,
data )

Store a raw document of the specified contentType at shared/.

Parameters

contentType	the content type of the data (like ‘text/html’).
data	the raw data to store.

Returns

A promise, which will be fulfilled with the path of the added document.

setRaw

setRaw: function( id,
contentType,
data )

Store a raw doccument of the specified contentType at shared/.

Parameters

id	id of the document to update
contentType	the content type of the data (like ‘text/html’).
data	the raw data to store.

Returns

A promise, which will be fulfilled with the path of the added document.