選択
概要
IntegrationLauncher.selectPlacementsの結果として利用可能なRoktの選択を表すオブジェクトです。
メソッド
close
▸ close(): Promise<void>
選択されたすべての配置を閉じます。Roktの選択プロセスがまだ進行中であるかどうかによって、メソッドは以下のいずれかを行います：
- ページにすでに追加されている配置を削除する
- 最初から配置を追加しないようにする
戻り値: Promise<void>
getPlacements
▸ getPlacements(): Promise<Array<Placement>>
選択されたプレースメントをすべて取得します。このメソッドは、Roktの選択プロセスがページに表示するためのプレースメントが利用可能であると結論付けた時点で返されますが、プレースメントがページにロードされる前です。
ページに利用可能なプレースメントがない場合、メソッドは空の配列で解決されます。選択プロセスが何らかの理由で失敗した場合、メソッドはエラーでプロミスを拒否します。
戻り値: Promise<void>
on
▸ on<T>(event: string): Subscriber<SelectionEvent<T>>
任意の選択範囲から特定の名前のイベントに購読することを可能にします。このメソッドは、実質的には各配置に対して呼び出されるPlacement.onに購読しています。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
event | string | 購読するイベントの名前 |
戻り値: Subscriber<T>
ready
▸ ready(): Promise<T>
各配置が準備完了になるのを待つことができます。選択された各配置のreadyが解決するのを待つのとほぼ同じです。
選択された配置のいずれかが何らかの理由で読み込まれない場合、エラーでPromiseが拒否されます。
戻り値: Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
各配置にイベントを送信することができます。選択された各配置に対してPlacement.sendを呼び出すのとほぼ同じです。
返されるPromiseは、すべての配置がメッセージを処理するまで解決されます。
パラメータ:
| 名前 | タイプ | 説明 |
|---|---|---|
name | string | イベントの名前 |
data | T | 指定されたイベントの予想ペイロード |
戻り値: Promise<void>
setAttributes
▸ setAttributes(): Promise<void>
選択肢に追加の属性を設定することを許可します。
関連性の目的のために、すべての属性は選択肢を作成する際に送信する必要があります。このメソッドは、2段階のデータ統合で最初に選択肢と一緒に送信されたハッシュ化された属性がある場合、ハッシュ化されていない値を開示することを許可します。
戻り値: Promise<void>
プロパティ
context
• context : SelectionContext
Roktによって行われた選択の文脈。