747b462337
Use normal properties with JavaScript setters and getters instead of our homegrown stuff. This also changes the properties to follow normal naming conventions.
95 lines
4.9 KiB
Markdown
95 lines
4.9 KiB
Markdown
# API
|
|
|
|
The interface of the noVNC client consists of a single RFB object that
|
|
is instantiated once per connection.
|
|
|
|
|
|
## 1 Configuration Attributes
|
|
|
|
| name | type | mode | default | description
|
|
| ----------------- | ----- | ---- | ---------- | ------------
|
|
| localCursor | bool | RW | false | Request locally rendered cursor
|
|
| viewOnly | bool | RW | false | Disable client mouse/keyboard
|
|
| touchButton | int | RW | 1 | Button mask (1, 2, 4) for which click to send on touch devices. 0 means ignore clicks.
|
|
| scale | float | RW | 1.0 | Display area scale factor
|
|
| viewport | bool | RW | false | Use viewport clipping
|
|
| disconnectTimeout | int | RW | 3 | Time (in seconds) to wait for disconnection
|
|
| viewportDrag | bool | RW | false | Move the viewport on mouse drags
|
|
| capabilities | arr | RO | [] | Supported capabilities (can include: 'power', 'resize')
|
|
|
|
|
|
## 2 Methods
|
|
|
|
| name | parameters | description
|
|
| ------------------ | ------------------------------- | ------------
|
|
| connect | (url, options) | Connect to the given URL
|
|
| disconnect | () | Disconnect
|
|
| sendCredentials | (credentials) | Send credentials after onCredentialsRequired callback
|
|
| sendCtrlAltDel | () | Send Ctrl-Alt-Del key sequence
|
|
| machineShutdown | () | Request a shutdown of the remote machine.
|
|
| machineReboot | () | Request a reboot of the remote machine.
|
|
| machineReset | () | Request a reset of the remote machine.
|
|
| sendKey | (keysym, code, down) | Send a key press event. If down not specified, send a down and up event.
|
|
| clipboardPasteFrom | (text) | Send a clipboard paste event
|
|
| autoscale | (width, height, downscaleOnly) | Scale the display
|
|
| clippingDisplay | () | Check if the remote display is larger than the client display
|
|
| requestDesktopSize | (width, height) | Send a request to change the remote desktop size.
|
|
| viewportChangeSize | (width, height) | Change size of the viewport
|
|
|
|
__connect() details__
|
|
|
|
The connect() call supports the following options:
|
|
|
|
| name | type | default | description
|
|
| ----------------- | ----- | ---------- | ------------
|
|
| shared | bool | true | Request shared VNC mode
|
|
| credentials | obj | {} | Credentials to use when authenticating
|
|
| repeaterID | str | '' | UltraVNC RepeaterID to connect to
|
|
|
|
|
|
## 3 Callbacks
|
|
|
|
The RFB object has certain events that can be hooked with callback
|
|
functions.
|
|
|
|
| name | parameters | description
|
|
| --------------------- | -------------------------- | ------------
|
|
| onupdatestate | (rfb, state, oldstate) | Connection state change (see details below)
|
|
| onnotification | (rfb, msg, level, options) | Notification for the UI (optional options)
|
|
| ondisconnected | (rfb, reason) | Disconnection finished with an optional reason. No reason specified means normal disconnect.
|
|
| oncredentialsrequired | (rfb, types) | VNC credentials are required (use sendCredentials)
|
|
| onclipboard | (rfb, text) | RFB clipboard contents received
|
|
| onbell | (rfb) | RFB Bell message received
|
|
| onfbresize | (rfb, width, height) | Frame buffer (remote desktop) size changed
|
|
| ondesktopname | (rfb, name) | VNC desktop name recieved
|
|
| oncapabilities | (rfb, capabilities) | The supported capabilities has changed
|
|
|
|
|
|
__RFB onUpdateState callback details__
|
|
|
|
The RFB module has an 'onUpdateState' callback that is invoked after
|
|
the noVNC connection state changes. Here is a list of the states that
|
|
are reported. Note that the RFB module can not transition from the
|
|
disconnected state in any way, a new instance of the object has to be
|
|
created for new connections.
|
|
|
|
| connection state | description
|
|
| ---------------- | ------------
|
|
| connecting | starting to connect
|
|
| connected | connected normally
|
|
| disconnecting | starting to disconnect
|
|
| disconnected | disconnected - permanent end-state for this RFB object
|
|
|
|
__RFB onCredentialsRequired callback details__
|
|
|
|
The onCredentialsRequired callback is called when the server requests more
|
|
credentials than was specified to connect(). The types argument is a list
|
|
of all the credentials that are required. Currently the following are
|
|
defined:
|
|
|
|
| name | description
|
|
| -------- | ------------
|
|
| username | User that authenticates
|
|
| password | Password for user
|
|
| target | String specifying target machine or session
|