BasicService

Package	coldfusion.service
Class	public class BasicService
Inheritance	BasicService InternalConfig Object
Implements	IEventDispatcher, IMXMLObject
Subclasses	Chart, Document, Image, Ldap, Mail, Pdf, Pop

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

The base class for all the proxy classes that interact with the different ColdFusion services, such as, image or pdf.

Public Properties

	Property		Defined By
		action : String Action string for the service.	BasicService
		cfContextRoot : String Context root of the ColdFusion server.	InternalConfig
		cfPort : int Port where the ColdFusion server is running.	InternalConfig
		cfServer : String Name or IP address of the ColdFusion server.	InternalConfig
		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.	InternalConfig
		secureHttp : Boolean Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP	InternalConfig
		servicePassword : String Password to access ColdFusion services.	InternalConfig
		serviceUserName : String Username to access ColdFusion services.	InternalConfig

Public Methods

	Method		Defined By
		BasicService(source:String) The constructor that accepts the source CFC on the ColdFusion-side of the service.	BasicService
		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.	BasicService
		dispatchEvent(evt:Event):Boolean Dispatches an event into the event flow.	BasicService
		getRemoteObject():RemoteObject Returns the RemoteObject instance used by the proxy classes to make the remote object call.	BasicService
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	BasicService
		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
		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.	BasicService
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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.	BasicService

Events

Click for more information on events

	Event		Summary	Defined By
		fault	Dispatched when a ColdFusion service call fails.	BasicService
		result	Dispatched when a ColdFusion service call returns successfully.	BasicService

Property Detail

action

property

public var action:String

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Action string for the service.

Constructor Detail

BasicService

()

Constructor

public function BasicService(source:String)

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

The constructor that accepts the source CFC on the ColdFusion-side of the service.

Parameters

source:String

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:

ColdFusion 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:

ColdFusion 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.

getRemoteObject

()

method

public function getRemoteObject():RemoteObject

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 9

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the RemoteObject instance used by the proxy classes to make the remote object call.

Returns

RemoteObject

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 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.

removeEventListener

()

method

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

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 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.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

ColdFusion 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.service.events.ColdFusionServiceFaultEvent
property ColdFusionServiceFaultEvent.type = coldfusion.service.events.ColdFusionServiceFaultEvent.FAULT

Dispatched when a ColdFusion service call fails.

Defines the value of the Type property of a ColdFusionServiceFaultEvent object.

result

Event

Event Object Type: coldfusion.service.events.ColdFusionServiceResultEvent
property ColdFusionServiceResultEvent.type = coldfusion.service.events.ColdFusionServiceResultEvent.RESULT

Dispatched when a ColdFusion service call returns successfully.

The RESULT event type.

Legal Notices | Online Privacy Policy

BasicService - AS3 CF

Classes x

action

BasicService

addEventListener

dispatchEvent

getRemoteObject

hasEventListener

removeEventListener

willTrigger

fault

result