Placement
Aperçu
Objet représentant un emplacement Rokt chargé sur une page. Fournit des fonctionnalités pour interagir avec l'emplacement sur une page.
Méthodes
close
▸ close(): Promise<void>
Ferme et supprime l'emplacement de la page.
Renvoie: Promise<void>
on
▸ on<T>(event: string): Subscriber<PlacementEvent<T>>
Permet de s'abonner aux événements portant un nom spécifique provenant d'un emplacement.
Paramètres:
| Nom | Type | Description |
|---|---|---|
event | string | Nom de l'événement auquel s'abonner |
Renvoie: Subscriber<T>
ready
▸ ready(): Promise<T>
Permet d'attendre qu'un emplacement soit prêt. La préparation 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.
Retourne: Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
Envoie un événement à l'emplacement. La promesse renvoyé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 facultative pour un événement donné |
Retourne: _Promise<void>