The vfsClient manages a connection to the VFS.
More...
#include "remoto!stdlib:js/vfsClient.js"
|
| vfsClient (_config, bootstrap) |
|
| applyDiff (path, diff, user) |
|
| applyLayoutHandler (menuData, data) |
|
| applyMetadata (path, metadata) |
|
| applyRead (path, data, metadata) |
|
| applyReleaseLock (path, data) |
|
| applyRequestError (command, path, reason) |
|
| applyRequestLock (path, data) |
|
| applyRequestSuccess (command, path, data, metadata) |
|
| applySubscription (path, data, metadata) |
|
| createPane (layout, callback) |
|
| createPaneByPathHandler () |
|
| createPaneHandler (tab, data) |
|
| currentPaneTrigger (event, trigger, exclude=null) |
|
| deleteLayoutHandler (tab, data) |
|
| destroy () |
|
| destroyPane (pane) |
|
| initializeUI (userinfo) |
|
| message (j) |
|
| metadata (paths) |
|
| openUserPreferences () |
| If the modal is not already showing, open the preferences. More...
|
|
| postCreate (create) |
|
| postDelete (del) |
|
| postLSRequest (event, params) |
|
| postReleaseLock (path, field) |
|
| postRequestLock (path, field) |
|
| postUpdate (update) |
|
| read (paths) |
|
| readSingle (path, metadata) |
|
| refineLayoutModal () |
|
| saveInterface (layout) |
| Queue the layout to be saved as soon as control returns. More...
|
|
| saveLayoutHandler (name) |
|
| saveLayoutPrompt () |
|
| send (command, attributes) |
|
| splitLayout (which) |
|
| subscribe (paths) |
| This will aggregate paths for subscription, using a timer of 0. More...
|
|
| unsubscribe (paths) |
|
The vfsClient manages a connection to the VFS.
This is created by bootstrap, and is the main router for incoming commands. It receives commands from the paneManager and other places to manage a user's session. This is the client implementation of the VFS_remotoserver protocol.
- See also
- VFS_remotoserver_client
◆ vfsClient()
◆ applyDiff()
applyDiff |
( |
|
path, |
|
|
|
diff, |
|
|
|
user |
|
) |
| |
◆ applyLayoutHandler()
applyLayoutHandler |
( |
|
menuData, |
|
|
|
data |
|
) |
| |
◆ applyMetadata()
applyMetadata |
( |
|
path, |
|
|
|
metadata |
|
) |
| |
◆ applyRead()
applyRead |
( |
|
path, |
|
|
|
data, |
|
|
|
metadata |
|
) |
| |
◆ applyReleaseLock()
applyReleaseLock |
( |
|
path, |
|
|
|
data |
|
) |
| |
◆ applyRequestError()
applyRequestError |
( |
|
command, |
|
|
|
path, |
|
|
|
reason |
|
) |
| |
◆ applyRequestLock()
applyRequestLock |
( |
|
path, |
|
|
|
data |
|
) |
| |
◆ applyRequestSuccess()
applyRequestSuccess |
( |
|
command, |
|
|
|
path, |
|
|
|
data, |
|
|
|
metadata |
|
) |
| |
- Parameters
-
command | |
path | |
data | |
metadata | |
DOCME
◆ applySubscription()
applySubscription |
( |
|
path, |
|
|
|
data, |
|
|
|
metadata |
|
) |
| |
◆ createPane()
createPane |
( |
|
layout, |
|
|
|
callback |
|
) |
| |
◆ createPaneByPathHandler()
createPaneByPathHandler |
( |
| ) |
|
◆ createPaneHandler()
createPaneHandler |
( |
|
tab, |
|
|
|
data |
|
) |
| |
◆ currentPaneTrigger()
currentPaneTrigger |
( |
|
event, |
|
|
|
trigger, |
|
|
|
exclude = null |
|
) |
| |
◆ deleteLayoutHandler()
deleteLayoutHandler |
( |
|
tab, |
|
|
|
data |
|
) |
| |
◆ destroy()
◆ destroyPane()
◆ initializeUI()
◆ message()
◆ metadata()
◆ openUserPreferences()
If the modal is not already showing, open the preferences.
Opens the preferences with the username in config.
◆ postCreate()
◆ postDelete()
◆ postLSRequest()
postLSRequest |
( |
|
event, |
|
|
|
params |
|
) |
| |
◆ postReleaseLock()
postReleaseLock |
( |
|
path, |
|
|
|
field |
|
) |
| |
◆ postRequestLock()
postRequestLock |
( |
|
path, |
|
|
|
field |
|
) |
| |
◆ postUpdate()
◆ read()
◆ readSingle()
readSingle |
( |
|
path, |
|
|
|
metadata |
|
) |
| |
◆ refineLayoutModal()
◆ saveInterface()
Queue the layout to be saved as soon as control returns.
- Parameters
-
This is part of the command batching system of the vfsClient. In this case, it is possible for any number of incoming commands to cause a layout change, however we only want the last change to actually be sent. This prevents extraneous network traffic and works more smoothly when the same user is logged in multiple times.
◆ saveLayoutHandler()
saveLayoutHandler |
( |
|
name | ) |
|
◆ saveLayoutPrompt()
◆ send()
send |
( |
|
command, |
|
|
|
attributes |
|
) |
| |
◆ splitLayout()
◆ subscribe()
This will aggregate paths for subscription, using a timer of 0.
- Parameters
-
paths | An array of paths to subscribe to. |
It's more efficient to send one subscribe request rather than many. Large batches of requests will be created during initialization.
◆ unsubscribe()
The documentation for this class was generated from the following file: