vfsClient Class Reference

The vfsClient manages a connection to the VFS. More...

#include "remoto!stdlib:js/vfsClient.js"

Public Member Functions
	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)

Detailed Description

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

Constructor & Destructor Documentation

vfsClient()

vfsClient	(		_config,
			bootstrap
	)

Parameters

_config
bootstrap

DOCME

Member Function Documentation

applyDiff()

applyDiff	(		path,
			diff,
			user
	)

Parameters

path
diff
user

DOCME

applyLayoutHandler()

applyLayoutHandler	(		menuData,
			data
	)

Parameters

menuData
data

DOCME

applyMetadata()

applyMetadata	(		path,
			metadata
	)

Parameters

path
metadata

DOCME

applyRead()

applyRead	(		path,
			data,
			metadata
	)

Parameters

path
data
metadata

DOCME

applyReleaseLock()

applyReleaseLock	(		path,
			data
	)

Parameters

path
data

DOCME

applyRequestError()

applyRequestError	(		command,
			path,
			reason
	)

Parameters

command
path
reason

DOCME

applyRequestLock()

applyRequestLock	(		path,
			data
	)

Parameters

path
data

DOCME

applyRequestSuccess()

applyRequestSuccess	(		command,
			path,
			data,
			metadata
	)

Parameters

command
path
data
metadata

DOCME

applySubscription()

applySubscription	(		path,
			data,
			metadata
	)

Parameters

path
data
metadata

DOCME

createPane()

createPane	(		layout,
			callback
	)

Parameters

layout
callback

Returns

DOCME

createPaneByPathHandler()

createPaneByPathHandler

(

)

DOCME

createPaneHandler()

createPaneHandler	(		tab,
			data
	)

Parameters

tab
data

DOCME

currentPaneTrigger()

currentPaneTrigger	(		event,
			trigger,
			exclude = null
	)

Parameters

event
trigger
exclude

DOCME

deleteLayoutHandler()

deleteLayoutHandler	(		tab,
			data
	)

Parameters

tab
data

DOCME

destroy()

destroy

(

)

DOCME

destroyPane()

destroyPane

(

pane

)

Parameters

pane

DOCME

initializeUI()

initializeUI

(

userinfo

)

Parameters

userinfo

DOCME

message()

message

(

j

)

Parameters

j

DOCME

metadata()

metadata

(

paths

)

Parameters

paths

DOCME

openUserPreferences()

openUserPreferences

(

)

If the modal is not already showing, open the preferences.

Opens the preferences with the username in config.

postCreate()

postCreate

(

create

)

Parameters

create

DOCME

postDelete()

postDelete

(

del

)

Parameters

del

DOCME

postLSRequest()

postLSRequest	(		event,
			params
	)

Parameters

event
params

DOCME

postReleaseLock()

postReleaseLock	(		path,
			field
	)

Parameters

path
field

DOCME

postRequestLock()

postRequestLock	(		path,
			field
	)

Parameters

path
field

DOCME

postUpdate()

postUpdate

(

update

)

Parameters

update

DOCME

read()

read

(

paths

)

Parameters

paths

DOCME

readSingle()

readSingle	(		path,
			metadata
	)

Parameters

path
metadata

DOCME

refineLayoutModal()

refineLayoutModal

(

)

DOCME

saveInterface()

saveInterface

(

layout

)

Queue the layout to be saved as soon as control returns.

Parameters

layout

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

)

Parameters

name

DOCME

saveLayoutPrompt()

saveLayoutPrompt

(

)

DOCME

send()

send	(		command,
			attributes
	)

Parameters

command
attributes

DOCME

splitLayout()

splitLayout

(

which

)

Parameters

which

DOCME

subscribe()

subscribe

(

paths

)

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()

unsubscribe

(

paths

)

Parameters

paths

DOCME

---

The documentation for this class was generated from the following file:

• vfsClient.js