パッケージmx.rpc
public dynamic class AbstractService
継承AbstractService Inheritance Proxy Inheritance Object
ImplementsIEventDispatcher
SubclassesRemoteObject, WebService

AbstractService クラスは、WebService クラスおよび RemoteObject クラスの基本クラスです。このクラスは、リモートプロシージャコールを実際に実行する Operation を作成します。



パブリックプロパティ
 プロパティ定義
  channelSet : ChannelSet
サービスが使用する ChannelSet へのアクセスを提供します。
AbstractService
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  destination : String
サービスの宛先です。
AbstractService
  operations : Object
通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラによってのみ設定されます。
AbstractService
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  requestTimeout : int
送信メッセージの要求タイムアウト時間 (秒単位) に対するアクセスを提供します。
AbstractService
パブリック Methods
 メソッド定義
  
AbstractService(destination:String = null)
AbstractService
  
サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。
AbstractService
  
指定された名前の Operation を返します。
AbstractService
 Inherited
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
ユーザーを宛先からログアウトします。
AbstractService
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
setCredentials(username:String, password:String):void
サービスがアクセスする宛先の証明書を設定します。
AbstractService
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setRemoteCredentials(remoteUsername:String, remotePassword:String):void
プロキシを介した Web サービスやカスタムアダプタを介したリモートオブジェクトなど、リモートのサードパーティエンドポイントにアクセスするユーザーの認証に使用されるユーザー名とパスワードです。
AbstractService
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
Protected Methods
 メソッド定義
 Inherited
callProperty(name:*, ... rest):*
関数として呼び出し可能なオブジェクトプロパティの動作を上書きします。
Proxy
 Inherited
プロパティを削除する要求を上書きします。
Proxy
 Inherited
descendant 演算子の使用をオーバーライドします。
Proxy
 Inherited
getProperty(name:*):*
プロパティの値に対する要求を上書きします。
Proxy
 Inherited
オブジェクトが特定のプロパティを持っているかどうかを名前ごとにチェックする要求を上書きします。
Proxy
 Inherited
指定された QName が属性としてマークされているかどうかを確認します。
Proxy
 Inherited
インデックス番号を使用して、プロキシになるオブジェクトのプロパティを列挙してプロパティ名を取得できます。
Proxy
 Inherited
インデックス番号を使用して、プロキシになるオブジェクトのプロパティを列挙できます。
Proxy
 Inherited
nextValue(index:int):*
インデックス番号を使用して、プロキシになるオブジェクトのプロパティを列挙してプロパティ値を取得できます。
Proxy
 Inherited
setProperty(name:*, value:*):void
プロパティの値を変更する呼び出しを上書きします。
Proxy
イベント
 イベント一覧定義
   fault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
   チャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。AbstractService
   result イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
プロパティの詳細
channelSetプロパティ
channelSet:ChannelSet  [read-write]

サービスが使用する ChannelSet へのアクセスを提供します。ChannelSet は手動で作成して割り当てることができます。また、このサービスの destination に対して設定済みのチャネルを使って、動的に作成することもできます。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void
destinationプロパティ 
destination:String  [read-write]

サービスの宛先です。この値は、services-config.xml ファイル内の宛先エントリと一致している必要があります。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get destination():String
    public function set destination(value:String):void
operationsプロパティ 
operations:Object  [read-write]

通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラによってのみ設定されます。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get operations():Object
    public function set operations(value:Object):void
requestTimeoutプロパティ 
requestTimeout:int  [read-write]

送信メッセージの要求タイムアウト時間 (秒単位) に対するアクセスを提供します。ゼロ以下の値を設定すると、要求はタイムアウトになりません。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get requestTimeout():int
    public function set requestTimeout(value:int):void
コンストラクタの詳細
AbstractService()コンストラクタ
public 関数 AbstractService(destination:String = null)パラメータ
destination:String (default = null)
メソッドの詳細
disconnect()メソッド
public function disconnect():void

サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。このメソッドは、未処理のネットワーク操作が完了するまで待つことはしません。

getOperation()メソッド 
public final function getOperation(name:String):AbstractOperation

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

パラメータ
name:String — Operation の名前です。

戻り値
AbstractOperation — この名前に対して実行される Operation です。
logout()メソッド 
public function logout():void

ユーザーを宛先からログアウトします。宛先のログアウトは、サーバー設定で指定されているものと同じ ChannelSet を使用して接続されているあらゆるものに適用されます。たとえば、my-rtmp チャネル上で接続しており、RPC コンポーネントのいずれかを使用してログアウトすると、同じ ChannelSet 上で接続していたあらゆるユーザーがログアウトされます。

setCredentials()メソッド 
public function setCredentials(username:String, password:String):void

サービスがアクセスする宛先の証明書を設定します。証明書は、同じ ChannelSet 上で接続されているすべてのサービスに適用されます。リモートエンドポイントへのプロキシまたはサードパーティのアダプタを使用するサービスには、代わりに setRemoteCredentials が必要です。

パラメータ
username:String — 宛先のユーザー名です。
 
password:String — 宛先のパスワードです。
setRemoteCredentials()メソッド 
public function setRemoteCredentials(remoteUsername:String, remotePassword:String):void

プロキシを介した Web サービスやカスタムアダプタを介したリモートオブジェクトなど、リモートのサードパーティエンドポイントにアクセスするユーザーの認証に使用されるユーザー名とパスワードです。

パラメータ
remoteUsername:String — リモートエンドポイントに渡すユーザー名です。
 
remotePassword:String — リモートエンドポイントに渡すパスワードです。
イベントの詳細
faultevent 
イベントオブジェクトの型: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

fault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。

FAULT イベントタイプです。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ
bubblesfalse
cancelabletrue。関連付けられたトークンの responder.fault メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
faultこのイベントの原因についての詳細が含まれる Fault オブジェクトです。
messageこのイベントに関連付けられたメッセージ。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
tokenメソッドの呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。
invokeevent  
イベントオブジェクトの型: mx.rpc.events.InvokeEvent
InvokeEvent.type property = mx.rpc.events.InvokeEvent.INVOKE

チャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。

INVOKE イベントタイプです。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ
bubblesfalse
token メソッドの個々の呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。
cancelabletrue
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
message このイベントに関連付けられた要求メッセージ。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
resultevent  
イベントオブジェクトの型: mx.rpc.events.ResultEvent
ResultEvent.type property = mx.rpc.events.ResultEvent.RESULT

result イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。

RESULT イベントタイプです。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ
bubblesfalse
cancelabletrue。関連付けられたトークンの responder.result メソッドから preventDefault() を呼び出すと、サービスまたは処理がこのイベントを送出しなくなります。
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
message このイベントに関連付けられたメッセージ。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
resultRPC 呼び出しが返す結果です。
tokenメソッドの個々の呼び出しを表すトークン。Asynchronous Completion Token パターンで使用されます。