URLUtil - Adobe ActionScript® 3（AS3 Flex）API リファレンス

パッケージ	mx.utils
クラス	public class URLUtil
継承	URLUtil Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

URLUtil クラスは、Flex で完全な URL や相対 URL を使用するためのメソッドを含む静的クラスです。

さらに例を参照

Accessing information about the current URL

関連する API エレメント

mx.managers.BrowserManager

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object

パブリックメソッド

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

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

	メソッド		定義元
		getFullURL(rootURL:String, url:String):String [静的] 不完全な相対 URL を完全修飾された URL に変換します。	URLUtil
		getPort(url:String):uint [静的] 指定された URL からポート番号を返します。	URLUtil
		getProtocol(url:String):String [静的] 指定された URL のプロトコルセクションを返します。	URLUtil
		getServerName(url:String):String [静的] 指定された URL からサーバー名を返します。	URLUtil
		getServerNameWithPort(url:String):String [静的] 指定された URL からドメインおよびポート情報を返します。	URLUtil
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		hasTokens(url:String):Boolean [静的] URL を指定して、その URL に server.name トークンと server.port トークンが含まれているかどうかを判定します。	URLUtil
		hasUnresolvableTokens():Boolean [静的] LoaderConfig.url プロパティが使用できない場合、replaceTokens() メソッドでは、サーバー名プロパティとポートプロパティは適切に置き換えられません。	URLUtil
		isHttpsURL(url:String):Boolean [静的] URL でセキュアな HTTPS プロトコルが使用されているかどうかを判定します。	URLUtil
		isHttpURL(url:String):Boolean [静的] URL で HTTP、HTTPS、RTMP のいずれかのプロトコルが使用されているかどうかを判定します。	URLUtil
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		objectToString(object:Object, separator:String = "", encodeURL:Boolean):String [静的] オブジェクトの動的プロパティを（for..in ループを使用して）列挙し、ストリングを返します。	URLUtil
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		replacePort(uri:String, newPort:uint):String [静的] 指定されたポートでポートが置き換えられた新しいストリングを返します。	URLUtil
		replaceProtocol(uri:String, newProtocol:String):String [静的] 指定された URI のプロトコルを特定のプロトコルで置き換えます。	URLUtil
		replaceTokens(url:String):String [静的] ポートとサーバーのトークンを、現在実行しているアプリケーションのポートとサーバーで置き換えた新しいストリングを返します。	URLUtil
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		stringToObject(string:String, separator:String = "", decodeURL:Boolean):Object [静的] ストリングからオブジェクトを返します。	URLUtil
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		urisEqual(uri1:String, uri2:String):Boolean [静的] 2 つの URI ストリングが等しいかどうかをテストします。大文字と小文字の違い、および後続のスラッシュの違いは無視されます。	URLUtil
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object

パブリック定数

	定数		定義元
		SERVER_NAME_TOKEN : String = "{server.name}" [静的] アプリケーションのサーバー名で置き換えられる、replaceTokens() メソッドに渡されたストリング内のパターンです。	URLUtil
		SERVER_PORT_TOKEN : String = "{server.port}" [静的] アプリケーションのポートで置き換えられる、replaceTokens() メソッドに渡されたストリング内のパターンです。	URLUtil

メソッドの詳細

getFullURL

()

メソッド

public static function getFullURL(rootURL:String, url:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

不完全な相対 URL を完全修飾された URL に変換します。URL が相対 URL ではない場合は、URL がそのまま返されます。URL がスラッシュで始まる場合、その前にルート URL からのホストとポートが付加されます。それ以外の場合は、前にホスト、ポート、およびパスが付加されます。

パラメーター

	`rootURL:String` — `url` パラメーターで指定された URL の解決に使用される URL です（`url` が相対 URL の場合）。

	`url:String` — 変換する URL です。

戻り値

String — 完全修飾された URL です。

getPort

()

メソッド

public static function getPort(url:String):uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された URL からポート番号を返します。

パラメーター

url:String — 解析する URL です。

戻り値

uint — 指定された URL のポート番号です。

getProtocol

()

メソッド

public static function getProtocol(url:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された URL のプロトコルセクションを返します。次の例は、各種 URL に対してどのような結果が返されるかを示しています。

          getProtocol("https://localhost:2700/") returns "https"
          getProtocol("rtmp://www.myCompany.com/myMainDirectory/groupChatApp/HelpDesk") returns "rtmp"
          getProtocol("rtmpt:/sharedWhiteboardApp/June2002") returns "rtmpt"
          getProtocol("rtmp::1234/chatApp/room_name") returns "rtmp"

パラメーター

url:String — 解析する URL を含むストリングです。

戻り値

String — プロトコルです。プロトコルが指定されていない場合は、空のストリングになります。

getServerName

()

メソッド

public static function getServerName(url:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された URL からサーバー名を返します。

パラメーター

url:String — 解析する URL です。

戻り値

String — 指定された URL のサーバー名です。

getServerNameWithPort

()

メソッド

public static function getServerNameWithPort(url:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された URL からドメインおよびポート情報を返します。

パラメーター

url:String — 解析する URL です。

戻り値

String — 指定された URL のサーバー名とポートです。

hasTokens

()

メソッド

public static function hasTokens(url:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

URL を指定して、その URL に server.name トークンと server.port トークンが含まれているかどうかを判定します。

パラメーター

url:String — url ストリングです。

戻り値

Boolean — URL に server.name トークンと server.port トークンが含まれている場合は true です。

hasUnresolvableTokens

()

メソッド

public static function hasUnresolvableTokens():Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

LoaderConfig.url プロパティが使用できない場合、replaceTokens() メソッドでは、サーバー名プロパティとポートプロパティは適切に置き換えられません。

戻り値

Boolean — true が返されるのは、LoaderConfig.url プロパティが使用できない場合です。それ以外の場合は false です。

isHttpsURL

()

メソッド

public static function isHttpsURL(url:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

URL でセキュアな HTTPS プロトコルが使用されているかどうかを判定します。

パラメーター

url:String — 解析する URL です。

戻り値

Boolean — URL が "https://" で始まる場合は true です。

isHttpURL

()

メソッド

public static function isHttpURL(url:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

URL で HTTP、HTTPS、RTMP のいずれかのプロトコルが使用されているかどうかを判定します。

パラメーター

url:String — 解析する URL です。

戻り値

Boolean — URL が "http://"、"https://"、"rtmp://" のいずれかで始まる場合は true です。

objectToString

()

メソッド

public static function objectToString(object:Object, separator:String = "", encodeURL:Boolean):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

オブジェクトの動的プロパティを（for..in ループを使用して）列挙し、ストリングを返します。通常は、このメソッドを使用して ActionScript オブジェクトをストリングに変換し、そのストリングを URL の末尾に付加します。デフォルトでは、無効な URL 文字は URL エンコードされます（%XX 形式に変換されます）。

次に実際の使用例を示します。

          var o:Object = { name: "Alex", age: 21 };
          var s:String = URLUtil.objectToString(o,";",true);
          trace(s);

"name=Alex;age=21" をトレースログに出力します。

パラメーター

	`object:Object` — ストリングに変換するオブジェクトです。

	`separator:String` (default = "") — ストリングに含まれるオブジェクトの各 `property:value` ペアを区切る文字です。

	`encodeURL:Boolean` — ストリングを URL エンコードするかどうかを指定します。

戻り値

String — メソッドに渡されたオブジェクトです。

replacePort

()

メソッド

public static function replacePort(uri:String, newPort:uint):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたポートでポートが置き換えられた新しいストリングを返します。指定された URI にポートがない場合は、ポートが挿入されます。このメソッドは、URI 内でプロトコルが指定されていることを前提とします。

パラメーター

	`uri:String` — ポートを置き換える URI を含むストリングです。

	`newPort:uint` — 置き換えに使用する新しいポートを含む uint です。

戻り値

String — 新しいポートを含む URI です。

replaceProtocol

()

メソッド

public static function replaceProtocol(uri:String, newProtocol:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された URI のプロトコルを特定のプロトコルで置き換えます。

パラメーター

	`uri:String` — プロトコルを置き換える URI を含むストリングです。

	`newProtocol:String` — 使用する新しいプロトコルを含むストリングです。

戻り値

String — プロトコルが置き換えられた URI を含むストリングです。URI にプロトコルが含まれていない場合は、空のストリングになります。

replaceTokens

()

メソッド

public static function replaceTokens(url:String):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ポートとサーバーのトークンを、現在実行しているアプリケーションのポートとサーバーで置き換えた新しいストリングを返します。

パラメーター

url:String — アプリケーションのポートとサーバーで置き換える、SERVER_NAME_TOKEN および SERVER_NAME_PORT、またはそのどちらかを含むストリングです。

戻り値

String — ポートとサーバーが置き換えられた URI です。

stringToObject

()

メソッド

public static function stringToObject(string:String, separator:String = "", decodeURL:Boolean):Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ストリングからオブジェクトを返します。name=value ペアを含むストリングです。これらのペアが、返されるオブジェクトの動的プロパティになります。これらのプロパティのペアは、指定された separator で区切られています。このメソッドは、Number と Boolean、Array（"[]" で定義）およびサブオブジェクト（"{}" で定義）を変換します。デフォルトでは、%XX 形式の URL パターンは適切なストリング文字に変換されます。

次に実際の使用例を示します。

          var s:String = "name=Alex;age=21";
          var o:Object = URLUtil.stringToObject(s, ";", true);

オブジェクト：{ name: "Alex", age: 21 } を返します。

パラメーター

	`string:String` — オブジェクトに変換するストリングです。

	`separator:String` (default = "") — ストリング内の `name=value` ペアを区切る文字です。

	`decodeURL:Boolean` — ストリング内の URL エンコードされた文字をデコードするかどうかを指定します。

戻り値

Object — このメソッドに渡されたストリングから抽出されたプロパティと値を含むオブジェクトです。

urisEqual

()

メソッド

public static function urisEqual(uri1:String, uri2:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

2 つの URI ストリングが等しいかどうかをテストします。大文字と小文字の違い、および後続のスラッシュの違いは無視されます。

パラメーター

	`uri1:String` — 比較する最初の URI です。

	`uri2:String` — 比較する 2 番目の URI です。

戻り値

Boolean — URI が等しい場合は true です。それ以外の場合は false です。

定数の詳細

SERVER_NAME_TOKEN

定数

public static const SERVER_NAME_TOKEN:String = "{server.name}"

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アプリケーションのサーバー名で置き換えられる、replaceTokens() メソッドに渡されたストリング内のパターンです。

SERVER_PORT_TOKEN

定数

public static const SERVER_PORT_TOKEN:String = "{server.port}"

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アプリケーションのポートで置き換えられる、replaceTokens() メソッドに渡されたストリング内のパターンです。

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

URLUtil - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.utils

getFullURL

getPort

getProtocol

getServerName

getServerNameWithPort

hasTokens

hasUnresolvableTokens

isHttpsURL

isHttpURL

objectToString

replacePort

replaceProtocol

replaceTokens

stringToObject

urisEqual

SERVER_NAME_TOKEN

SERVER_PORT_TOKEN