PhidgetDictionary

EventDispatcher

PhidgetDictionary

A class for accessing the Phidget Dictionary. See the programming manual for more specific API details, supported functionality, units, etc.

Summary

PhidgetDictionary	A class for accessing the Phidget Dictionary.
Events	Events supported by all PhidgetDictionary.
Functions
open	Opens a connection to a dictionary.
close	closes the connection to a dictionary.
addKey	Adds or changes a key/value pair to the dictionary.
removeKey	Removes a (set) of key(s) that match the pattern.
Properties
Address	Gets the server address.
Port	Gets the server port.

Events supported by all PhidgetDictionary. Pass these constants to the addEventListener() function when adding event listeners to a Phidget object.

PhidgetDictionaryEvent.CONNECT	server connect
PhidgetDictionaryEvent.DISCONNECT	server disconnect
PhidgetErrorEvent.ERROR	asynchronous error

public function open( address: String,
port: Number,
password: String = null ):void

Opens a connection to a dictionary.

address	address of the webservice. This can be ‘localhost’ when running from a single computer.
port	port of the webservice. This is 5001 by default.
password	password of the webservice. This is optional and doesn’t need to be specified for unsecured webservices.

public function close():void

closes the connection to a dictionary.

public function addKey( key: String,
value: String,
persistent: Boolean = true ):void

Adds or changes a key/value pair to the dictionary.

key	key value
value	value value
persistent	optional, default is true, determines whether a key remains after closing the connection to the dictionay

public function removeKey( pattern: String ):void

Removes a (set) of key(s) that match the pattern. The pattern is a regular, or extended regular expression.

pattern

pattern of keys to remove

public function get Address():String

Gets the server address.

public function get Port():int

Gets the server port.