diff options
| author | Marcel Klehr <mklehr@gmx.net> | 2012-09-06 12:13:41 +0200 |
|---|---|---|
| committer | Marcel Klehr <mklehr@gmx.net> | 2012-09-06 12:13:41 +0200 |
| commit | eeb605334fcca2bd1ec27fd8ba9769f6a0dcb38a (patch) | |
| tree | 1db38686f3d8189139d77b078cb8a8a61df56e89 | |
| parent | 3cbd59c769b639556dd4cca3841c21acf79ebcf8 (diff) | |
| download | etherpad-lite-eeb605334fcca2bd1ec27fd8ba9769f6a0dcb38a.zip | |
Add in docs for getAuthorName API method
| -rw-r--r-- | doc/api/http_api.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/http_api.md b/doc/api/http_api.md index bfde6086..058a2ba6 100644 --- a/doc/api/http_api.md +++ b/doc/api/http_api.md @@ -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}` ### 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:* * `{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: 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 ### Session |