mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-24 01:16:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

Documentation

Browse source
This commit is contained in:
Peter 'Pita' Martischka 2011-05-30 15:53:11 +01:00
parent 88297a99ef
commit f7b46f6e69
22 changed files with 368 additions and 447 deletions
Download patch file Download diff file Expand all files Collapse all files

64
doc/jsdoc/AuthorManager.md
View file

@ -1,59 +1,41 @@
#AuthorManager
# AuthorManager
`require("./AuthorManager");`
2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The AuthorManager controlls all information about the Pad authors
##Functions
## Functions
###getAuthor4Token (token, callback)
2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### getAuthor4Token (token, callback)
Returns the Author Id for a token. If the token is unkown,
it creates a author for the token
* **token** The token
* **callback**
* **token** *(String)* The token
* **callback** *(Function)* callback (err, author)
The callback function that is called when the result is here
###getAuthorColorId (author, callback)
### getAuthorColorId (author, callback)
Returns the color Id of the author
* **author**
* **callback**
* **author** *(String)* The id of the author
* **callback** *(Function)* callback(err, colorId)
###getAuthorName (author, callback)
### getAuthorName (author, callback)
Returns the name of the author
* **author**
* **callback**
* **author** *(String)* The id of the author
* **callback** *(Function)* callback(err, name)
###setAuthorColorId (author, colorId, callback)
### setAuthorColorId (author, colorId, callback)
Sets the color Id of the author
* **author**
* **colorId**
* **callback**
* **author** *(String)* The id of the author
* **colorId** *No description*
* **callback** *(Function)* (optional)
###setAuthorName (author, name, callback)
### setAuthorName (author, name, callback)
Sets the name of the author
* **author**
* **name**
* **callback**
##Variables
* **author** *(String)* The id of the author
* **name** *No description*
* **callback** *(Function)* (optional)