libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
etherpad-lite/doc/jsdoc/AuthorManager.md
Peter 'Pita' Martischka c4325a050f Beautify the docs
2011-05-30 16:05:42 +01:00

1.1 KiB
Raw Blame History

AuthorManager

require("./AuthorManager");

The AuthorManager controlls all information about the Pad authors

Functions

getAuthor4Token (token, callback)

Returns the Author Id for a token. If the token is unkown, it creates a author for the token

  • token (String) The token
  • callback (Function) callback (err, author) The callback function that is called when the result is here

getAuthorColorId (author, callback)

Returns the color Id of the author

  • author (String) The id of the author
  • callback (Function) callback(err, colorId)

getAuthorName (author, callback)

Returns the name of the author

  • author (String) The id of the author
  • callback (Function) callback(err, name)

setAuthorColorId (author, colorId, callback)

Sets the color Id of the author

  • author (String) The id of the author
  • colorId No description
  • callback (Function) (optional)

setAuthorName (author, name, callback)

Sets the name of the author

  • author (String) The id of the author
  • name No description
  • callback (Function) (optional)