パッケージflash.net
public final class URLRequestHeader
継承URLRequestHeader Inheritance Object

URLRequestHeader オブジェクトは 1 つの HTTP のリクエストヘッダをカプセル化し、名前と値のペアを構成します。 URLRequestHeader オブジェクトは URLRequest クラスの requestHeaders プロパティで使用されます。

次のリクエストヘッダは使用できません。 Accept-Ranges, Age, Allow, Allowed, Connection, Content-Length, Content-Location, Content-Range, ETag, Host, Last-Modified, Location, Max-Forwards, Proxy-Authenticate, Proxy-Authorization, Public, Range, Retry-After, Server, TE, Trailer, Transfer-Encoding, Upgrade, URI, Vary, Via, Warning, WWW-Authenticate, x-flash-version.

URLRequestHeader オブジェクトの長さは制限されています。URLRequestHeader オブジェクトの累積長 (name プロパティの長さに value プロパティの長さを足したもの) または URLRequest.requestHeaders プロパティで使用する URLRequestHeader オブジェクトの配列が許容長を超えると、Adobe® Flash® Player により例外がスローされます。

例の表示

関連項目

URLRequest
URLLoader


パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  name : String
HTTP リクエストヘッダー名 (Content-TypeSOAPAction など) です。
URLRequestHeader
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  value : String
name プロパティに関連付けられた値 (text/plain など) です。
URLRequestHeader
パブリックメソッド
 メソッド定義
  URLRequestHeader(name:String = "", value:String = "")
1 つの HTTP リクエストヘッダをカプセル化する新しい URLRequestHeader オブジェクトを作成します。
URLRequestHeader
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
プロパティの詳細
nameプロパティ
public var name:String

HTTP リクエストヘッダー名 (Content-TypeSOAPAction など) です。

valueプロパティ 
public var value:String

name プロパティに関連付けられた値 (text/plain など) です。

コンストラクタの詳細
URLRequestHeader()コンストラクタ
public 関数 URLRequestHeader(name:String = "", value:String = "")

1 つの HTTP リクエストヘッダをカプセル化する新しい URLRequestHeader オブジェクトを作成します。URLRequestHeader オブジェクトは URLRequest クラスの requestHeaders プロパティで使用されます。

パラメータ
name:String (default = "") — HTTP リクエストヘッダー名 (Content-TypeSOAPAction など) です。
 
value:String (default = "")name プロパティに関連付けられた値 (text/plain など) です。

次の例では、単一の HTTP リクエストヘッダを、 URLRequest オブジェクト内の Array に追加し、その後 XML ファイルからデータをロードして、 イベント情報を表示します。この例のハイライトは、次のとおりです。
  1. コンストラクタ関数は loader という URLLoader インスタンスと request という URLRequest インスタンスを作成します。これはロードされるファイルの場所と名前です。
  2. loader オブジェクトが configureListeners() メソッドに渡され、 サポートされる各 URLLoader イベントにリスナーを追加します。
  3. この例では、 name = pragmavalue = no-cache
  4. というパラメータを使用して URLRequestHeader インスタンスが作成されます。
  5. 次に、HTML リクエストヘッダが requestHeaders 配列の末尾に追加されます。
  6. 次に、request が、XML ファイルをロードする loader.load() メソッドに渡されます。

メモ: この例を実行するには、XMLFile.xml という名前のファイルを SWF ファイルと同じディレクトリに配置します。

package {
    import flash.display.Sprite;
    import flash.events.*;
    import flash.net.URLLoader;
    import flash.net.URLRequest;
    import flash.net.URLRequestHeader;
    import flash.net.URLRequestMethod;
    import flash.net.URLVariables;

    public class URLRequestHeaderExample extends Sprite {
        public function URLRequestHeaderExample() {
            var loader:URLLoader = new URLLoader();
            configureListeners(loader);

            var header:URLRequestHeader = new URLRequestHeader("pragma", "no-cache");
            var request:URLRequest = new URLRequest("http://www.[yourdomain].com/greeting.cfm");
            request.data = new URLVariables("name=John+Doe");
            request.method = URLRequestMethod.POST;
            request.requestHeaders.push(header);
            try {
                loader.load(request);
            } catch (error:Error) {
                trace("Unable to load requested document.");
            }
        }

        private function configureListeners(dispatcher:IEventDispatcher):void {
            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
            dispatcher.addEventListener(Event.OPEN, openHandler);
            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
        }

        private function completeHandler(event:Event):void {
            var loader:URLLoader = URLLoader(event.target);
            trace("completeHandler: " + loader.data);
        }

        private function openHandler(event:Event):void {
            trace("openHandler: " + event);
        }

        private function progressHandler(event:ProgressEvent):void {
            trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
        }

        private function securityErrorHandler(event:SecurityErrorEvent):void {
            trace("securityErrorHandler: " + event);
        }

        private function httpStatusHandler(event:HTTPStatusEvent):void {
            trace("httpStatusHandler: " + event);
        }

        private function ioErrorHandler(event:IOErrorEvent):void {
            trace("ioErrorHandler: " + event);
        }
    }
}