| Package | flash.events |
| Class | public class SyncEvent |
| Inheritance | SyncEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | 1.0, 9 |
sync
event:
SyncEvent.SYNC
.
See also
| 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 | |
| prototype : Object [static] A reference to the prototype object of a class or function object. | Object | |
| target : Object [read-only] The event target. | Event | |
| type : String [read-only] The type of event. | Event | |
| 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 | ||
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 your custom Event class. | Event | |
| Indicates whether an object has a specified property defined. | Object | |
| Checks whether preventDefault() 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 a string that contains all the properties of the SyncEvent object. | SyncEvent | ||
| Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static] Defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static] Defines the value of the type property of an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static] Defines the value of the type property of a clear event object. | Event | |
| CLOSE : String = "close" [static] Defines the value of the type property of a close event object. | Event | |
| COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static] Defines the value of the type property of a connect event object. | Event | |
| COPY : String = "copy" [static] Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static] Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static] Defines the value of the type property of a deactivate event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static] Defines the value of the type property of an exitFrame event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static] Defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static] The Event.FULLSCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static] Defines the value of the type property of an init event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object. | Event | |
| OPEN : String = "open" [static] Defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static] Defines the value of the type property of a paste event object. | Event | |
| REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static] Defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static] Defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static] Defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the type property of a soundComplete event object. | Event | |
| SYNC : String = "sync" [static] Defines the value of the type property of a sync event object. | SyncEvent | ||
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object. | Event | |
| UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object. | Event | |
| changeList | property |
Hide Inherited Public Properties
Show Inherited Public PropertieschangeList:Array [read-write] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | 1.0, 9 |
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"
.
"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.SYNC
is dispatched and the "code" value
is set to
"change"
.
"success"
means the client changed the shared object.
"reject"
means the client tried unsuccessfully to change the object; instead, another client changed the object.
"change"
means another client changed the object or the server resynchronized the object.
"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"
.
public function get changeList():Array public function set changeList(value:Array):voidSee also
| SyncEvent | () | Constructor |
public function SyncEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changeList:Array = null)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | 1.0, 9 |
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.
|
See also
| clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | 1.0, 9 |
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: | 1.0, 9 |
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. |
| SYNC | Constant |
public static const SYNC:String = "sync"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | 1.0, 9 |
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. |
See also