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

PadMessageHandler: Modernize userLeave hook context properties

Browse source
This commit is contained in:
Richard Hansen 2021-10-30 02:22:15 -04:00
parent a6d060d67b
commit 9aaf781548
3 changed files with 15 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -840,20 +840,11 @@ certain actions after a pad has been edited.
Context properties:
* `auth`: Object containing information used for authentication, provided by the
user. Properties:
* `padID`: Pad identifier requested by the user. Unlike the `padId` property
described below, this might be a read-only pad ID.
* `sessionID`: Copied from the client's `sessionID` cookie, which should be
the value returned from the `createSession()` HTTP API. This will be nullish
if `createSession()` isn't used or the portal doesn't set the `sessionID`
cookie.
* `token`: User-supplied token.
* `author`: The user's author ID.
* `authorId`: The user's author ID.
* `padId`: The pad's real (not read-only) identifier.
* `readOnly`: If truthy, the user only has read-only access.
* `readOnlyPadId`: The pad's read-only identifier.
* `readonly`: If truthy, the user only has read-only access.
* `rev`: The last revision that was sent to the client.
* `socket`: The socket.io Socket object.
Example: