URLFilePromise

Paket	air.desktop
Klasse	public class URLFilePromise
Vererbung	URLFilePromise EventDispatcher Object
Implementiert	IFilePromise

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Die URLFilePromise-Klasse ermöglicht, dass Ressourcen, die über eine URL zugänglich sind, als Dateizusage aus einer AIR-Anwendung gezogen werden können.

Die URLFilePromise-Klasse implementiert die IFilePromise-Schnittstelle unter Verwendung von URLStream- und URLRequest-Objekten als Datenquelle. Die Implementierung bietet Drag-and-Drop-Unterstützung für Dateien, die mithilfe von HTTP oder anderen von der URLStream-Klasse unterstützten Protokollen abgerufen werden.

So erstellen Sie eine URL-Dateizusage:

Konstruieren und initialisieren Sie ein oder mehrere URLFilePromise-Objekte.
Fügen Sie die URLFilePromise-Objekte einem Array hinzu.
Fügen Sie das Array einem neuen Clipboard-Objekt hinzu, indem Sie ClipboardFormat, FILE_PROMISE_LIST verwenden.
Rufen Sie als Antwort auf eine Benutzergeste die startDrag()-Methode von NativeDragManager auf, wobei Sie das Clipboard-Objekt übergeben, das das Array von Dateizusagen enthält.

Wenn der Benutzer den Ziehen-Vorgang abschließt, lädt die Laufzeitumgebung die Daten für jede Dateizusage herunter. Die Daten werden an der von der request-Eigenschaft des URLFilePromise-Objekts angebebenen URL aufgerufen und in der von der relativePath-Eigenschaft angegebenen Datei gespeichert. Die Datei wird relativ zu ihrer Ablageposition gespeichert. Wenn der relative Pfad foo/bar.txt ist und die Dateizusage in einem Verzeichnis namens home abgelegt wird, ist der Speicherort der erstellten Datei demzufolge: home/foo/bar.txt. Wenn ein Fehler auftritt, wird die Datei nicht erstellt.

Um Datenquellen zu unterstützen, auf die nicht über die URLStream-Klasse zugegriffen werden kann, implementieren Sie die IFilePromise-Schnittstelle.

Hinweis: Die AIR-Laufzeitumgebung ruft die IFilePromise-Methoden open(), close() und reportError() automatisch auf. Diese Methoden sollten niemals von Ihrer Anwendungslogik aufgerufen werden. In ähnlicher Weise werden die Ereignisse open, progress, complete und close, die von diesem URLFilePromise-Objekt abgesetzt werden, hauptsächlich für Debugging-Zwecke bereitgestellt. Ihre Anwendung braucht nicht auf diese Ereignisse zu reagieren.

Diese Klasse ist in der Datei „aircore.swc“ enthalten. Adobe^® Flash^® Builder lädt diese Klasse automatisch, wenn Sie ein Projekt für Adobe ^® AIR^™ erstellen. Das Adobe^® Flex^™ SDK enthält ebenfalls die Datei „aircore.swc“, die Sie beim Kompilieren der Anwendung einschließen sollten, wenn Sie das Flex SDK verwenden.

So verwenden Sie das air.desktop-Paket in Adobe^® Flash^® Professional (CS4 oder höher):

Wählen Sie „Datei“ > „Einstellungen für Veröffentlichungen“.
Klicken Sie im Flash-Bedienfeld auf die Schaltfläche „Einstellungen“ für ActionScript 3.0. Wählen Sie „Bibliothekspfad“.
Klicken Sie auf die Schaltfläche „Zur SWC-Datei navigieren“. Navigieren Sie zur Datei „Adobe Flash CSn/AIKn.n/frameworks/libs/air/aircore.swc“ im Adobe Flash Professional-Installationsordner.
Klicken Sie auf „OK“.
Fügen Sie dem ActionScript 3.0-Code folgende import-Anweisung hinzu: import air.desktop.*;

Verwandte API-Elemente

IFilePromise-Schnittstelle
Clipboard-Klasse
ClipboardFormats-Klasse
NativeDragManager-Klasse
URLStream-Klasse
URLRequest-Klasse

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		isAsync : Boolean [schreibgeschützt] Gibt an, ob die Ressourcendaten asynchron verfügbar sind.	URLFilePromise
		relativePath : String Der Pfad und der Dateiname der erstellten Datei relativ zur Ablegeposition.	URLFilePromise
		request : URLRequest Der URLRequest, der die Ressource identifiziert, die als Ergebnis des Drag-and-Drop-Vorgangs kopiert werden soll.	URLFilePromise

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		URLFilePromise() Erstellt ein URLFilePromise-Objekt.	URLFilePromise
		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
		close():void Lässt zu, dass die AIR-Laufzeitumgebung die Datenquelle zur richtigen Zeit während des Drag-and-Drop-Vorgangs schließt.	URLFilePromise
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		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
		open():IDataInput Lässt zu, dass die AIR-Laufzeitumgebung die Datenquelle zur richtigen Zeit während des Drag-and-Drop-Vorgangs öffnet.	URLFilePromise
		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
		reportError(e:ErrorEvent):void Lässt zu, dass die AIR-Laufzeitumgebung Fehler meldet, die während des Drag-and-Drop-Vorgangs auftreten.	URLFilePromise
		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
		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

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Übersicht	Definiert von
activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
complete	Wird ausgelöst, wenn die Daten für die Datei vollständig heruntergeladen wurden.	URLFilePromise
deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher
httpResponseStatus	Wird für HTTP-Anforderungen ausgelöst, um die Antwort-Header zu melden.	URLFilePromise
httpStatus	Wird für HTTP-Anforderungen ausgelöst, um den Anforderungsstatuscode zu melden.	URLFilePromise
ioError	Wird abgesetzt, wenn ein IOError den Dateidownload verhindert.	URLFilePromise
open	Wird ausgelöst, wenn die zugrundeliegende URLStream-Verbindung geöffnet wird.	URLFilePromise
progress	Wird ausgelöst, wenn ein Datenblock zum Lesen aus dem zugrundeliegenden URLStream verfügbar ist.	URLFilePromise
securityError	Wird ausgelöst, wenn ein Sicherheitsfehler den Dateidownload verhindert.	URLFilePromise

Eigenschaftendetails

isAsync

Eigenschaft

isAsync:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Gibt an, ob die Ressourcendaten asynchron verfügbar sind.

Die isAsync-Eigenschaft eines URLFilePromise-Objekts ist immer true, da URL-Streams naturgemäß asynchron sind.

Implementierung
public function get isAsync():Boolean

relativePath

Eigenschaft

relativePath:String

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Der Pfad und der Dateiname der erstellten Datei relativ zur Ablegeposition.

Der Pfad kann Unterverzeichnisse enthalten, die basierend auf dem Ablegeziel aufgelöst werden. Die Unterverzeichnisse werden erstellt, falls erforderlich. Wenn Unterverzeichnisse einbezogen werden, verwenden Sie die File.separator-Konstante, um das richtige Pfadtrennzeichen für das aktuelle Betriebssystem einzufügen. Die Verwendung der Kurzform .., um zu einem übergeordneten Verzeichnis zu navigieren, ist nicht zulässig.

Der Dateiname muss nicht mit dem Dateinamen der Remoteressource identisch sein.

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

request

Eigenschaft

request:URLRequest

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Der URLRequest, der die Ressource identifiziert, die als Ergebnis des Drag-and-Drop-Vorgangs kopiert werden soll.

Implementierung
public function get request():URLRequest
public function set request(value:URLRequest):void

Konstruktordetails

()

Konstruktor

public function URLFilePromise()

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Erstellt ein URLFilePromise-Objekt.

Sie müssen die request- und relativePath-Eigenschaft festlegen, bevor Sie dieses URLFilePromise-Objekt verwenden.

Methodendetails

close

()

Methode

public function close():void

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Lässt zu, dass die AIR-Laufzeitumgebung die Datenquelle zur richtigen Zeit während des Drag-and-Drop-Vorgangs schließt.

Rufen Sie diese Funktion nicht in Ihrer Anwendungslogik aus.

open

()

Methode

public function open():IDataInput

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Lässt zu, dass die AIR-Laufzeitumgebung die Datenquelle zur richtigen Zeit während des Drag-and-Drop-Vorgangs öffnet.

Rufen Sie diese Funktion nicht in Ihrer Anwendungslogik aus.

Rückgabewerte

IDataInput

reportError

()

Methode

public function reportError(e:ErrorEvent):void

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Lässt zu, dass die AIR-Laufzeitumgebung Fehler meldet, die während des Drag-and-Drop-Vorgangs auftreten.

Das URLFilePromise-Objekt setzt alle gemeldeten Fehlerereignisse erneut ab. Rufen Sie diese Funktion nicht in Ihrer Anwendungslogik aus.

Parameter

e:ErrorEvent

Ereignisdetails

complete

Ereignis

Ereignisobjekttyp: flash.events.Event
Eigenschaft Event.type = flash.events.Event.COMPLETE

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird ausgelöst, wenn die Daten für die Datei vollständig heruntergeladen wurden.

Hinweis: Die AIR-Laufzeitumgebung verwendet dieses Ereignis, um den asynchronen Datenabruf zu verwalten. Normalerweise besteht für Ihre Anwendung keinerlei Notwendigkeit, als Reaktion auf dieses Ereignis Aktionen auszuführen.

Die Event.COMPLETE-Konstante definiert den Wert der type-Eigenschaft eines complete-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Netzwerkobjekt, dessen Ladevorgang beendet ist.

httpResponseStatus

Ereignis

Ereignisobjekttyp: flash.events.HTTPStatusEvent
Eigenschaft HTTPStatusEvent.type = flash.events.HTTPStatusEvent.HTTP_RESPONSE_STATUS

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird für HTTP-Anforderungen ausgelöst, um die Antwort-Header zu melden.

Anders als das httpStatus-Ereignis wird das httpResponseStatus-Ereignis ausgelöst, bevor Antwortdaten vorliegen. Außerdem enthält das httpResponseStatus-Ereignis Werte für die Eigenschaften responseHeaders und responseURL (die für ein httpStatus-Ereignis nicht definiert sind). Beachten Sie, dass das Ereignis httpResponseStatus (falls vorhanden) vor (und zusätzlich zu) jedem complete- oder error-Ereignis gesendet wird.

Die HTTPStatusEvent.HTTP_RESPONSE_STATUS-Konstante definiert den Wert der type-Eigenschaft eines httpResponseStatus-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`responseURL`	Die URL, von der die Antwort zurückgegeben wurde.
`responseHeaders`	Die Antwortheader, die die Antwort zurückgegeben hat, als Array von URLRequestHeader-Objekten.
`status`	Der vom Server zurückgegebene HTTP-Statuscode.
`redirected`	Gibt an, ob die Antwort das Ergebnis einer Weiterleitung ist.
`target`	Das Netzwerkobjekt, das den HTTP-Statuscode empfängt.

httpStatus

Ereignis

Ereignisobjekttyp: flash.events.HTTPStatusEvent
Eigenschaft HTTPStatusEvent.type = flash.events.HTTPStatusEvent.HTTP_STATUS

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird für HTTP-Anforderungen ausgelöst, um den Anforderungsstatuscode zu melden.

Die HTTPStatusEvent.HTTP_STATUS-Konstante definiert den Wert der type-Eigenschaft eines httpStatus-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`status`	Der vom Server zurückgegebene HTTP-Statuscode.
`target`	Das Netzwerkobjekt, das den HTTP-Statuscode empfängt.

ioError

Ereignis

Ereignisobjekttyp: flash.events.IOErrorEvent
Eigenschaft IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird abgesetzt, wenn ein IOError den Dateidownload verhindert.

Definiert den Wert der Eigenschaft type eines ioError-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`errorID`	Die Referenznummer des spezifischen Fehlers (nur AIR).
`target`	Das Netzwerkobjekt, bei dem der Eingabe/Ausgabe-Fehler auftritt.
`text`	Der als Fehlermeldung anzuzeigende Text.

open

Ereignis

Ereignisobjekttyp: flash.events.Event
Eigenschaft Event.type = flash.events.Event.OPEN

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird ausgelöst, wenn die zugrundeliegende URLStream-Verbindung geöffnet wird.

Die Event.OPEN-Konstante definiert den Wert der type-Eigenschaft eines open-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Netzwerkobjekt, über das eine Verbindung geöffnet wurde.

progress

Ereignis

Ereignisobjekttyp: flash.events.ProgressEvent
Eigenschaft ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird ausgelöst, wenn ein Datenblock zum Lesen aus dem zugrundeliegenden URLStream verfügbar ist.

Definiert den Wert der Eigenschaft type eines progress-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`bytesLoaded`	Die Anzahl der geladenen Elemente oder Byte zu dem Zeitpunkt, zu dem der Listener das Ereignis verarbeitet.
`bytesTotal`	Die Gesamtanzahl der Elemente oder Byte, die bei einem erfolgreichen Ladevorgang schließlich geladen werden.
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Objekt, dessen Fortschritt protokolliert wird.

securityError

Ereignis

Ereignisobjekttyp: flash.events.SecurityErrorEvent
Eigenschaft SecurityErrorEvent.type = flash.events.SecurityErrorEvent.SECURITY_ERROR

Sprachversion:

ActionScript 3.0

Laufzeitversionen:

AIR 2.0

Wird ausgelöst, wenn ein Sicherheitsfehler den Dateidownload verhindert.

Die Konstante SecurityErrorEvent.SECURITY_ERROR definiert den Wert der type-Eigenschaft eines securityError-Ereignisobjekts.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Eigenschaft	Wert
`bubbles`	`false`
`cancelable`	`false`. Es gibt kein Standardverhalten, das abgebrochen werden kann.
`currentTarget`	Das Objekt, welches das Ereignisobjekt aktiv mit einem Ereignis-Listener verarbeitet.
`target`	Das Netzwerkobjekt, das den Sicherheitsfehler ausgibt.
`text`	Der als Fehlermeldung anzuzeigende Text.

Rechtliche Hinweise | Onlinedatenschutzerklärung

URLFilePromise - AS3

Klassen x

isAsync

relativePath

request

URLFilePromise

close

open

reportError

complete

httpResponseStatus

httpStatus

ioError

open

progress

securityError