パッケージmx.rpc
クラスpublic dynamic class AbstractService
継承AbstractService Inheritance Proxy Inheritance Object
実装 IEventDispatcher
サブクラス AbstractWebService, HTTPMultiService, RemoteObject

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



パブリックプロパティ
 プロパティ定義元
  channelSet : ChannelSet
サービスが使用する ChannelSet へのアクセスを提供します。
AbstractService
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  destination : String
サービスの宛先です。
AbstractService
  managers : Array
マネージャプロパティは、このサービスの動作を修正するデータマネージャのリストを格納します。
AbstractService
  operations : Object
通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラによってのみ設定されます。
AbstractService
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  requestTimeout : int
送信メッセージの要求タイムアウト時間(秒単位)に対するアクセスを提供します。
AbstractService
パブリックメソッド
 メソッド定義元
  
AbstractService(destination:String = null)
コンストラクタです。
AbstractService
  
サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。
AbstractService
  
指定された名前の Operation を返します。
AbstractService
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  
サービスを初期化するために呼び出されます。
AbstractService
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
ユーザーを宛先からログアウトします。
AbstractService
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
setCredentials(username:String, password:String, charset:String = null):void
サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。
AbstractService
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
サーバー側で Data Services を使用している場合に、リモートのサードパーティエンドポイント(プロキシを介した Web サービスやカスタムアダプタを介したリモートオブジェクトなど)にアクセスするユーザーの認証に使用されるユーザー名とパスワードです。
AbstractService
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
イベント
 イベント 概要 定義元
  fault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
  チャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。AbstractService
  result イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
プロパティの詳細
channelSetプロパティ
channelSet:ChannelSet

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



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

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



実装
    public function get destination():String
    public function set destination(value:String):void
managersプロパティ 
managers:Array

マネージャプロパティは、このサービスの動作を修正するデータマネージャのリストを格納します。このフックを使用して、このサービスと関連付けられた 1 つまたは複数のマネージャコンポーネントを定義できます。このプロパティが設定されているとき、「service」と呼ばれるプロパティがマネージャにある場合、プロパティはこのサービスの値に設定されます。また、このサービスが初期化されるとき、すべてのマネージャコンポーネントで初期化メソッドを呼び出します。



実装
    public function get managers():Array
    public function set managers(value:Array):void
operationsプロパティ 
operations:Object

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



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

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



実装
    public function get requestTimeout():int
    public function set requestTimeout(value:int):void
コンストラクタの詳細
AbstractService()コンストラクタ
public function AbstractService(destination:String = null)

コンストラクタです。

パラメータ
destination:String (default = null) — サービスの宛先です。
メソッドの詳細
disconnect()メソッド
public function disconnect():void

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

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

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

パラメータ

name:String — Operation の名前です。

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

サービスを初期化するために呼び出されます。

logout()メソッド 
public function logout():void

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

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

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

パラメータ

username:String — 宛先のユーザー名です。
 
password:String — 宛先のパスワードです。
 
charset:String (default = null) — 資格情報をエンコードする際に使用する文字セットエンコーディングです。デフォルトは null で、旧式文字セットの ISO-Latin-1 を示します。サポートされているその他の文字セットは "UTF-8" のみです。

setRemoteCredentials()メソッド 
public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void

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

パラメータ

remoteUsername:String — リモートエンドポイントに渡すユーザー名です。
 
remotePassword:String — リモートエンドポイントに渡すパスワードです。
 
charset:String (default = null) — リモート資格情報をエンコードする際に使用する文字セットエンコーディングです。デフォルトは null で、旧式文字セットの ISO-Latin-1 を示します。サポートされているその他の文字セットは "UTF-8" のみです。

イベントの詳細
fault イベント
イベントオブジェクトの型: mx.rpc.events.FaultEvent
プロパティ FaultEvent.type = 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 パターンで使用されます。
invoke イベント  
イベントオブジェクトの型: mx.rpc.events.InvokeEvent
プロパティ InvokeEvent.type = mx.rpc.events.InvokeEvent.INVOKE

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

INVOKE イベントタイプです。

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

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




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/rpc/AbstractService.html