(Beta)
| Package | flash.events |
| Class | public class SyncEvent |
| Inheritance | SyncEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
sync event:
SyncEvent.SYNC.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| changeList : Array
An array of objects; each object contains properties that describe the changed members of a remote shared object. | SyncEvent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
SyncEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changeList:Array = null)
Creates an Event object that contains information about sync events. | SyncEvent | ||
[override]
Creates a copy of the SyncEvent object and sets the value of each property to match that of the original. | SyncEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the SyncEvent object. | SyncEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| SYNC : String = "sync" [static]
Defines the value of the type property of a sync event object. | SyncEvent | ||
Property Detail
changeList | property |
changeList:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
An array of objects; each object contains properties that describe the changed members of a remote shared object.
The properties of each object are code, name, and oldValue.
When you initially connect to a remote shared object that is persistent locally and/or on the server, all the properties of this object are set to empty strings.
Otherwise, Flash sets code to "clear",
"success", "reject", "change", or "delete".
- A value of
"clear"means either that you have successfully connected to a remote shared object that is not persistent on the server or the client, or that all the properties of the object have been deleted--for example, when the client and server copies of the object are so far out of sync that Flash Player resynchronizes the client object with the server object. In the latter case,SyncEvent.SYNCis dispatched and the "code" value is set to"change". - A value of
"success"means the client changed the shared object. - A value of
"reject"means the client tried unsuccessfully to change the object; instead, another client changed the object. - A value of
"change"means another client changed the object or the server resynchronized the object. - A value of
"delete"means the attribute was deleted.
The name property contains the name of the property that has been changed.
The oldValue property contains the former value of the changed property. This parameter is
null unless code has a value of "reject" or "change".
Implementation
public function get changeList():Array public function set changeList(value:Array):voidRelated API Elements
Constructor Detail
SyncEvent | () | Constructor |
public function SyncEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changeList:Array = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Creates an Event object that contains information about sync events.
Event objects are passed as parameters to event listeners.
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of sync event: SyncEvent.SYNC.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
changeList:Array (default = null)changeList property.
|
Related API Elements
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Creates a copy of the SyncEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new SyncEvent object with property values that match those of the original.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Returns a string that contains all the properties of the SyncEvent object. The string is in the following format:
[SyncEvent type=value bubbles=value cancelable=value list=value]
String — A string that contains all the properties of the SyncEvent object.
|
Constant Detail
SYNC | Constant |
public static const SYNC:String = "sync"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4 |
Defines the value of the type property of a sync event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
changeList | An array with properties that describe the array's status. |
target | The SharedObject instance that has been updated by the server. |
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00