public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2757 from Gared/doc_append_chat_message 

Add appendChatMessage API to docs
pull/2767/merge
Stefan 2015-08-30 18:15:51 +02:00
parent 9e68744ec9 f27aacc5bf
commit cc9f88e7ed
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/http_api.md
View File

@ -380,6 +380,16 @@ returns the chatHead (last number of the last chat-message) of the pad
* `{code: 0, message:"ok", data: {chatHead: 42}}` * `{code: 0, message:"ok", data: {chatHead: 42}}`
* `{code: 1, message:"padID does not exist", data: null}` * `{code: 1, message:"padID does not exist", data: null}`
#### appendChatMessage(padID, text, authorID [, time])
* API >= 1.2.12
creates a chat message, saves it to the database and sends it to all connected clients of this pad
*Example returns:*
* `{code: 0, message:"ok", data: null}`
* `{code: 1, message:"text is no string", data: null}`
### Pad ### Pad
Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and its forbidden for normal pads to include a $ in the name. Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and its forbidden for normal pads to include a $ in the name.

2
src/node/db/API.js
View File

@ -499,7 +499,7 @@ appendChatMessage(padID, text, authorID, time), creates a chat message for the p
Example returns: Example returns:
{code: 0, message:"ok", data: null {code: 0, message:"ok", data: null}
{code: 1, message:"padID does not exist", data: null} {code: 1, message:"padID does not exist", data: null}
*/ */
exports.appendChatMessage = function(padID, text, authorID, time, callback) exports.appendChatMessage = function(padID, text, authorID, time, callback)