coldfusion.air.SyncManager (ColdFusion 9)

	Property	Defined By
		cfContextRoot : String Context root of the ColdFusion server.	SyncManager
		cfPort : int Port where the ColdFusion server is running.	SyncManager
		cfServer : String Name or IP address of the ColdFusion server.	SyncManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		destination : String Specifies the destination for the remoting call.	SyncManager
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		secureHttp : Boolean Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP	SyncManager
		syncCFC : String Fully qualified CFC name that implements the CFIDE.AIR.ISyncManager interface.	SyncManager

	Method	Defined By
		SyncManager() Creates an instance of the SyncManager class.	SyncManager
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	SyncManager
		dispatchEvent(evt:Event):Boolean Dispatches an event into the event flow.	SyncManager
		fetch(fetchMethod:String, ... args):mx.rpc:AsyncToken Fetches the data from the server.	SyncManager
		getCurrentSession():Session Returns the Session instance that is currently open.	SyncManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	SyncManager
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		openSession(dbfile:File, id:uint):coldfusion.air:SessionToken Creates a session with a specific database file.	SyncManager
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	SyncManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		sync(operations:Array, newInstances:Array, oldInstances:Array, successFunction:Function, faultFunction:Function):mx.rpc:AsyncToken	SyncManager
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	SyncManager

	Event	Summary	Defined By
		fault	Dispatched when a session service call fails.	SyncManager
		result	Dispatched when a syncmanager call returns successfully.	SyncManager

Property Detail

cfContextRoot

property

public var cfContextRoot:String

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Context root of the ColdFusion server.

cfPort

property

public var cfPort:int

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Port where the ColdFusion server is running.

cfServer

property

public var cfServer:String

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Name or IP address of the ColdFusion server.

destination

property

public var destination:String

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Specifies the destination for the remoting call.

secureHttp

property

public var secureHttp:Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Boolean value that specifies if secure HTTP is used:

yes: uses secure HTTP
no: does not use secure HTTP

syncCFC

property

public var syncCFC:String

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Fully qualified CFC name that implements the CFIDE.AIR.ISyncManager interface.

Constructor Detail

SyncManager

()

Constructor

public function SyncManager()

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Creates an instance of the SyncManager class.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases: If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase.

	`priority:int` (default = `0`) — The priority level of the event listener. The priority is designated by a signed 32-bit integer.

	`useWeakReference:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak.

dispatchEvent

()

method

public function dispatchEvent(evt:Event):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Dispatches an event into the event flow.

Parameters

evt:Event — The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically.

Returns

Boolean — A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.

fetch

()

method

public function fetch(fetchMethod:String, ... args):mx.rpc:AsyncToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Fetches the data from the server.

Parameters

	`fetchMethod:String` — The name of the fetch method to be executed on the server.

	`... args` — The arguments for `fetchMethod`

Returns

mx.rpc:AsyncToken — An AsyncToken with which call backs can be registered.

getCurrentSession

()

method

public function getCurrentSession():Session

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the Session instance that is currently open.

Returns

Session

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type actually triggers an event listener, use willTrigger().

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

openSession

()

method

public function openSession(dbfile:File, id:uint):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Creates a session with a specific database file.

Parameters

	`dbfile:File` — The File reference associated with the database file

	`id:uint` — Unique session ID per session

Returns

coldfusion.air:SessionToken — The session token associated with the call

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Removes a listener from the EventDispatcher object.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases.

sync

()

method

 public function sync(operations:Array, newInstances:Array, oldInstances:Array, successFunction:Function, faultFunction:Function):mx.rpc:AsyncToken

Parameters

	`operations:Array`

	`newInstances:Array`

	`oldInstances:Array`

	`successFunction:Function`

	`faultFunction:Function`

Returns

mx.rpc:AsyncToken

willTrigger

()

method

public function willTrigger(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Event Detail

fault

Event

Event Object Type: coldfusion.air.events.SyncFaultEvent
property SyncFaultEvent.type = coldfusion.air.events.SyncFaultEvent.FAULT

Dispatched when a session service call fails.

The type of the event.

result

Event

Event Object Type: coldfusion.air.events.SyncResultEvent
property SyncResultEvent.type = coldfusion.air.events.SyncResultEvent.RESULT

Dispatched when a syncmanager call returns successfully.

The type of the event.

Adobe® ColdFusion® 9 Language Reference Language Reference only	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
SyncManager	Properties \| Methods \| Events

Package	coldfusion.air
Class	public class SyncManager
Inheritance	SyncManager Object
Implements	IEventDispatcher