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
16
doc/jsdoc/handler/ExportHandler.md
Normal file
16
doc/jsdoc/handler/ExportHandler.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# handler/Expor
|
||||
`require("./handler/ExportHandler");`
|
||||
|
||||
Handles the export requests
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### doExport (req, res, padId, type)
|
||||
do a requested export
|
||||
|
||||
* **req** *No description*
|
||||
* **res** *No description*
|
||||
* **padId** *No description*
|
||||
* **type** *No description*
|
||||
|
15
doc/jsdoc/handler/ImportHandler.md
Normal file
15
doc/jsdoc/handler/ImportHandler.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
# handler/Impor
|
||||
`require("./handler/ImportHandler");`
|
||||
|
||||
Handles the import requests
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### doImport (req, res, padId)
|
||||
do a requested import
|
||||
|
||||
* **req** *No description*
|
||||
* **res** *No description*
|
||||
* **padId** *No description*
|
||||
|
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*
|
||||
|
23
doc/jsdoc/handler/SocketIORouter.md
Normal file
23
doc/jsdoc/handler/SocketIORouter.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# handler/Socket
|
||||
`require("./handler/SocketIORouter");`
|
||||
|
||||
This is the Socket.IO Router. It routes the Messages between the
|
||||
components of the Server. The components are at the moment: pad and timeslider
|
||||
|
||||
## Functions
|
||||
|
||||
- - -
|
||||
### addComponent (moduleName, module)
|
||||
Saves all components
|
||||
key is the component name
|
||||
value is the component module
|
||||
|
||||
* **moduleName** *No description*
|
||||
* **module** *No description*
|
||||
|
||||
- - -
|
||||
### setSocketIO (_socket)
|
||||
sets the socket.io and adds event functions for routing
|
||||
|
||||
* **_socket** *No description*
|
||||
|
32
doc/jsdoc/handler/TimesliderMessageHandler.md
Normal file
32
doc/jsdoc/handler/TimesliderMessageHandler.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# handler/TimesliderMessag
|
||||
`require("./handler/TimesliderMessageHandler");`
|
||||
|
||||
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)
|
||||
Saves the Socket class we need to send and recieve data from the client
|
||||
|
||||
* **socket_io** The Socket
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue