mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-01-20 06:29:53 +01:00
Merge pull request #982 from marcelklehr/doc/getAuthorName
Add in docs for getAuthorName API method
This commit is contained in:
commit
0b072023f0
1 changed files with 4 additions and 1 deletions
|
@ -136,7 +136,7 @@ Pads can belong to a group. The padID of grouppads is starting with a groupID li
|
||||||
* `{code: 1, message:"groupID does not exist", data: null}`
|
* `{code: 1, message:"groupID does not exist", data: null}`
|
||||||
|
|
||||||
### Author
|
### Author
|
||||||
Theses authors are bind to the attributes the users choose (color and name).
|
These authors are bound to the attributes the users choose (color and name).
|
||||||
|
|
||||||
* **createAuthor([name])** creates a new author <br><br>*Example returns:*
|
* **createAuthor([name])** creates a new author <br><br>*Example returns:*
|
||||||
* `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
|
* `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
|
||||||
|
@ -148,6 +148,9 @@ Theses authors are bind to the attributes the users choose (color and name).
|
||||||
* `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}`
|
* `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}`
|
||||||
* `{code: 1, message:"authorID does not exist", data: null}`
|
* `{code: 1, message:"authorID does not exist", data: null}`
|
||||||
|
|
||||||
|
* **getAuthorName(authorID)** Returns the Author Name of the author <br><br>*Example returns:*
|
||||||
|
* `{code: 0, message:"ok", data: {authorName: "John McLear"}}`
|
||||||
|
|
||||||
-> can't be deleted cause this would involve scanning all the pads where this author was
|
-> can't be deleted cause this would involve scanning all the pads where this author was
|
||||||
|
|
||||||
### Session
|
### Session
|
||||||
|
|
Loading…
Reference in a new issue