mirror/galene
1
Fork 0
mirror of https://github.com/jech/galene.git synced 2024-11-26 10:35:59 +01:00
Code Activity

Improve documentation for protocol functions.

Browse source
This commit is contained in:
Juliusz Chroboczek 2020-12-05 20:21:33 +01:00
parent b6a6165650
commit 1c5bce2a38
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
static/protocol.js
View file

@ -455,7 +455,8 @@ ServerConnection.prototype.newUpStream = function(id) {
* the message back to the client. * the message back to the client.
* *
* @param {string} username - The sender's username. * @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} dest - The id to send the message to, empty for broadcast.
* @param {string} value - The text of the message. * @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. * 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} username - The sender's username.
* @param {string} kind - The kind of application-specific message. * @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. * @param {string} [value] - An optional parameter.
*/ */
ServerConnection.prototype.userMessage = function(username, kind, dest, value) { 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. * groupAction sends a request to act on the current group.
* *
* @param {string} username - The sender's username. * @param {string} username - The sender's username.
* @param {string} kind - One of "clearchat", "lock", "unlock", "record or * @param {string} kind
* "unrecord". * - One of 'clearchat', 'lock', 'unlock', 'record' or 'unrecord'.
* @param {string} [message] - An optional user-readable message. * @param {string} [message] - An optional user-readable message.
*/ */
ServerConnection.prototype.groupAction = function(username, kind, message) { ServerConnection.prototype.groupAction = function(username, kind, message) {