libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #2218 from simong/userLeave-hook

Browse source 
Added a `userLeave` hook that gets called when a user leaves a pad
This commit is contained in:
John McLear 2014-08-08 16:45:20 +01:00
commit e34a4ea4ee
2 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -263,3 +263,20 @@ exports.exportFileName = function(hook, padId, callback){
callback("newFileName"+padId); callback("newFileName"+padId);
} }
``` ```
## userLeave
Called from src/node/handler/PadMessageHandler.js
This in context:
1. session (including the pad id and author id)
This hook gets called when an author leaves a pad. This is useful if you want to perform certain actions after a pad has been edited
Example:
```
exports.userLeave = function(hook, session, callback) {
console.log('%s left pad %s', session.author, session.padId);
};
```

3
src/node/handler/PadMessageHandler.js
View file

@ -145,6 +145,9 @@ exports.handleDisconnect = function(client)
//Go trough all user that are still on the pad, and send them the USER_LEAVE message //Go trough all user that are still on the pad, and send them the USER_LEAVE message
client.broadcast.to(session.padId).json.send(messageToTheOtherUsers); client.broadcast.to(session.padId).json.send(messageToTheOtherUsers);
// Allow plugins to hook into users leaving the pad
hooks.callAll("userLeave", session);
}); });
} }