Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
galene
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alain Takoudjou
galene
Commits
1c5bce2a
Commit
1c5bce2a
authored
Dec 05, 2020
by
Juliusz Chroboczek
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve documentation for protocol functions.
parent
b6a61656
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
4 deletions
+6
-4
static/protocol.js
static/protocol.js
+6
-4
No files found.
static/protocol.js
View file @
1c5bce2a
...
...
@@ -455,7 +455,8 @@ ServerConnection.prototype.newUpStream = function(id) {
* the message back to the client.
*
* @param {string} username - The sender's username.
* @param {string} kind - The kind of message, either "" or "me".
* @param {string} kind
* - The kind of message, either '', 'me' or an application-specific type.
* @param {string} dest - The id to send the message to, empty for broadcast.
* @param {string} value - The text of the message.
*/
...
...
@@ -491,10 +492,11 @@ ServerConnection.prototype.userAction = function(username, kind, dest, value) {
/**
* userMessage sends an application-specific message to a user.
* This is similar to a chat message, but is not saved in the chat history.
*
* @param {string} username - The sender's username.
* @param {string} kind - The kind of application-specific message.
* @param {string} dest - The id
of the user to send the message to
.
* @param {string} dest - The id
to send the message to, empty for broadcast
.
* @param {string} [value] - An optional parameter.
*/
ServerConnection
.
prototype
.
userMessage
=
function
(
username
,
kind
,
dest
,
value
)
{
...
...
@@ -512,8 +514,8 @@ ServerConnection.prototype.userMessage = function(username, kind, dest, value) {
* groupAction sends a request to act on the current group.
*
* @param {string} username - The sender's username.
* @param {string} kind
- One of "clearchat", "lock", "unlock", "record or
*
"unrecord"
.
* @param {string} kind
*
- One of 'clearchat', 'lock', 'unlock', 'record' or 'unrecord'
.
* @param {string} [message] - An optional user-readable message.
*/
ServerConnection
.
prototype
.
groupAction
=
function
(
username
,
kind
,
message
)
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment