URLFilePromise

パッケージ	air.desktop
クラス	public class URLFilePromise
継承	URLFilePromise EventDispatcher Object
実装	IFilePromise

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

URLFilePromise クラスを使用すると、特定の URL でリソースにアクセスし、そのリソースをファイルプロミスとして AIR アプリケーションからドラッグできます。

URLFilePromise クラスは、IFilePromise インターフェイスを実装し、URLStream オブジェクトおよび URLRequest オブジェクトをデータソースとして使用します。この実装により、HTTP や URLStream クラスでサポートしている他のプロトコルを使用して、ファイルをドラッグ＆ドロップで取得できるようになります。

URL ファイルプロミスを作成するには：

URLFilePromise オブジェクトを 1 つ以上作成して初期化します。
URLFilePromise オブジェクトを配列に追加します。
ClipboardFormat の FILE_PROMISE_LIST を使用して、この配列を新しい Clipboard オブジェクトに追加します。
ユーザーのジェスチャに応答して、NativeDragManager の startDrag() メソッドを呼び出し、ファイルプロミスの配列が含まれている Clipboard オブジェクトに渡します。

ユーザーがドラッグ操作を完了すると、ランタイムによって各ファイルプロミスのデータがダウンロードされます。データは、URLFilePromise オブジェクトの request プロパティで指定された URL でアクセスでき、relativePath プロパティで指定されたファイルに保存されます。ファイルは、ドロップ位置の相対位置に保存されます。したがって、相対パスが foo/bar.txt で、ファイルプロミスが home という名前のディレクトリにある場合、作成されたファイルの位置は home¥foo¥bar.txt になります。エラーが発生した場合、ファイルは作成されません。

URLStream クラスではアクセスできないデータソースに対応するには、IFilePromise インターフェイスを実装します。

注意：AIR ランタイムでは、IFilePromise メソッド、open()、close() および reportError() メソッドを自動的に呼び出します。これらのメソッドは、アプリケーションロジックから呼び出されることはありません。同様に、この URLFilePromise オブジェクトが送出する open、progress、complete および close イベントは、主にデバッグを目的としています。アプリケーションがこれらのイベントに応答する必要はありません。

このクラスは、aircore.swc ファイルに含まれます。Adobe^® AIR^® のプロジェクトを作成すると、Adobe^® Flash^® Builder によって、このクラスが自動的にロードされます。この aircore.swc ファイルは Adobe^® Flex^™ SDK にも含まれています。アプリケーションをコンパイルするときに Flex SDK を使用している場合は、このファイルを含める必要があります。

Adobe^® Flash^® Professional（CS4 またはそれ以降）で air.desktop パッケージを使用するには：

ファイル／パブリッシュ設定コマンドを選択します。
Flash パネルで、ActionScript 3.0 の「設定」ボタンをクリックします。「ライブラリパス」を選択します。
「SWC ファイルを参照」ボタンをクリックします。Adobe Flash Professional インストールフォルダーで Adobe Flash CSn/AIKn.n/frameworks/libs/air/aircore.swc ファイルを参照します。
「OK」をクリックします。
import ステートメントの import air.desktop.*; を ActionScript 3.0 コードに追加します。

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		isAsync : Boolean [読み取り専用] リソースデータを非同期的に使用できるかどうかを示します。	URLFilePromise
		relativePath : String 作成されたファイルのパス名とファイル名は、ドロップ先を基準とする相対パスで指定されます。	URLFilePromise
		request : URLRequest ドラッグ＆ドロップ操作の結果としてコピーされるリソースを識別する URLRequest です。	URLFilePromise

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		URLFilePromise() URLFilePromise オブジェクトを作成します。	URLFilePromise
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		close():void このメソッドを使用すると、ドラッグ＆ドロップ操作時に、AIR ランタイムが適切なタイミングでデータソースを閉じることができます。	URLFilePromise
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		open():IDataInput このメソッドを使用すると、ドラッグ＆ドロップ操作時に、AIR ランタイムが適切なタイミングでデータソースを開くことができます。	URLFilePromise
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		reportError(e:ErrorEvent):void このメソッドを使用すると、AIR ランタイムは、ドラッグ＆ドロップ操作時に発生したエラーを報告できます。	URLFilePromise
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
complete	ファイルのデータが完全にダウンロードされたときに送出されます。	URLFilePromise
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
httpResponseStatus	このイベントが送出されると、HTTP 要求は応答ヘッダーを報告します。	URLFilePromise
httpStatus	このイベントが送出されると、HTTP 要求は要求の状態コードを報告します。	URLFilePromise
ioError	IOError が原因でファイルをダウンロードできない場合に送出されます。	URLFilePromise
open	基になる URLStream 接続が開かれたときに送出されます。	URLFilePromise
progress	基になる URLStream からデータブロックを読み取れるようになると送出されます。	URLFilePromise
securityError	セキュリティエラーが原因でファイルをダウンロードできない場合に送出されます。	URLFilePromise

プロパティの詳細

isAsync

プロパティ

isAsync:Boolean [読み取り専用]

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

リソースデータを非同期的に使用できるかどうかを示します。

URLFilePrmise オブジェクトの isAsync プロパティは、URL ストリームが本質的に非同期なので、常に true です。

実装
public function get isAsync():Boolean

relativePath

プロパティ

relativePath:String

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

作成されたファイルのパス名とファイル名は、ドロップ先を基準とする相対パスで指定されます。

パスにはサブディレクトリを含めることができ、このサブディレクトリは、ドロップ先に基づいて解決されます。サブディレクトリは必要に応じて作成されます。サブディレクトリを含める場合は、File.separator 定数を使用して、現在のオペレーティングシステムに対応した適切なパス区切り文字を挿入してください。短縮形「..」を使用して、親ディレクトリへは移動できません。

ファイル名は、リモートリソースのファイル名と同じである必要はありません。

実装
public function get relativePath():String
public function set relativePath(value:String):void

request

プロパティ

request:URLRequest

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

ドラッグ＆ドロップ操作の結果としてコピーされるリソースを識別する URLRequest です。

実装
public function get request():URLRequest
public function set request(value:URLRequest):void

コンストラクターの詳細

()

コンストラクター

public function URLFilePromise()

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

URLFilePromise オブジェクトを作成します。

この URLFilePromise オブジェクトを使用する前に、request プロパティおよび relativePath プロパティを設定する必要があります。

メソッドの詳細

close

()

メソッド

public function close():void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

このメソッドを使用すると、ドラッグ＆ドロップ操作時に、AIR ランタイムが適切なタイミングでデータソースを閉じることができます。

アプリケーションロジックではこの関数を呼び出さないようにしてください。

open

()

メソッド

public function open():IDataInput

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

このメソッドを使用すると、ドラッグ＆ドロップ操作時に、AIR ランタイムが適切なタイミングでデータソースを開くことができます。

アプリケーションロジックではこの関数を呼び出さないようにしてください。

戻り値

IDataInput

reportError

()

メソッド

public function reportError(e:ErrorEvent):void

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

このメソッドを使用すると、AIR ランタイムは、ドラッグ＆ドロップ操作時に発生したエラーを報告できます。

URLFilePromise オブジェクトは、報告されたエラーイベントをすべて再送出します。アプリケーションロジックではこの関数を呼び出さないようにしてください。

パラメーター

e:ErrorEvent

イベントの詳細

complete

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.COMPLETE

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

ファイルのデータが完全にダウンロードされたときに送出されます。

注意：AIR ランタイムは、このイベントを使用して、非同期のデータ取得プロセスを管理します。通常、アプリケーションがこのイベントに応答して何らかの操作を実行する必要はありません。

Event.COMPLETE 定数は、type プロパティ（complete イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	読み込みが完了したネットワークオブジェクトです。

httpResponseStatus

イベント

イベントオブジェクトの型: flash.events.HTTPStatusEvent
プロパティ HTTPStatusEvent.type = flash.events.HTTPStatusEvent.HTTP_RESPONSE_STATUS

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

このイベントが送出されると、HTTP 要求は応答ヘッダーを報告します。

httpStatus イベントと異なり、httpResponseStatus イベントは応答データの前に配信されます。また、httpResponseStatus イベントには responseHeaders プロパティと responseURL プロパティの値が含まれます（これらは httpStatus イベントでは定義されていません）。httpResponseStatus イベントは、発生した場合、complete イベントまたは error イベントの前に、これらのイベントとは別に送信されます。

HTTPStatusEvent.HTTP_RESPONSE_STATUS 定数は、type プロパティ（httpResponseStatus イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`responseURL`	応答の返送元の URL です。
`responseHeaders`	返された応答ヘッダー（URLRequestHeader オブジェクトの配列）です。
`status`	サーバーから返された HTTP ステータスコードです。
`redirected`	応答にリダイレクトの結果があるかどうか。
`target`	HTTP ステータスコードを受け取るネットワークオブジェクトです。

httpStatus

イベント

イベントオブジェクトの型: flash.events.HTTPStatusEvent
プロパティ HTTPStatusEvent.type = flash.events.HTTPStatusEvent.HTTP_STATUS

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

このイベントが送出されると、HTTP 要求は要求の状態コードを報告します。

HTTPStatusEvent.HTTP_STATUS 定数は、type プロパティ（httpStatus イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`status`	サーバーから返された HTTP ステータスコードです。
`target`	HTTP ステータスコードを受け取るネットワークオブジェクトです。

ioError

イベント

イベントオブジェクトの型: flash.events.IOErrorEvent
プロパティ IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

IOError が原因でファイルをダウンロードできない場合に送出されます。

type プロパティ（ioError イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`errorID`	特定のエラーに関連付けられた参照番号です（AIR のみ）。
`target`	入出力エラーが発生したネットワークオブジェクトです。
`text`	エラーメッセージとして表示されるテキストです。

open

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.OPEN

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

基になる URLStream 接続が開かれたときに送出されます。

Event.OPEN 定数は、type プロパティ（open イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	接続をオープンしたネットワークオブジェクトです。

progress

イベント

イベントオブジェクトの型: flash.events.ProgressEvent
プロパティ ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

基になる URLStream からデータブロックを読み取れるようになると送出されます。

type プロパティ（progress イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`bytesLoaded`	リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。
`bytesTotal`	読み込みプロセスが成功した場合に最終的に読み込まれるアイテムまたはバイトの総数です。
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	進行状況をレポートするオブジェクトです。

securityError

イベント

イベントオブジェクトの型: flash.events.SecurityErrorEvent
プロパティ SecurityErrorEvent.type = flash.events.SecurityErrorEvent.SECURITY_ERROR

言語バージョン:

ActionScript 3.0

ランタイムバージョン:

AIR 2.0

セキュリティエラーが原因でファイルをダウンロードできない場合に送出されます。

SecurityErrorEvent.SECURITY_ERROR 定数は、type プロパティ（securityError イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`false`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	セキュリティエラーを報告するネットワークオブジェクトです。
`text`	エラーメッセージとして表示されるテキストです。

法律上の注意 | プライバシーポリシー

URLFilePromise - AS3

パッケージx

言語エレメント

付録

パッケージ air.desktop

isAsync

relativePath

request

URLFilePromise

close

open

reportError

complete

httpResponseStatus

httpStatus

ioError

open

progress

securityError