ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.content 

FileEvent  - AS3 ADEP Content
Packagecom.adobe.livecycle.content
Classpublic class FileEvent
InheritanceFileEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

FileEvent is dispatched when File APIs uploadToTempFromFileReference,uploadToTempFromByteArray, uploadToPathFromFileReference,uploadToPathFromByteArray, updateFromFileReference,updateFromByteArray, fillMetaData,deleteFile,downloadContentToFileSystem are invoked.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  filedata : ByteArray
[read-only] Filedata is populated when API File.downloadContentToByteArray is invoked.
FileEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
FileEvent(eventName:String, filedata:ByteArray = null)
Constructor.
FileEvent
  
clone():Event
[override] Creates clone of a FileEvent instance.
FileEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 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
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  FILE_CONTENT_CHANGE_EVENT : String = "fileContentChangeEvent"
[static] The FILE_CONTENT_CHANGE_EVENT constant defines the event type.
FileEvent
  FILE_DELETED_EVENT : String = "fileDeletedEvent"
[static] The FILE_DELETED_EVENT constant defines the event type.
FileEvent
  FILE_DOWNLOAD_COMPLETED_EVENT : String = "filedownloadCompletedEvent"
[static] The FILE_DOWNLOAD_COMPLETED_EVENT constant defines the event type.
FileEvent
  FILE_METADATA_FILLED_EVENT : String = "fileMetaDataFilledEvent"
[static] The FILE_METADATA_FILLED_EVENT constant defines the event type.
FileEvent
  FILE_UPLOAD_COMPLETED_EVENT : String = "fileUploadCompletedEvent"
[static] The FILE_UPLOAD_COMPLETED_EVENT constant defines the event type.
FileEvent
Property Detail

filedata

property
filedata:ByteArray  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Filedata is populated when API File.downloadContentToByteArray is invoked. In all other cases it is a value of null.



Implementation
    public function get filedata():ByteArray
Constructor Detail

FileEvent

()Constructor
public function FileEvent(eventName:String, filedata:ByteArray = null)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Constructor.

Parameters
eventName:String — name of the event
 
filedata:ByteArray (default = null) — binary content in case when API File.downloadContentToByteArray is invoked.
Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Creates clone of a FileEvent instance.

Returns
Event — A copy of the of FileEvent instance.
Constant Detail

FILE_CONTENT_CHANGE_EVENT

Constant
public static const FILE_CONTENT_CHANGE_EVENT:String = "fileContentChangeEvent"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The FILE_CONTENT_CHANGE_EVENT constant defines the event type. The event is dispatched when content is changed on server and corresponding File instance is managed object.

FILE_DELETED_EVENT

Constant 
public static const FILE_DELETED_EVENT:String = "fileDeletedEvent"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The FILE_DELETED_EVENT constant defines the event type. The event is dispatched when deleteFile is called on File and delete is completed on server.

FILE_DOWNLOAD_COMPLETED_EVENT

Constant 
public static const FILE_DOWNLOAD_COMPLETED_EVENT:String = "filedownloadCompletedEvent"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The FILE_DOWNLOAD_COMPLETED_EVENT constant defines the event type. The event is dispatched when content download on filesystem gets completed.

FILE_METADATA_FILLED_EVENT

Constant 
public static const FILE_METADATA_FILLED_EVENT:String = "fileMetaDataFilledEvent"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The FILE_METADATA_FILLED_EVENT constant defines the event type. The event is dispatched when fillMetaData is called on File and metadata is populated in File object.

FILE_UPLOAD_COMPLETED_EVENT

Constant 
public static const FILE_UPLOAD_COMPLETED_EVENT:String = "fileUploadCompletedEvent"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Content 10
Runtime Versions: AIR 2.6, Flash Player 10.2

The FILE_UPLOAD_COMPLETED_EVENT constant defines the event type. The event is dispatched when content upload on server gets completed.




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

 

Legal Notices | Online Privacy Policy