Packagenet.user1.reactor.snapshot
Classpublic class AccountListSnapshot
InheritanceAccountListSnapshot Inheritance Snapshot Inheritance flash.events.EventDispatcher

Since : Reactor 1.0.0

The AccountListSnapshot class is used to load a list of userIDs for all user accounts on the server. The following code demonstrates.
   // Create the snapshot
   var snapshot:AccountListSnapshot = new AccountListSnapshot();
   
   // Register a callback function
   snapshot.onLoad = function ():void { 
     trace("Here are the user accounts on the server: " + snapshot.getAccountList());
   }
   
   // Or register a listener function
   snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
   function loadListener (e:SnapshotEvent):void {
     trace("Here are the user accounts on the server: " 
           + AccountListSnapshot(e.target).getAccountList());
   }
   
   // Load the account list by passing the snapshot object to 
   // Reactor's updateSnapshot() method:
   reactor.updateSnapshot(snapshot);
   

See also

SnapshotEvent
Snapshot
net.user1.reactor.Reactor.updateSnapshot()


Public Variables
 VariableDefined By
 InheritedonLoad : Function
A callback function to be invoked when this snapshot's data is loaded.
Snapshot
Public Methods
 MethodDefined By
  
Constructor
AccountListSnapshot
  
Returns an array of the string userIDs of the accounts on the server.
AccountListSnapshot
 Inherited
getStatus():String
Returns the status of the most recent snapshot load-operation.
Snapshot
 Inherited
Indicates whether the snapshot is currently loading data.
Snapshot
Events
 Event Summary Defined By
 Inherited Dispatched when a snapshot object has been updated in response to an earlier call to Reactor's updateSnapshot() method.Snapshot
 Inherited Dispatched when the result of an update request has been received by a snapshot object.Snapshot
Constructor Description
AccountListSnapshot()Constructor
public function AccountListSnapshot()

Constructor

Method Descriptions
getAccountList()method
public function getAccountList():Array

Since : Reactor 1.0.0

Returns an array of the string userIDs of the accounts on the server. To refresh the list, pass this AccountListSnapshot object to Reactor's updateSnapshot() method.

Returns
Array

See also