| パッケージ | mx.rpc.soap |
| クラス | public dynamic class WebService |
| 継承 | WebService  AbstractWebService AbstractService Proxy |
| サブクラス | WebService |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
パブリックプロパティ
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
 | channelSet : ChannelSet
サービスが使用する ChannelSet へのアクセスを提供します。 | AbstractService | |
| convertParametersHandler : Function
フレームワーク開発者には、各 WebService 操作起動で渡すパラメーターを指定して呼び出す関数をインストールする必要がある場合があります。そのような開発者を主な対象としたオプション関数です。 | AbstractWebService | |
| convertResultHandler : Function
フレームワーク開発者には、操作の結果を処理するフックをインストールしてから結果ハンドラーを通知する必要がある場合があります。そのような開発者を主な対象としたオプション関数です。 | AbstractWebService | |
| description : String
現在アクティブなポートに対応するサービスの説明です。 | AbstractWebService | |
| destination : String [オーバーライド]
サービスの宛先です。 | AbstractWebService | |
| endpointURI : String
WebService の場所です。 | AbstractWebService | |
| headers : Array [読み取り専用]
WebService に対して登録された SOAPHeaders の配列を返します。 | AbstractWebService | |
| httpHeaders : Object
SOAP エンドポイントに送信されるカスタム HTTP ヘッダーです。 | AbstractWebService | |
| makeObjectsBindable : Boolean
この値が true の場合、返された匿名オブジェクトは強制的にバインド可能オブジェクトにされます。 | AbstractWebService | |
| managers : Array
マネージャープロパティは、このサービスの動作を修正するデータマネージャーのリストを格納します。 | AbstractService | |
| operations : Object
通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラーによってのみ設定されます。 | AbstractService | |
| port : String
この WebService が使用する必要のある WSDL ドキュメント内のポートを指定します。 | AbstractWebService | |
| ready : Boolean [読み取り専用]
WebService が要求を行う準備ができたかどうかを指定します。 | AbstractWebService | |
| requestTimeout : int
送信メッセージの要求タイムアウト時間（秒単位）に対するアクセスを提供します。 | AbstractService | |
| rootURL : String
相対 URL を計算するときに、WebService が使用する必要のある URL です。 | AbstractWebService | |
| service : String
この WebService が使用する必要のある WSDL ドキュメント内のサービスを指定します。 | AbstractWebService | |
| useProxy : Boolean
Flex のプロキシサービスを利用するかどうかを指定します。 | AbstractWebService | |
| wsdl : String
この WebService の WSDL ドキュメントの場所です。 | WebService | ||
| xmlSpecialCharsFilter : Function
単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。 | AbstractWebService | |
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
新しい WebService を作成します。 | WebService | ||
|
この Web サービスのすべての操作に適用されるヘッダーを追加します。 | AbstractWebService | |
| addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
この WebService のすべての操作に適用されるヘッダーを追加します。 | AbstractWebService | |
WebService が WSDL をロードできる状態であるかどうか (有効な宛先または wsdl が指定されているかどうか) を示すブール値を返します。 | WebService | ||
|
すべての操作に適用されるヘッダーをクリアします。 | AbstractWebService | |
|
サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。 | AbstractService | |
|
QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。 | AbstractWebService | |
[オーバーライド]
指定された名前の Operation を返します。 | WebService | ||
|
サービスを初期化するために呼び出されます。 | AbstractService | |
WebService に WSDL ドキュメントをダウンロードするように指示します。 | WebService | ||
|
ユーザーを宛先からログアウトします。 | AbstractService | |
|
指定された QName を持つヘッダーをすべての操作から削除します。 | AbstractWebService | |
|
サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。 | AbstractService | |
| [オーバーライド]
ユーザーが WebService にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。 | AbstractWebService | |
WebService のインスタンスを、宛先 ID や割り当てられたチャンネルのセットなどの重要なプロパティを記述するストリングとして表します。 | WebService | ||
プロテクトメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
新しい Operation を初期化します。 | WebService | ||
イベント
| イベント | 概要 | 定義元 | ||
|---|---|---|---|---|
| fault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。 | AbstractService | ||
| チャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。 | AbstractService | ||
| LoadEvent.LOAD は、WSDL ドキュメントが正常にロードされると送出されます。 | WebService | |||
| result イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。 | AbstractService | ||
パブリック定数
| 定数 | 定義元 | ||
|---|---|---|---|
| DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [静的] | WebService | ||
| DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [静的] | WebService | ||
プロパティの詳細
wsdl | プロパティ |
コンストラクターの詳細
WebService | () | コンストラクター |
public function WebService(destination:String = null, rootURL:String = null)| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
新しい WebService を作成します。 宛先を指定する場合、その宛先は services-config.xml 内のエントリと一致している必要があります。 宛先を指定しない場合、WebService では DefaultHTTP 宛先が使用されます。 相対 URL を使用してこの WebService の WSDL ドキュメントを検索することを前提としている場合は、rootURL が必要です。
destination:String (default = null) | |
rootURL:String (default = null) |
メソッドの詳細
canLoadWSDL | () | メソッド |
getOperation | () | メソッド |
override public function getOperation(name:String):AbstractOperation| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
指定された名前の Operation を返します。Operation が事前に作成されなかった場合、新しい mx.rpc.soap.Operation がこの呼び出し中に作成されます。 Operation は通常、その名前をサービス変数（myService.someOperation）の後に指定するだけでアクセスすることができますが、Operation 名がサービスに対して定義されているメソッドと一致している場合（例えば setCredentials）、代わりにこのメソッドを使って Operation を取得することができます。
パラメーター
name:String — Operation の名前です。
|
AbstractOperation — この名前に対して実行される Operation です。
|
initializeOperation | () | メソッド |
loadWSDL | () | メソッド |
public function loadWSDL(uri:String = null):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
WebService に WSDL ドキュメントをダウンロードするように指示します。 WebService MXML タグに指定されている場合、WebService はこのメソッドを自動的に呼び出します。ただし、destination または wsdl プロパティの値を指定した後で、ActionScript に WebService オブジェクトを作成する場合は、手動で呼び出す必要があります。
パラメーター
uri:String (default = null) |
toString | () | メソッド |
イベントの詳細
load | イベント |
イベントオブジェクトの型:
プロパティ LoadEvent.type =
mx.rpc.soap.LoadEventプロパティ LoadEvent.type =
mx.rpc.soap.LoadEvent.LOAD| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
LoadEvent.LOAD は、WSDL ドキュメントが正常にロードされると送出されます。
LOAD 定数により type プロパティ値が定義されます。これは load イベントのイベントオブジェクトのプロパティ値です。
イベントオブジェクトの各プロパティには次の値が設定されています。
| プロパティ | 値 |
|---|---|
bubbles | false |
cancelable | true |
wsdl | WSDL オブジェクト |
location | WSDL ドキュメントの URI |
定数の詳細
DEFAULT_DESTINATION_HTTP | 定数 |
public static const DEFAULT_DESTINATION_HTTP:String = "DefaultHTTP"DEFAULT_DESTINATION_HTTPS | 定数 |
public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"Tue Jun 12 2018, 10:34 AM Z