mike-jumper commented on code in PR #668:
URL: https://github.com/apache/guacamole-client/pull/668#discussion_r1034208288
##########
guacamole-common-js/src/main/webapp/modules/Client.js:
##########
@@ -687,6 +687,20 @@ Guacamole.Client = function(tunnel) {
* A status object which describes the error.
*/
this.onerror = null;
+
+ /**
+ * Fired when a message is received from the remote tunnel and needs to be
+ * displayed to the user.
+ *
+ * @event
+ * @param {!number} msgcode
+ * A status code sent by the remote server that indicates the message
+ * that should be displayed to the client.
+ * @param {string[]} args
+ * An array of arguments that can be added to the message that will be
+ * displayed to the client.
+ */
Review Comment:
I think this should be documented more along the lines of receiving a
message indicating some sort of arbitrary event or state change, not
necessarily something that _needs_ to or _will_ be displayed to the user.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
