libretic
/
etherpad-lite
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Refine `padRemove` server-side hook documentation

This commit is contained in:
Richard Hansen 2022-04-08 02:55:38 -04:00
parent 362b33c518
commit ba536e68f1
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/api/hooks_server-side.md
View File

@ -351,18 +351,20 @@ Usage examples:
* https://github.com/ether/ep_comments_page
## padRemove
Called from: src/node/db/Pad.js
## `padRemove`
Things in context:
Called from: `src/node/db/Pad.js`
1. padID
Called when an existing pad is removed/deleted. Plugins should use this to clean
up any plugin-specific pad records from the database.
This hook gets called when an existing pad was removed/deleted.
Context properties:
* `padID`: ID of the pad that is being deleted.
Usage examples:
* https://github.com/ether/ep_comments
* https://github.com/ether/ep_comments_page
## socketio
Called from: src/node/hooks/express/socketio.js