Placement
Vue d'ensembleLien direct vers Vue d'ensemble
Objet représentant un placement Rokt chargé sur une page. Fournit des fonctionnalités pour interagir avec le placement sur une page.
MéthodesLien direct vers Méthodes
closeLien direct vers close
▸ close(): Promise<void>
Ferme et supprime le placement de la page.
Retourne : Promise<void>
onLien direct vers on
▸ on<T>(event: string): Subscriber<PlacementEvent<T>>
Permet de s'abonner à des événements avec un nom spécifique provenant d'un placement.
Paramètres :
| Nom | Type | Description |
|---|---|---|
event | string | Nom de l'événement auquel s'abonner |
Retourne : Subscriber<T>
readyLien direct vers ready
▸ ready(): Promise<T>
Permet d'attendre qu'un emplacement soit prêt. La disponibilité est définie comme suit :
- l'emplacement a été chargé avec succès
- l'emplacement est prêt à recevoir des événements envoyés à l'aide de la méthode send.
Si, pour une raison quelconque, un emplacement ne parvient pas à se charger, la promesse sera rejetée avec une erreur.
Renvoie : Promise<void>
sendLien direct vers send
▸ send<T>(name: string, data?: T): Promise<void>
Envoie un événement à l'emplacement. La promesse retournée sera résolue une fois que l'emplacement aura traité le message.
Paramètres :
| Nom | Type | Description |
|---|---|---|
name | string | Nom de l'événement |
data | T | Charge utile optionnelle pour un événement donné |
Renvoie : Promise<void>