Sélection
Aperçu
Objet représentant une sélection Rokt disponible à la suite de IntegrationLauncher.selectPlacements.
Méthodes
close
▸ close(): Promise<void>
Ferme tous les emplacements dans la sélection. Selon si le processus de sélection de Rokt est toujours en cours, la méthode soit :
- supprime les emplacements déjà ajoutés sur une page
- empêche les emplacements d'être ajoutés en premier lieu
Retourne : Promise<void>
getPlacements
▸ getPlacements(): Promise<Array<Placement>>
Obtient tous les emplacements retournés pour la sélection. La méthode retourne dès que le processus de sélection de Rokt a conclu qu'il y a des emplacements disponibles à afficher sur une page, mais avant que les emplacements ne soient chargés sur la page.
Dans le cas où il n'y a pas d'emplacements disponibles pour la page, la méthode se résout avec un tableau vide. Si pour une raison quelconque le processus de sélection échoue, la méthode rejette la promesse avec une erreur.
Retourne : Promise<void>
on
▸ on<T>(event: string): Subscriber<SelectionEvent<T>>
Permet de s'abonner à des événements avec un nom spécifique provenant de n'importe quel emplacement dans la sélection. La méthode s'abonne effectivement à Placement.on invoqué pour chacun des emplacements.
Paramètres :
| Nom | Type | Description |
|---|---|---|
event | string | Nom de l'événement auquel s'abonner |
Retourne : Subscriber<T>
ready
▸ ready(): Promise<T>
Permet d'attendre que chaque emplacement soit prêt. Effectivement la même chose que d'attendre que chaque Placement's ready dans la sélection soit résolu.
Si l'un des emplacements dans la sélection ne parvient pas à se charger pour une raison quelconque, la promesse sera rejetée avec une erreur.
Retourne : Promise<void>
send
▸ send<T>(name: string, data?: T): Promise<void>
Permet d'envoyer un événement à chaque emplacement. Équivalent à l'invocation de Placement.send pour chaque emplacement dans la sélection.
La promesse retournée sera résolue une fois que tous les emplacements auront traité le message.
Paramètres :
| Nom | Type | Description |
|---|---|---|
name | string | Nom de l'événement |
data | T | Charge utile attendue pour un événement donné |
Renvoie : Promise<void>
setAttributes
▸ setAttributes(): Promise<void>
Permet de définir des attributs supplémentaires pour la sélection.
À des fins de pertinence, tous les attributs doivent être envoyés lors de la réalisation de la sélection.
Renvoie : Promise<void>
Propriétés
context
• context : SelectionContext
Contexte de la sélection effectuée par Rokt.