配置

概要

ページ上に読み込まれたRokt配置を表すオブジェクト。ページ上の配置と対話するための機能を提供します。

メソッド

close

▸ close(): Promise<void>

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

戻り値: Promise<void>

---

on

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

特定の名前を持つイベントに配置からサブスクライブできるようにします。

パラメーター:

名前	型	説明
event	string	サブスクライブするイベントの名前

戻り値: Subscriber<T>

---

ready

▸ ready(): Promise<T>

プレースメントが準備完了になるのを待つことができます。準備完了の定義は以下の通りです:

• プレースメントが正常にロードされている
• send メソッドを使用して送信されたイベントを受け取る準備ができている

何らかの理由でプレースメントのロードに失敗した場合、Promiseはエラーで拒否されます。

戻り値: Promise<void>

---

send

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

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

パラメータ:

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

戻り値: Promise<void>