Package | net.user1.reactor.snapshot |
Class | public class BannedListSnapshot |
Inheritance | BannedListSnapshot ![]() ![]() |
Since : | Reactor 1.0.0 |
// Create the snapshot var snapshot:BannedListSnapshot = new BannedListSnapshot(); // Register a callback function snapshot.onLoad = function ():void { trace("Here is the banned address list: " + snapshot.getBannedList()); } // Or register a listener function snapshot.addEventListener(SnapshotEvent.LOAD, loadListener); function loadListener (e:SnapshotEvent):void { var snapshot:BannedListSnapshot = BannedListSnapshot(e.target); trace("Here is the banned address list: " + snapshot.getBannedList()); } // Load the banned address list by passing the snapshot object to // Reactor's updateSnapshot() method: reactor.updateSnapshot(snapshot);
The list of banned addresses retrieved by BannedListSnapshot is a one-time snapshot of the state of the server, and is not kept up to date after it is loaded. To update a BannedListSnapshot object to match latest the state of the server, pass that object to Reactor's updateSnapshot() method.
See also
Method | Defined By | ||
---|---|---|---|
Constructor
| BannedListSnapshot | ||
getBannedList():Array
Returns an array of the banned addresses on the server. | BannedListSnapshot | ||
![]() | getStatus():String
Returns the status of the most recent snapshot load-operation. | Snapshot | |
![]() | updateInProgress():Boolean
Indicates whether the snapshot is currently loading data. | Snapshot |
BannedListSnapshot | () | Constructor |
public function BannedListSnapshot()
Constructor
getBannedList | () | method |
public function getBannedList():Array
Since : | Reactor 1.0.0 |
Returns an array of the banned addresses on the server.
ReturnsArray |