etherpad-lite/doc/jsdoc/AuthorManager.md

60 lines
1.7 KiB
Markdown
Raw Normal View History

2011-05-29 22:30:56 +02:00
#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.
##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.
* **token** The token
* **callback**
###getAuthorColorId (author, callback)
Returns the color Id of the author
* **author**
* **callback**
###getAuthorName (author, callback)
Returns the name of the author
* **author**
* **callback**
###setAuthorColorId (author, colorId, callback)
Sets the color Id of the author
* **author**
* **colorId**
* **callback**
###setAuthorName (author, name, callback)
Sets the name of the author
* **author**
* **name**
* **callback**
##Variables