diff options
| author | Mark Holmquist <mtraceur@member.fsf.org> | 2012-08-17 11:46:34 -0700 |
|---|---|---|
| committer | Mark Holmquist <mtraceur@member.fsf.org> | 2012-08-17 13:39:16 -0700 |
| commit | f9469ef2569d30a848be6e16d8188748cd2a760a (patch) | |
| tree | 50621b01d074a2e88ab8471aeb75d1889b2c5ec3 /doc | |
| parent | 9b1673c60fd6f080291c98d1fb59f5c38cc28e61 (diff) | |
| download | etherpad-lite-f9469ef2569d30a848be6e16d8188748cd2a760a.zip | |
Add in padUsers HTTP API call
I needed the list of users this time, so I got it. There are docs
and everything.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http_api.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/http_api.md b/doc/api/http_api.md index d51f42c4..335efb3c 100644 --- a/doc/api/http_api.md +++ b/doc/api/http_api.md @@ -206,6 +206,10 @@ Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security * **padUsersCount(padID)** returns the number of user that are currently editing this pad <br><br>*Example returns:* * `{code: 0, message:"ok", data: {padUsersCount: 5}}` +* **padUsers(padID)** returns the list of users that are currently editing this pad <br><br>*Example returns:* + * `{code: 0, message:"ok", data: {padUsers: [{colorId:"#c1a9d9","name":"username1","timestamp":1345228793126},{"colorId":"#d9a9cd","name":"Hmmm","timestamp":1345228796042}]}}` + * `{code: 0, message:"ok", data: {padUsers: []}}` + * **deletePad(padID)** deletes a pad <br><br>*Example returns:* * `{code: 0, message:"ok", data: null}` * `{code: 1, message:"padID does not exist", data: null}` |