mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-23 17:06:16 -04:00
updated documentation
This commit is contained in:
parent
f1d06c55b4
commit
0772f6bb4e
16 changed files with 188 additions and 20 deletions
38
doc/jsdoc/handler/PadMessageHandler.md
Normal file
38
doc/jsdoc/handler/PadMessageHandler.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# handler/PadMessag
|
||||
`require("./handler/PadMessageHandler");`
|
||||
|
||||
The MessageHandler handles all Messages that comes from Socket.IO and controls the sessions
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### handleConnect (client)
|
||||
Handles the connection of a new user
|
||||
|
||||
* **client** the new client
|
||||
|
||||
- - -
|
||||
### handleDisconnect (client)
|
||||
Handles the disconnection of a user
|
||||
|
||||
* **client** the client that leaves
|
||||
|
||||
- - -
|
||||
### handleMessage (client, message)
|
||||
Handles a message from a user
|
||||
|
||||
* **client** the client that send this message
|
||||
* **message** the message from the client
|
||||
|
||||
- - -
|
||||
### setSocketIO (socket_io)
|
||||
A associative array that translates a session to a pad
|
||||
|
||||
* **socket_io** The Socket
|
||||
|
||||
- - -
|
||||
### updatePadClients (pad, callback)
|
||||
|
||||
* **pad** *No description*
|
||||
* **callback** *No description*
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue