Commit Graph

21 Commits

Author SHA1 Message Date
Pierre Ossman 3d7bb02036 Change some attributes to arguments
Some attributes are better suited as arguments, primarily because they
are associated with a specific method and cannot be changed later.
2017-11-09 12:52:05 +01:00
Pierre Ossman f8318361b1 Remove wsProtocols setting
It isn't in use anymore since we deprecated support for Base64 mode.
2017-11-09 12:52:05 +01:00
Pierre Ossman 5b4e5d016e Switch to URL for connect()
This is more in line with how other JavaScript APIs work.
2017-11-09 12:52:05 +01:00
Pierre Ossman 30691b668e Remove onFBU* callbacks
They are internal mechanisms that callers should be isolated from.
2017-11-09 12:52:03 +01:00
Pierre Ossman 832be2625b Add resize as a capability
Makes the API more transparent than piggybacking on completion
of the first framebuffer update.
2017-11-09 12:51:15 +01:00
Pierre Ossman cd523e8f28 Make power API generic
Decouple it from XVP and make it a generic API.
2017-11-09 12:47:21 +01:00
Pierre Ossman 430f00d6fe Allow other credentials than just password
Makes the XVP authentication mechanism more general.
2017-11-09 12:45:05 +01:00
Pierre Ossman f976b5500e Hide mouse object from RFB callers 2017-10-27 13:58:12 +02:00
Pierre Ossman b9854a5ca5 Hide display object from RFB callers 2017-10-27 13:58:11 +02:00
Pierre Ossman 6929a0a183 Split out internal API
We only commit to maintaining the API of the RFB object, not the
other modules.
2017-10-27 13:58:11 +02:00
Pierre Ossman 2292cfa6ff Remove 'focusContainer' attribute from API documentation
It was removed from the code in the previous merge.
2017-10-18 15:51:43 +02:00
Pierre Ossman 94bf610cee Remove 'focused' attributes from API documentation
They were removed from the code in the previous merge.
2017-10-18 15:13:19 +02:00
Samuel Mannehed 3c5dd884d2 Update API since sendKey() has a new parameter
Commit 94f5cf05f3 added a new parameter to
the public function in the RFB object.
2017-10-12 15:26:21 +02:00
Samuel Mannehed 2f77baabd4 Mouse and Keyboard are seperate files now 2017-10-12 15:17:54 +02:00
Samuel Mannehed ced77799b2 Update link to Websock API page 2017-10-12 15:04:59 +02:00
Samuel Mannehed 90ab0d38e5 Add note clarifying the disconnected state
Makes it clear that the RFB module can not transition away from the
disconnected state.
2017-10-12 15:01:38 +02:00
Samuel Mannehed f5d40c6a4b Use markdown-style tables instead of <table>
Much easier to read in plaintext
2017-10-12 15:00:55 +02:00
Samuel Mannehed df4653826d Remove trailing whitespace 2017-10-12 14:59:49 +02:00
Samuel Mannehed 2b12429e06 Use underscores for bold text intead of asterixes
Makes an asterix-list easier to read in plaintext
2017-10-12 14:58:35 +02:00
Samuel Mannehed f8d08e7b35 Add numbering for each header in the API doc 2017-10-12 14:57:11 +02:00
Samuel Mannehed 5ce9155098 Move API documentation from wiki to the repo
Since the API is tied to the source code it makes more sence to have it
in the repository where it can more easily be tied to different versions
of the software.
2017-10-12 14:48:38 +02:00