Document onsuccess callback

Signed-off-by: Jeremy White <jwhite@codeweavers.com>
This commit is contained in:
Cédric Bosdonnat 2019-02-14 10:44:53 +01:00 committed by Jeremy White
parent dfa40a73ff
commit ee0ec7c24f

View File

@ -56,6 +56,8 @@ import { resize_helper, handle_resize } from './resize.js';
** onagent (optional) If given, a function to be called when
** a VD agent is connected; a good opportunity
** to request a resize
** onsuccess (optional) If given, a function to be called when the
** session is successfully connected
**
** Throws error if there are troubles. Requires a modern (by 2012 standards)
** browser, including WebSocket and WebSocket.binaryType == arraybuffer