AbstractService

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パブリックプロパティ

	プロパティ		定義元
		channelSet : ChannelSet サービスが使用する ChannelSet へのアクセスを提供します。	AbstractService
		destination : String サービスの宛先です。	AbstractService
		managers : Array マネージャープロパティは、このサービスの動作を修正するデータマネージャーのリストを格納します。	AbstractService
		operations : Object 通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラーによってのみ設定されます。	AbstractService
		requestTimeout : int 送信メッセージの要求タイムアウト時間（秒単位）に対するアクセスを提供します。	AbstractService

パブリックメソッド

	メソッド		定義元
		AbstractService(destination:String = null) コンストラクターです。	AbstractService
		disconnect():void サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。	AbstractService
		getOperation(name:String):AbstractOperation 指定された名前の Operation を返します。	AbstractService
		initialize():void サービスを初期化するために呼び出されます。	AbstractService
		logout():void ユーザーを宛先からログアウトします。	AbstractService
		setCredentials(username:String, password:String, charset:String = null):void サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。	AbstractService
		setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void サーバー側で Data Services を使用している場合に、リモートのサードパーティーエンドポイント（プロキシを介した Web サービスやカスタムアダプターを介したリモートオブジェクトなど）にアクセスするユーザーの認証に使用されるユーザー名とパスワードです。	AbstractService

イベント

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

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

プロパティの詳細

channelSet

プロパティ

channelSet:ChannelSet

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get channelSet():ChannelSet
public function set channelSet(value:ChannelSet):void

destination

プロパティ

destination:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

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

managers

プロパティ

managers:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get managers():Array
public function set managers(value:Array):void

operations

プロパティ

operations:Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get operations():Object
public function set operations(value:Object):void

requestTimeout

プロパティ

requestTimeout:int

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

実装
public function get requestTimeout():int
public function set requestTimeout(value:int):void

コンストラクターの詳細

()

コンストラクター

public function AbstractService(destination:String = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

destination:String (default = null) — サービスの宛先です。

メソッドの詳細

disconnect

()

メソッド

public function disconnect():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

getOperation

()

メソッド

public function getOperation(name:String):AbstractOperation

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

name:String — Operation の名前です。

戻り値

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

initialize

()

メソッド

public function initialize():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

logout

()

メソッド

public function logout():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

メモ：このメソッドではなく mx.messaging.ChannelSet.logout() メソッドを使用することをお勧めします。

setCredentials

()

メソッド

public function setCredentials(username:String, password:String, charset:String = null):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

サーバー側で 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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

サーバー側で 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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

FAULT イベントタイプです。

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

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

invoke

イベント

イベントオブジェクトの型: mx.rpc.events.InvokeEvent
プロパティ InvokeEvent.type = mx.rpc.events.InvokeEvent.INVOKE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

INVOKE イベントタイプです。

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

プロパティ	値
`bubbles`	false
`token`	メソッドの個々の呼び出しを表すトークン。 Asynchronous Completion Token パターンで使用されます。
`cancelable`	true
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`message`	このイベントに関連付けられた要求メッセージです。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。

result

イベント

イベントオブジェクトの型: mx.rpc.events.ResultEvent
プロパティ ResultEvent.type = mx.rpc.events.ResultEvent.RESULT

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

RESULT イベントタイプです。

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

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

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

AbstractService - AS3 Flex

クラス x

channelSet

destination

managers

operations

requestTimeout