mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-24 17:36:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

updated documentation

Browse source
This commit is contained in:
Peter 'Pita' Martischka 2011-07-30 17:15:45 +01:00
parent f1d06c55b4
commit 0772f6bb4e
16 changed files with 188 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/jsdoc/AuthorManager.md
View file

@ -1,46 +0,0 @@
# 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)