added full comments to the new API functions.

Signed-off-by: Bernard `Guyzmo` Pratz <guyzmo+github@m0g.net>
pull/1693/head
Bernard `Guyzmo` Pratz 2013-04-04 19:07:11 +02:00
parent 3df3b90bd9
commit 0e5a89becc
1 changed files with 33 additions and 1 deletions

View File

@ -77,19 +77,51 @@ exports.listSessionsOfAuthor = sessionManager.listSessionsOfAuthor;
/**
getAttributePool(padID) returns the attribute pool of a pad
Example returns:
{
"code":0,
"message":"ok",
"data": {
"pool":{
"numToAttrib":{
"0":["author","a.X4m8bBWJBZJnWGSh"],
"1":["author","a.TotfBPzov54ihMdH"],
"2":["author","a.StiblqrzgeNTbK05"],
"3":["bold","true"]
},
"attribToNum":{
"author,a.X4m8bBWJBZJnWGSh":0,
"author,a.TotfBPzov54ihMdH":1,
"author,a.StiblqrzgeNTbK05":2,
"bold,true":3
},
"nextNum":4
}
}
}
*/
exports.getAttributePool = function (padID, callback)
{
getPadSafe(padID, true, function(err, pad)
{
if (ERR(err, callback)) return;
callbalk(null, {pool: pad.pool});
callback(null, {pool: pad.pool});
});
}
/**
getRevisionChangeset (padID, [rev])
get the changeset at a given revision, or last revision if 'rev' is not defined.
Example returns:
{
"code" : 0,
"message" : "ok",
"data" : "Z:1>6b|5+6b$Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at http://etherpad.org\n"
}
*/
exports.getRevisionChangeset = function(padID, rev, callback)
{