配置

概要

ページにロードされたRoktの配置を表すオブジェクト。ページ上の配置との対話機能を提供します。

▸ close(): Promise<void>

配置を閉じてページから削除します。

戻り値: Promise<void>

▸ on<T>(event: string): Subscriber<PlacementEvent<T>>

特定の名前のイベントに対して配置からの購読を許可します。

パラメータ:

名前	タイプ	説明
`event`	string	購読するイベントの名前

戻り値: Subscriber<T>

▸ ready(): Promise<T>

配置が準備完了になるまで待機することができます。準備完了の条件は以下の通りです：

配置のロードに何らかの理由で失敗した場合、エラーが発生し、Promise が拒否されます。

戻り値: Promise<void>

▸ send<T>(name: string, data?: T): Promise<void>

イベントを配置に送信します。返される Promise は、配置がメッセージを処理すると解決されます。

パラメータ:

名前	型	説明
`name`	string	イベントの名前
`data`	T	指定されたイベントのオプションのデータ

戻り値: Promise<void>