File

Paket	com.adobe.livecycle.content
Klasse	public class File
Vererbung	File EventDispatcher Object
Implementiert	IManaged

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

File enables efficient transportation of binary content to and from the Experiece Server. It never stores binary content inside it but has all metadata to store and retrieve binary content to/from server. It has capability to upload file from filesystem or byte array to server. It is Data Services managed class so that any content change is notified. It dispatches FileEvent.FILE_CONTENT_CHANGE_EVENT when content is modified on the Experience Server.

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		baseURL : String [statisch] The baseURL of Experience Server.	File
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		contentStreamPath : String TempPath when content is temporarily uploaded.	File
		contextRoot : String [statisch] The context root of launchpad application.	File
		created : Date Date when file is created.	File
		createdBy : String The user ID of user who created file.	File
		extendedPropertyMap : Object Additional key-value attributes whichare persisted along with file.	File
		fileName : String The name of the file.	File
		id : String The identifier of the file node.	File
		lastModified : Date The last date the content was modified.	File
		lastModifiedBy : String The user ID of user who last modified the file.	File
		mimeType : String The MIME type of the content.	File
		securityManager : SecurityManager [statisch] The User Manager (UM) SecurityManager instance.	File
		tempPath : String The temporary path to store the file.	File

Geschützte Eigenschaften

	Eigenschaft		Definiert von
		boundary : String [schreibgeschützt] Boundary of multipart request used in multipart binary upload of content.	File

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		File() constructor of File.	File
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	EventDispatcher
		deleteFile():void Deletes the JCR node specified by this instance.	File
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		downloadContentToByteArray():void download content of jcr node into ByteArray.	File
		downloadContentToFileSystem(defaultFileName:String = null):void Downloads content of the JCR node to filesytem.	File
		fillMetaData():void Fill the current instance with metadata of jcr node.	File
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		updateFromByteArray(fileData:ByteArray, mimeTypeStr:String = null):void Updates content of jcr node specified by this instance from file on ByteArray.	File
		updateFromFileReference(typeFilter:Array = null):void Updates content of jcr node specified by this instance from file on filesystem.	File
		uploadToPathFromByteArray(parentPath:String, fileData:ByteArray, mimeType:String, fileNameArg:String):void Uploads file to location specified by parenPath on the Experience Server from a ByteArray value.	File
		uploadToPathFromFileReference(parentPath:String, typeFilter:Array = null):void Uploads file on filesystem at path specified by parentPath on the Experience Server.	File
		uploadToTempFromByteArray(fileData:ByteArray, mimeType:String, fileNameArg:String = null):void Uploads file to temporary location to the Experience Server from a ByteArray value.	File
		uploadToTempFromFileReference(typeFilter:Array = null):void Uploads file on filesystem to temporary location on the Experience Server.It uses FileReference to upload file to the Experience Server.	File
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Geschützte Methoden

	Methode		Definiert von
		appendSecurityTicket(url:String, ticket:com.adobe.livecycle.ria.security.api:ITicket):String Appends User Manager (UM) ticket to the URL.	File

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Ereignis		Übersicht	Definiert von
		activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
		deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher

Öffentliche Konstanten

	Konstante		Definiert von
		NT_FILE : String = "nt:file" [statisch] constant representing nt:file	File
		TEMP_FOLDER_NAME : String = "/tmp/uploadFilesTempDir" [statisch] The temporary path of folder where temp files will be uploaded.	File

Eigenschaftendetails

baseURL

Eigenschaft

public static var baseURL:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The baseURL of Experience Server. Set it once and File APIs use it to upload and download content from it.

boundary

Eigenschaft

boundary:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Boundary of multipart request used in multipart binary upload of content.

Implementierung
protected function get boundary():String

contentStreamPath

Eigenschaft

contentStreamPath:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

TempPath when content is temporarily uploaded. It is only populated when content is uploaded using uploadToTempFromFileReference,uploadToTempFromByteArray. path of the content.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get contentStreamPath():String
public function set contentStreamPath(value:String):void

contextRoot

Eigenschaft

public static var contextRoot:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The context root of launchpad application.

created

Eigenschaft

created:Date

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Date when file is created.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get created():Date
public function set created(value:Date):void

createdBy

Eigenschaft

createdBy:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The user ID of user who created file.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get createdBy():String
public function set createdBy(value:String):void

extendedPropertyMap

Eigenschaft

extendedPropertyMap:Object

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Additional key-value attributes whichare persisted along with file. This value is applicable when the file is created using the RepositoryService or LiveCycleContentAssembler service.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get extendedPropertyMap():Object
public function set extendedPropertyMap(value:Object):void

fileName

Eigenschaft

fileName:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The name of the file.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get fileName():String
public function set fileName(value:String):void

id

Eigenschaft

id:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The identifier of the file node.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get id():String
public function set id(value:String):void

lastModified

Eigenschaft

lastModified:Date

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The last date the content was modified.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get lastModified():Date
public function set lastModified(value:Date):void

lastModifiedBy

Eigenschaft

lastModifiedBy:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The user ID of user who last modified the file.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get lastModifiedBy():String
public function set lastModifiedBy(value:String):void

mimeType

Eigenschaft

mimeType:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The MIME type of the content.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get mimeType():String
public function set mimeType(value:String):void

securityManager

Eigenschaft

public static var securityManager:SecurityManager

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The User Manager (UM) SecurityManager instance. Set it once and File APIs use it to retrieve ticket and credentials.

tempPath

Eigenschaft

tempPath:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The temporary path to store the file.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.

Implementierung
public function get tempPath():String
public function set tempPath(value:String):void

Konstruktordetails

()

Konstruktor

public function File()

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

constructor of File.

Methodendetails

appendSecurityTicket

()

Methode

protected function appendSecurityTicket(url:String, ticket:com.adobe.livecycle.ria.security.api:ITicket):String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Appends User Manager (UM) ticket to the URL.

Parameter

	`url:String` — url string

	`ticket:com.adobe.livecycle.ria.security.api:ITicket` — UM ticket

Rückgabewerte

String — ticket appended url

deleteFile

()

Methode

public function deleteFile():void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Deletes the JCR node specified by this instance. It dispatches FileEvent.FILE_DELETED_EVENT on completion of file upload.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_DELETED_EVENT
flash.events.Event.CANCEL
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR
flash.events.ProgressEvent.PROGRESS

downloadContentToByteArray

()

Methode

public function downloadContentToByteArray():void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

download content of jcr node into ByteArray. It dispatches FileEvent.FILE_DOWNLOAD_COMPLETED_EVENT on completion of file download.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_DOWNLOAD_COMPLETED_EVENT
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR
flash.events.ProgressEvent.PROGRESS

downloadContentToFileSystem

()

Methode

public function downloadContentToFileSystem(defaultFileName:String = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Downloads content of the JCR node to filesytem. It uses FileReference to download content. It dispatches FileEvent.FILE_DOWNLOAD_COMPLETED_EVENT on completion of file download.

Parameter

defaultFileName:String (default = null) — default file name by which file is saved on file system. It appears in save dialog box.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_DOWNLOAD_COMPLETED_EVENT
flash.events.Event.CANCEL
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR

fillMetaData

()

Methode

public function fillMetaData():void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Fill the current instance with metadata of jcr node. It makes a call to the Experience Server and retrieves all properties and fills in current instance. It dispatches FileEvent.FILE_METADATA_FILLED_EVENT when metadata is populated in instance.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_METADATA_FILLED_EVENT
flash.events.Event.CANCEL
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR
flash.events.ProgressEvent.PROGRESS

updateFromByteArray

()

Methode

public function updateFromByteArray(fileData:ByteArray, mimeTypeStr:String = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Updates content of jcr node specified by this instance from file on ByteArray. It uses FileReference to upload file from filesystem. It doesn't update content of temporary file i.e. File object created from uploadToTempFromFileReference and uploadToTempFromByteArray. It doesn't update content on File instance which is retrieved from repository. To update such instance upload content via uploadToTempFromFileReference or uploadToTempFromByteArray API and update it via LiveCycleContentAssembler or RepositoryService. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT on completion of file upload.

Parameter

	`fileData:ByteArray` — the data which will be updated

	`mimeTypeStr:String` (default = `null`) — the new mimeType of the data.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_UPLOAD_COMPLETED_EVENT
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR
flash.events.ProgressEvent.PROGRESS

updateFromFileReference

()

Methode

public function updateFromFileReference(typeFilter:Array = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Updates content of jcr node specified by this instance from file on filesystem. It uses FileReference to upload file from filesystem. It doesn't update content of temporary file i.e. File object created from uploadToTempFromFileReference and uploadToTempFromByteArray. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT on completion of file upload. It doesn't update content on File instance which is retrieved from repository. To update such instance upload content via uploadToTempFromFileReference or uploadToTempFromByteArray API and update it using the LiveCycleContentAssembler or RepositoryService service.

Parameter

typeFilter:Array (default = null) — file type filter to filter files in File select dialog.

Verwandte API-Elemente

com.adobe.livecycle.content.FileEvent.FILE_UPLOAD_COMPLETED_EVENT
flash.events.Event.CANCEL
flash.events.HTTPStatusEvent.HTTP_STATUS
flash.events.IOErrorEvent.IO_ERROR
flash.events.Event.OPEN
flash.events.SecurityErrorEvent.SECURITY_ERROR
flash.events.ProgressEvent.PROGRESS

uploadToPathFromByteArray

()

Methode

 public function uploadToPathFromByteArray(parentPath:String, fileData:ByteArray, mimeType:String, fileNameArg:String):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Uploads file to location specified by parenPath on the Experience Server from a ByteArray value. It creates nt:file node at temporary location. The current instance will be consumed by lc-content RepositoryService to move content from temp location to actual location. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT on completion of file upload.

Parameter

	`parentPath:String` — path upto parent folder location.

	`fileData:ByteArray` — content of file.

	`mimeType:String` — mimeType of file.

	`fileNameArg:String` — name of the file node that will be created on server.

Verwandte API-Elemente

uploadToPathFromFileReference

()

Methode

public function uploadToPathFromFileReference(parentPath:String, typeFilter:Array = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Uploads file on filesystem at path specified by parentPath on the Experience Server. It uses FileReference to upload file to the Experience Server. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT event when the file upload completes.

Parameter

	`parentPath:String` — path upto parent folder location.

	`typeFilter:Array` (default = `null`) — file type filter to filter files in File select dialog.

Verwandte API-Elemente

uploadToTempFromByteArray

()

Methode

public function uploadToTempFromByteArray(fileData:ByteArray, mimeType:String, fileNameArg:String = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Uploads file to temporary location to the Experience Server from a ByteArray value. It creates nt:file node at temporary location. The current instance will be consumed by lc-content RepositoryService to move content from temp location to actual location. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT on completion of file upload.

Parameter

	`fileData:ByteArray` — content of file.

	`mimeType:String` — mimeType of file.

	`fileNameArg:String` (default = `null`) — name of the file node that will be created on server.

Verwandte API-Elemente

uploadToTempFromFileReference

()

Methode

public function uploadToTempFromFileReference(typeFilter:Array = null):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

Uploads file on filesystem to temporary location on the Experience Server.It uses FileReference to upload file to the Experience Server. It creates nt:file node at temporary location. The current instance will be consumed by lc-content RepositoryService to move content from temp location to actual location. It dispatches FileEvent.FILE_UPLOAD_COMPLETED_EVENT on completion of file upload.

Parameter

typeFilter:Array (default = null) — file type filter to filter files in File select dialog.

Verwandte API-Elemente

Konstantendetails

NT_FILE

Konstante

public static const NT_FILE:String = "nt:file"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

constant representing nt:file

TEMP_FOLDER_NAME

Konstante

public static const TEMP_FOLDER_NAME:String = "/tmp/uploadFilesTempDir"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Experience Services - Content 10

Laufzeitversionen:

AIR 2.6, Flash Player 10.2

The temporary path of folder where temp files will be uploaded. The default path is /content/uploadFilesTempDir.

Rechtliche Hinweise | Onlinedatenschutzerklärung

File - AS3 ADEP Content

Klassen x

baseURL

boundary

contentStreamPath

contextRoot

created

createdBy

extendedPropertyMap

fileName

id

lastModified

lastModifiedBy

mimeType

securityManager

tempPath

File

appendSecurityTicket

deleteFile

downloadContentToByteArray

downloadContentToFileSystem

fillMetaData

updateFromByteArray

updateFromFileReference

uploadToPathFromByteArray

uploadToPathFromFileReference

uploadToTempFromByteArray

uploadToTempFromFileReference

NT_FILE

TEMP_FOLDER_NAME