mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-24 01:16:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

chat: New chatNewMessage server-side hook

Browse source
This commit is contained in:
Richard Hansen 2021-10-30 16:58:28 -04:00
parent 23a98e5946
commit 26675c5019
4 changed files with 180 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/api/hooks_server-side.md
View file

@ -853,3 +853,20 @@ exports.userLeave = async (hookName, {author, padId}) => {
console.log(`${author} left pad ${padId}`);
};
```
## `chatNewMessage`
Called from: `src/node/handler/PadMessageHandler.js`
Called when a user (or plugin) generates a new chat message, just before it is
saved to the pad and relayed to all connected users.
Context properties:
* `message`: The chat message object. Plugins can mutate this object to change
the message text or add custom metadata to control how the message will be
rendered by the `chatNewMessage` client-side hook. The message's `authorId`
property can be trusted (the server overwrites any client-provided author ID
value with the user's actual author ID before this hook runs).
* `padId`: The pad's real (not read-only) identifier.
* `pad`: The pad's Pad object.