KB-20 Flash SDK connector API referance

Content

The flash SDK has some build in properties, methods(functions) and events to help extend your flash movies to a more rich user environment.

Flash SDK version 3.0. This flash version is for use with the latest Flash actionscript 3.0, and alternately can be used with the Flex framework

Connector Class

 Properties object type  description   default value
 updateTimeInterval  Number  The amount of time, milli-seconds, that the connector waits between calls to the communicator for point updates.  3000
 VERSION  String A read only string that will contain the connector build version.   3.0
 statusValue  String A read only string that will contain the latest message from the connector, after a CONNECTOR_ERROR event is raised  empty string
 points  ArrayCollection A read only array collection of InetPoints associated with the connector. Filled from the connect() method  empty collection
 sqlError  String A read only string that will contain the latest message from the connector, after a SQL_CALL_ERROR event is raised  empty string
 sqlXmlResult  XML The XML result from a SQL call. This will be updated just prior to the SQL_CALL_RESULT event is raised  null
 
 Methods arguments  return value  description 
 Connector():void  none   void  The constructor function
 connectionAddress(void):String  none  String  Returns the web address associated with the connector.
connect(address:String,pointArray:Array,client:Object = null):void  address; the address of the Inetsupervisor instance to connect to, pointArray; the array of points to fill the connector with, client; optional UI object to associate the top level object with.   void  Initiates the connection to the inetsupervisor instance and starts getting values for the points in the points collection
 getInetPointById(id:int):InetPoint  id; the point id number to find  InetPoint  Finds and returns a copy of the LnsPoint that is associated with the point id supplied.
 sendOverride(pointID:int, value:String):void  pointID; the point id to send the override to, value; the value of the override  void  Sends a point value override, to the point id specified
 sqlConnect(sqlCall:String):void  sqlCall; the sql call to be made  void  Sends the specified call to the SQL instance of inetsupervisor derived from the connect() method
 
 Events  description
 VALUES_RECIVED  Raised each time when all of the points in the points collection have been updated
 CONNECTOR_ERROR  Raised any time there is an error with the connector. This error can be derived from a connection error to the communicator or value parsing error when sending overrides or incompatible value types in the connect() method
 SQL_CALL_RESULT  Raised when a valid result is return after making a SQL call
 SQL_CALL_ERROR  Raised any time there is an error with a SQL call. This error can be derived from a connection error to the communicator or value parsing error with the SQL call itself
 

InetPoints Class

 Properties object type  description   default value
 pointID  int The inetsupervisor point id associated with the InetPoint  0
 value  String A string that will contain the point value   empty string
 engUnits  String A read only string that is the value specified in the EngUnits column of the inetsupervisor points table  empty string
 inAlarm  Boolean A read only value indicating if the point is in the alarm state  false
 isNew  Boolean A read only value indicating if the point value is less then 15 minutes old  false
 isTrended  Boolean A read only value indicating if the point is a trended point  false
 isSchedule  Boolean A read only value indicating if the point is a scheduled point  false
 
 Methods arguments  return value  description 
 setOverride(value:String):void  value; the value of the override  void  Sends a point value override, to the point id specified in the pointID property of the InetPoint
 
 Events  description
 VALUE_UPDATED  Raised each time the value property is updated with a point value.
 SEND_OVERRIDE  Raised any time the InetPoint has sent a point value override

Add Feedback