XDMChannel class
複数の funtion\method 呼び出し間でフレーム\ドキュメントが "アクティブ" のままになる間の通信チャネルを表します
コンストラクター
| XDMChannel(Window, string) |
メソッド
| error(IJson |
|
| get |
この特定のチャネルからのメッセージを処理するオブジェクト レジストリを取得します。 メッセージを受信すると、このチャネル レジストリが最初に使用され、ここでハンドラーが見つからない場合はグローバル レジストリが使用されます。 |
| get |
このチャネルのリモート側で、指定されたインスタンス ID に登録されているオブジェクトを表すプロキシ オブジェクトを取得します。 |
| invoke |
RPC を使用してメソッドを呼び出します。 チャネルのリモート側で登録済みオブジェクトを検索し、指定したメソッドを呼び出します。 |
| on |
このチャネルで受信したメッセージを処理します。 オブジェクト レジストリを介して見つかった適切なオブジェクトへのディスパッチ |
| owns(Window, string, IJson |
コンストラクターの詳細
XDMChannel(Window, string)
new XDMChannel(postToWindow: Window, targetOrigin?: string)パラメーター
- postToWindow
-
Window
- targetOrigin
-
string
メソッドの詳細
error(IJsonRpcMessage, Error)
function error(messageObj: IJsonRpcMessage, errorObj: Error)パラメーター
- messageObj
- IJsonRpcMessage
- errorObj
-
Error
getObjectRegistry()
この特定のチャネルからのメッセージを処理するオブジェクト レジストリを取得します。 メッセージを受信すると、このチャネル レジストリが最初に使用され、ここでハンドラーが見つからない場合はグローバル レジストリが使用されます。
function getObjectRegistry(): IXDMObjectRegistry戻り値
getRemoteObjectProxy<T>(string, Object)
このチャネルのリモート側で、指定されたインスタンス ID に登録されているオブジェクトを表すプロキシ オブジェクトを取得します。
function getRemoteObjectProxy<T>(instanceId: string, contextData?: Object): Promise<T>パラメーター
- instanceId
-
string
登録済みオブジェクトの一意の ID
- contextData
-
Object
登録済みオブジェクトのファクトリ メソッドに渡す省略可能なコンテキスト データ
戻り値
Promise<T>
invokeRemoteMethod<T>(string, string, any[], Object, ISerializationSettings)
RPC を使用してメソッドを呼び出します。 チャネルのリモート側で登録済みオブジェクトを検索し、指定したメソッドを呼び出します。
function invokeRemoteMethod<T>(methodName: string, instanceId: string, params?: any[], instanceContextData?: Object, serializationSettings?: ISerializationSettings): Promise<T>パラメーター
- methodName
-
string
- instanceId
-
string
登録済みオブジェクトの一意の ID
- params
-
any[]
呼び出すメソッドの引数
- instanceContextData
-
Object
登録済みオブジェクトのファクトリ メソッドに渡す省略可能なコンテキスト データ
- serializationSettings
- ISerializationSettings
オプションのシリアル化設定
戻り値
Promise<T>
onMessage(IJsonRpcMessage)
このチャネルで受信したメッセージを処理します。 オブジェクト レジストリを介して見つかった適切なオブジェクトへのディスパッチ
function onMessage(rpcMessage: IJsonRpcMessage): booleanパラメーター
- rpcMessage
- IJsonRpcMessage
メッセージ データ
戻り値
boolean
True の 場合は、メッセージがこのチャネルによって処理されました。 それ以外の場合は false。
owns(Window, string, IJsonRpcMessage)
function owns(source: Window, origin: string, rpcMessage: IJsonRpcMessage): booleanパラメーター
- source
-
Window
- origin
-
string
- rpcMessage
- IJsonRpcMessage
戻り値
boolean