3 The interface of the noVNC client consists of a single RFB object that
4 is instantiated once per connection.
8 The `RFB` object represents a single connection to a VNC server. It
9 communicates using a WebSocket that must provide a standard RFB
15 - Creates and returns a new `RFB` object.
20 - Is a `boolean` indicating if any events (e.g. key presses or mouse
21 movement) should be prevented from being sent to the server.
25 - Is a `boolean` indicating if keyboard focus should automatically be
26 moved to the remote session when a `mousedown` or `touchstart`
30 - Is a `long` controlling the button mask that should be simulated
31 when a touch event is recieved. Uses the same values as
32 [`MouseEvent.button`](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button).
33 Is set to `1` by default.
36 - Is a `boolean` indicating if the remote session should be clipped
37 to its container. When disabled scrollbars will be shown to handle
38 the resulting overflow. Disabled by default.
41 - Is a `boolean` indicating if mouse events should control the
42 relative position of a clipped remote session. Only relevant if
43 `clipViewport` is enabled. Disabled by default.
46 - Is a `boolean` indicating if the remote session should be scaled
47 locally so it fits its container. When disabled it will be centered
48 if the remote session is smaller than its container, or handled
49 according to `clipViewport` if it is larger. Disabled by default.
52 - Is a `boolean` indicating if a request to resize the remote session
53 should be sent whenever the container changes dimensions. Disabled
57 - Is a `boolean` indicating whether a dot cursor should be shown
58 instead of a zero-sized or fully-transparent cursor if the server
59 sets such invisible cursor. Disabled by default.
62 - Is a valid CSS [background](https://developer.mozilla.org/en-US/docs/Web/CSS/background)
63 style value indicating which background style should be applied
64 to the element containing the remote session screen. The default value is `rgb(40, 40, 40)`
67 `capabilities` *Read only*
68 - Is an `Object` indicating which optional extensions are available
69 on the server. Some methods may only be called if the corresponding
70 capability is set. The following capabilities are defined:
72 | name | type | description
73 | -------- | --------- | -----------
74 | `power` | `boolean` | Machine power control is available
79 - The `connect` event is fired when the `RFB` object has completed
80 the connection and handshaking with the server.
82 [`disconnect`](#disconnected)
83 - The `disconnect` event is fired when the `RFB` object disconnects.
85 [`credentialsrequired`](#credentialsrequired)
86 - The `credentialsrequired` event is fired when more credentials must
89 [`securityfailure`](#securityfailure)
90 - The `securityfailure` event is fired when the security negotiation
91 with the server fails.
93 [`clipboard`](#clipboard)
94 - The `clipboard` event is fired when clipboard data is received from
98 - The `bell` event is fired when a audible bell request is received
101 [`desktopname`](#desktopname)
102 - The `desktopname` event is fired when the remote desktop name
105 [`capabilities`](#capabilities)
106 - The `capabilities` event is fired when `RFB.capabilities` is
111 [`RFB.disconnect()`](#rfbdisconnect)
112 - Disconnect from the server.
114 [`RFB.sendCredentials()`](#rfbsendcredentials)
115 - Send credentials to server. Should be called after the
116 [`credentialsrequired`](#credentialsrequired) event has fired.
118 [`RFB.sendKey()`](#rfbsendKey)
121 [`RFB.sendCtrlAltDel()`](#rfbsendctrlaltdel)
122 - Send Ctrl-Alt-Del key sequence.
124 [`RFB.focus()`](#rfbfocus)
125 - Move keyboard focus to the remote session.
127 [`RFB.blur()`](#rfbblur)
128 - Remove keyboard focus from the remote session.
130 [`RFB.machineShutdown()`](#rfbmachineshutdown)
131 - Request a shutdown of the remote machine.
133 [`RFB.machineReboot()`](#rfbmachinereboot)
134 - Request a reboot of the remote machine.
136 [`RFB.machineReset()`](#rfbmachinereset)
137 - Request a reset of the remote machine.
139 [`RFB.clipboardPasteFrom()`](#rfbclipboardPasteFrom)
140 - Send clipboard contents to server.
146 The `RFB()` constructor returns a new `RFB` object and initiates a new
147 connection to a specified VNC server.
151 let rfb = new RFB( target, url [, options] );
156 - A block [`HTMLElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
157 that specifies where the `RFB` object should attach itself. The
158 existing contents of the `HTMLElement` will be untouched, but new
159 elements will be added during the lifetime of the `RFB` object.
162 - A `DOMString` specifying the VNC server to connect to. This must be
163 a valid WebSocket URL.
165 **`options`** *Optional*
166 - An `Object` specifying extra details about how the connection
172 - A `boolean` indicating if the remote server should be shared or
173 if any other connected clients should be disconnected. Enabled
177 - An `Object` specifying the credentials to provide to the server
178 when authenticating. The following credentials are possible:
180 | name | type | description
181 | ------------ | ----------- | -----------
182 | `"username"` | `DOMString` | The user that authenticates
183 | `"password"` | `DOMString` | Password for the user
184 | `"target"` | `DOMString` | Target machine or session
187 - A `DOMString` specifying the ID to provide to any VNC repeater
191 - An `Array` of `DOMString`s specifying the sub-protocols to use
192 in the WebSocket connection. Empty by default.
196 The `connect` event is fired after all the handshaking with the server
197 is completed and the connection is fully established. After this event
198 the `RFB` object is ready to recieve graphics updates and to send input.
202 The `disconnect` event is fired when the connection has been
203 terminated. The `detail` property is an `Object` that contains the
204 property `clean`. `clean` is a `boolean` indicating if the termination
205 was clean or not. In the event of an unexpected termination or an error
206 `clean` will be set to false.
208 #### credentialsrequired
210 The `credentialsrequired` event is fired when the server requests more
211 credentials than were specified to [`RFB()`](#rfb-1). The `detail`
212 property is an `Object` containing the property `types` which is an
213 `Array` of `DOMString` listing the credentials that are required.
217 The `securityfailure` event is fired when the handshaking process with
218 the server fails during the security negotiation step. The `detail`
219 property is an `Object` containing the following properties:
221 | Property | Type | Description
222 | -------- | ----------- | -----------
223 | `status` | `long` | The failure status code
224 | `reason` | `DOMString` | The **optional** reason for the failure
226 The property `status` corresponds to the
227 [SecurityResult](https://github.com/rfbproto/rfbproto/blob/master/rfbproto.rst#securityresult)
228 status code in cases of failure. A status of zero will not be sent in
229 this event since that indicates a successful security handshaking
230 process. The optional property `reason` is provided by the server and
231 thus the language of the string is not known. However most servers will
232 probably send English strings. The server can choose to not send a
233 reason and in these cases the `reason` property will be omitted.
237 The `clipboard` event is fired when the server has sent clipboard data.
238 The `detail` property is an `Object` containing the property `text`
239 which is a `DOMString` with the clipboard data.
243 The `bell` event is fired when the server has requested an audible
248 The `desktopname` event is fired when the name of the remote desktop
249 changes. The `detail` property is an `Object` with the property `name`
250 which is a `DOMString` specifying the new name.
254 The `capabilities` event is fired whenever an entry is added or removed
255 from `RFB.capabilities`. The `detail` property is an `Object` with the
256 property `capabilities` containing the new value of `RFB.capabilities`.
258 #### RFB.disconnect()
260 The `RFB.disconnect()` method is used to disconnect from the currently
267 #### RFB.sendCredentials()
269 The `RFB.sendCredentials()` method is used to provide the missing
270 credentials after a `credentialsrequired` event has been fired.
274 RFB.sendCredentials( credentials );
279 - An `Object` specifying the credentials to provide to the server
280 when authenticating. See [`RFB()`](#rfb-1) for details.
284 The `RFB.sendKey()` method is used to send a key event to the server.
288 RFB.sendKey( keysym, code [, down] );
293 - A `long` specifying the RFB keysym to send. Can be `0` if a valid
294 **`code`** is specified.
297 - A `DOMString` specifying the physical key to send. Valid values are
298 those that can be specified to
299 [`KeyboardEvent.code`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code).
300 If the physical key cannot be determined then `null` shall be
303 **`down`** *Optional*
304 - A `boolean` specifying if a press or a release event should be
305 sent. If omitted then both a press and release event are sent.
307 #### RFB.sendCtrlAltDel()
309 The `RFB.sendCtrlAltDel()` method is used to send the key sequence
310 *left Control*, *left Alt*, *Delete*. This is a convenience wrapper
311 around [`RFB.sendKey()`](#rfbsendkey).
315 RFB.sendCtrlAltDel( );
319 The `RFB.focus()` method sets the keyboard focus on the remote session.
320 Keyboard events will be sent to the remote server after this point.
328 The `RFB.blur()` method remove keyboard focus on the remote session.
329 Keyboard events will no longer be sent to the remote server after this
336 #### RFB.machineShutdown()
338 The `RFB.machineShutdown()` method is used to request to shut down the
339 remote machine. The capability `power` must be set for this method to
344 RFB.machineShutdown( );
346 #### RFB.machineReboot()
348 The `RFB.machineReboot()` method is used to request a clean reboot of
349 the remote machine. The capability `power` must be set for this method
354 RFB.machineReboot( );
356 #### RFB.machineReset()
358 The `RFB.machineReset()` method is used to request a forced reset of
359 the remote machine. The capability `power` must be set for this method
366 #### RFB.clipboardPasteFrom()
368 The `RFB.clipboardPasteFrom()` method is used to send clipboard data
369 to the remote server.
373 RFB.clipboardPasteFrom( text );
378 - A `DOMString` specifying the clipboard data to send. Currently only
379 characters from ISO 8859-1 are supported.