ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
coldfusion.service.mxml 

Pop  - AS3 CF
Packagecoldfusion.service.mxml
Classpublic class Pop
InheritancePop Inheritance BasicService Inheritance InternalConfig Inheritance Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The proxy class for pop services exposed by ColdFusion.


Public Properties
 PropertyDefined By
 Inheritedaction : String
Action string for the service.
BasicService
 InheritedcfContextRoot : String
Context root of the ColdFusion server.
InternalConfig
 InheritedcfPort : int
Port where the ColdFusion server is running.
InternalConfig
 InheritedcfServer : String
Name or IP address of the ColdFusion server.
InternalConfig
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheriteddestination : String
Specifies the destination for the remoting call.
InternalConfig
  host : String
Pop server host name.
Pop
  maxRows : String
Number of messages to return or delete, starting with the number in startRow.
Pop
  messageNumber : String
Message number or comma-separated list of message numbers to get or delete.
Pop
  password : String
A password that corresponds to the user name.
Pop
  port : String
POP port.
Pop
 InheritedsecureHttp : Boolean
Boolean value that specifies if secure HTTP is used: yes: uses secure HTTP no: does not use secure HTTP
InternalConfig
 InheritedservicePassword : String
Password to access ColdFusion services.
InternalConfig
 InheritedserviceUserName : String
Username to access ColdFusion services.
InternalConfig
  startRow : String
First row number to get or delete.
Pop
  timeout : String
Maximum time, in seconds, to wait for mail processing.
Pop
  uid : String
UID or a comma-separated list of UIDs to get or delete.
Pop
  userName : String
A user name.
Pop
Public Methods
 MethodDefined By
  
Pop()
Creates an instance of the pop class.
Pop
 Inherited
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
 Inherited
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
BasicService
  
execute():void
Sends information to the ColdFusion service based on the action and attributes that the user sets.
Pop
 Inherited
getRemoteObject():RemoteObject
Returns the RemoteObject instance used by the proxy classes to make the remote object call.
BasicService
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BasicService
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BasicService
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Protected Methods
 MethodDefined By
  
convertResultInEvent(event:ResultEvent):ColdFusionServiceResultEvent
[override] This is the overriden function of the default implementation is BasicService.
Pop
Events
Click for more information on events
 Event Summary Defined By
 Inherited
fault
Dispatched when a ColdFusion service call fails.BasicService
 Inherited
result
Dispatched when a ColdFusion service call returns successfully.BasicService
Property Detail

host

property
public var host:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Pop server host name.

maxRows

property 
public var maxRows:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Number of messages to return or delete, starting with the number in startRow. Ignored if messageNumber or uid is specified.

The default value is Retrieves all available rows.

messageNumber

property 
public var messageNumber:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Message number or comma-separated list of message numbers to get or delete. Invalid message numbers are ignored. Ignored if uid is specified.

password

property 
public var password:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

A password that corresponds to the user name.

port

property 
public var port:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

POP port.

The default value is 110.

startRow

property 
public var startRow:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

First row number to get or delete. Ignored if messageNumber or uid is specified.

timeout

property 
public var timeout:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Maximum time, in seconds, to wait for mail processing.

The default value is 60.

uid

property 
public var uid:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

UID or a comma-separated list of UIDs to get or delete. Invalid UIDs are ignored.

userName

property 
public var userName:String

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

A user name.

Constructor Detail

Pop

()Constructor
public function Pop()

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates an instance of the pop class.

Method Detail

convertResultInEvent

()method
override protected function convertResultInEvent(event:ResultEvent):ColdFusionServiceResultEvent

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

This is the overriden function of the default implementation is BasicService. This function checks if the result returned is an array of specific object instances. If it is, it converts it into an array of objects and creates an instance of ColdFusionResultEvent and returns the event.

Parameters

event:ResultEvent

Returns
ColdFusionServiceResultEvent

execute

()method 
public function execute():void

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Sends information to the ColdFusion service based on the action and attributes that the user sets.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy