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

PadMessageHandler: Replace clientReady hook with new userJoin hook

Browse source
This commit is contained in:
Richard Hansen 2021-10-30 02:05:09 -04:00
parent c98910e1c5
commit a6d060d67b
3 changed files with 39 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -807,6 +807,30 @@ Example:
exports.exportEtherpadAdditionalContent = () => ['comments'];
```
## `userJoin`
Called from: `src/node/handler/PadMessageHandler.js`
Called after users have been notified that a new user has joined the pad.
Context properties:
* `authorId`: The user's author identifier.
* `displayName`: The user's display name.
* `padId`: The real (not read-only) identifier of the pad the user joined. This
MUST NOT be shared with any users that are connected with read-only access.
* `readOnly`: Whether the user only has read-only access.
* `readOnlyPadId`: The read-only identifier of the pad the user joined.
* `socket`: The socket.io Socket object.
Example:
```javascript
exports.userJoin = async (hookName, {authorId, displayName, padId}) => {
console.log(`${authorId} (${displayName}) joined pad ${padId});
};
```
## `userLeave`
Called from: `src/node/handler/PadMessageHandler.js`
@ -838,20 +862,3 @@ exports.userLeave = async (hookName, {author, padId}) => {
console.log(`${author} left pad ${padId}`);
};
```
## `clientReady`
Called from: `src/node/handler/PadMessageHandler.js`
Called when a `CLIENT_READY` message is received, which is the first message a
newly connected client sends.
The context is the raw message received from the user.
Example:
```javascript
exports.clientReady = async (hookName, {padId}) => {
console.log(`Client has joined pad ${padId});
};
```