WebService

パッケージ	mx.rpc.soap.mxml
クラス	public dynamic class WebService
継承	WebService WebService AbstractWebService AbstractService Proxy
実装	IMXMLSupport, IMXMLObject

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

<mx:WebService> タグにより、SOAP に準拠した Web サービスの処理にアクセスできます。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:WebService> tag accepts the following tag attributes:

 <mx:WebService
   Properties
   concurrency="multiple|single|last"
   destination="No default."
   id="No default."
   serviceName="No default."
   showBusyCursor="false|true"
   makeObjectsBindable="false|true"
   useProxy="false|true"
   wsdl="No default."
 
   Events
   fault="No default."
   result="No default."
 />

An <mx:WebService> tag can have multiple <mx:operation> tags, which have the following tag attributes:

 <mx:operation
   Properties
   concurrency="multiple|single|last"
   name=No default, required.
   resultFormat="object|xml|e4x"
   makeObjectsBindable="false|true"
 
   
   Events
   fault=No default.
   result=No default.
 />

An <mx:Operation> tag contains an <mx:request> tag. To specify an XML structure in an <mx:request> tag, you must set the value of the tag's format attribute to "xml". Otherwise, the body is converted into Objects.

例を表示

パブリックプロパティ

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

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

	プロパティ		定義元
		channelSet : ChannelSet サービスが使用する ChannelSet へのアクセスを提供します。	AbstractService
		concurrency : String 同一サービスに対する複数の呼び出しの処理方法を示す値です。	WebService
		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
		protocol : String 非推奨: 推奨 channelSet [書き込み専用] 非推奨。代わりに適切な宛先を使用するか、url を使用する場合は、DefaultHTTP または DefaultHTTPS を使用します。	WebService
		ready : Boolean [読み取り専用] WebService が要求を行う準備ができたかどうかを指定します。	AbstractWebService
		requestTimeout : int 送信メッセージの要求タイムアウト時間（秒単位）に対するアクセスを提供します。	AbstractService
		rootURL : String 相対 URL を計算するときに、WebService が使用する必要のある URL です。	AbstractWebService
		service : String この WebService が使用する必要のある WSDL ドキュメント内のサービスを指定します。	AbstractWebService
		serviceName : String 非推奨: 推奨 destination	WebService
		showBusyCursor : Boolean true の場合、サービスの実行中にビジーカーソルが表示されます。	WebService
		useProxy : Boolean Flex のプロキシサービスを利用するかどうかを指定します。	AbstractWebService
		wsdl : String この WebService の WSDL ドキュメントの場所です。	WebService
		xmlSpecialCharsFilter : Function 単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。	AbstractWebService

パブリックメソッド

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

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

	メソッド		定義元
		WebService(destination:String = null) 新しい WebService コンポーネントを作成します。	WebService
		addHeader(header:Object):void この Web サービスのすべての操作に適用されるヘッダーを追加します。	AbstractWebService
		addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void この WebService のすべての操作に適用されるヘッダーを追加します。	AbstractWebService
		canLoadWSDL():Boolean WebService が WSDL をロードできる状態であるかどうか (有効な宛先または wsdl が指定されているかどうか) を示すブール値を返します。	WebService
		clearHeaders():void すべての操作に適用されるヘッダーをクリアします。	AbstractWebService
		disconnect():void サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。	AbstractService
		getHeader(qname:QName, headerName:String = null):SOAPHeader QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。	AbstractWebService
		getOperation(name:String):AbstractOperation [オーバーライド] 指定された名前の Operation を返します。	WebService
		initialize():void サービスを初期化するために呼び出されます。	AbstractService
		initialized(document:Object, id:String):void WebService がタグを使用して設定されている場合、MXML コンパイラーによって自動的に呼び出されます。	WebService
		loadWSDL(uri:String = null):void WebService に WSDL ドキュメントをダウンロードするように指示します。	WebService
		logout():void ユーザーを宛先からログアウトします。	AbstractService
		removeHeader(qname:QName, headerName:String = null):void 指定された QName を持つヘッダーをすべての操作から削除します。	AbstractWebService
		setCredentials(username:String, password:String, charset:String = null):void サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。	AbstractService
		setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void [オーバーライド] ユーザーが WebService にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。	AbstractWebService
		toString():String WebService のインスタンスを、宛先 ID や割り当てられたチャンネルのセットなどの重要なプロパティを記述するストリングとして表します。	WebService

プロテクトメソッド

継承されるプロテクトメソッドを隠す

継承されるプロテクトメソッドを表示

	メソッド		定義元
		initializeOperation(operation:Operation):void 新しい Operation を初期化します。	WebService

イベント

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

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

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

	概要	定義元
fault	fault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。	AbstractService
invoke	チャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。	AbstractService
load	LoadEvent.LOAD は、WSDL ドキュメントが正常にロードされると送出されます。	WebService
result	result イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。	AbstractService

パブリック定数

継承されるパブリック定数を隠す

継承されるパブリック定数を表示

	定数		定義元

プロパティの詳細

concurrency

プロパティ

concurrency:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

同一サービスに対する複数の呼び出しの処理方法を示す値です。デフォルト値は multiple です。使用できる値は次のとおりです。

multiple：既存の要求はキャンセルされません。返されるデータは開発者が責任を持って、イベントストリームを慎重に管理することで整合性を確保する必要があります。これはデフォルトの設定です。
single：メソッドでは一度に 1 つの要求しか作成できません。要求が未解決の間にさらに要求を作成すると、それらの要求はクライアントでただちにフォルトになり、サーバーに送信されません。
last：要求を作成すると、クライアントが現在の未処理の要求に関する結果またはフォルトを無視することになります。最も新しい要求についての結果またはフォルトのみがクライアントで送出されます。これによってクライアントアプリケーションでのイベント処理が簡単になる可能性があります。しかし、要求の結果またはフォルトを無視しても安全なときにのみこのモードを使用するよう注意してください。

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

protocol

プロパティ

protocol:String [書き込み専用]

非推奨: 推奨 channelSet

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

非推奨。代わりに適切な宛先を使用するか、url を使用する場合は、DefaultHTTP または DefaultHTTPS を使用します。推奨されない動作では、デフォルトが使用されている場合に単に宛先が更新されます。

実装
public function set protocol(value:String):void

serviceName

プロパティ

serviceName:String

非推奨: 推奨 destination

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

showBusyCursor

プロパティ

showBusyCursor:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

true の場合、サービスの実行中にビジーカーソルが表示されます。デフォルト値は false です。

実装
public function get showBusyCursor():Boolean
public function set showBusyCursor(value:Boolean):void

コンストラクターの詳細

()

コンストラクター

public function WebService(destination:String = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

新しい WebService コンポーネントを作成します。

パラメーター

destination:String (default = null) — WebService の宛先。services-config.xml ファイル内の宛先名と一致する必要があります。宛先を指定しない場合、WebService コンポーネントでは DefaultHTTP 宛先が使用されます。

メソッドの詳細

getOperation

()

メソッド

override public function getOperation(name:String):AbstractOperation

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定された名前の Operation を返します。Operation が事前に作成されなかった場合、新しい mx.rpc.soap.mxml.Operation がこの呼び出し中に作成されます。 Operation は通常、その名前をサービス変数（myService.someOperation）の後に指定するだけでアクセスすることができますが、Operation 名がサービスに対して定義されているメソッドと一致している場合（例えば setCredentials）、代わりにこのメソッドを使って Operation を取得することができます。

パラメーター

name:String — Operation の名前です。

戻り値

AbstractOperation — この名前に対して実行される Operation です。

initialized

()

メソッド

public function initialized(document:Object, id:String):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

WebService がタグを使用して設定されている場合、MXML コンパイラーによって自動的に呼び出されます。 ActionScript によって WebService を作成する場合、このメソッドはすべてのパラメーターを検証する際に役立つため、このメソッドを呼び出すことをお勧めします。

パラメーター

	`document:Object` — この WebService が存在する MXML ドキュメントです。

	`id:String` — ドキュメント内部でのこの WebService の ID です。

例この例の使用方法

WebServiceExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the WebService tag. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" 
     xmlns:s="library://ns.adobe.com/flex/spark" 
     xmlns:mx="library://ns.adobe.com/flex/mx">

    <!--  Make sure the Flex Data Services proxy-config.xml file contains 
          the following definition: 

        <destination id="DefaultHTTP">
            <properties>
                <dynamic-url>http://ws.invesbot.com</dynamic-url>
            </properties>
        </destination>
    -->

    <fx:Script>
        <![CDATA[
            import mx.controls.Alert;        
        ]]>    
    </fx:Script>

    <fx:Declarations>
        <mx:WebService id="WS" wsdl="http://ws.invesbot.com/stockquotes.asmx?WSDL"
            useProxy="true"
            fault="Alert.show(event.fault.faultString), 'Error'">
            <mx:operation name="GetQuote" resultFormat="object">
                <mx:request>
                    <symbol>{stockSymbol.text}</symbol>
                </mx:request>
            </mx:operation>
        </mx:WebService>
    </fx:Declarations>

    <mx:Panel title="WebService Example" height="75%" width="75%" 
        paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">
    
        <mx:Label width="100%"  color="blue"
            text="Enter a stock symbol to obtain a quote."/>
    
        <mx:TextInput id="stockSymbol" text="ADBE"/>
        <mx:Button label="Get Quote" click="WS.GetQuote.send()"/>
    
        <mx:Text htmlText="Company: {WS.GetQuote.lastResult.GetQuoteResult.StockQuote.Company}"/>
        <mx:Text htmlText="Current price: ${WS.GetQuote.lastResult.GetQuoteResult.StockQuote.Price}"/>
    </mx:Panel>    
</s:Application>

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

WebService - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.rpc.soap.mxml

concurrency

protocol

serviceName

showBusyCursor

WebService

getOperation

initialized