Los módulos de biblioteca de tipos de condición tienen un objetivo: evaluar si algo es verdadero o falso. Lo que evalúan depende de usted.
Este documento describe los tipos de condición para extensiones web. Si va a desarrollar una extensión de Edge, consulte la guía sobre tipos de condición para extensiones de Edge en su lugar.
Este documento supone que ya está familiarizado con los módulos de la biblioteca y con la forma en que se integran con las extensiones de Platform Launch. Si necesita una introducción, consulte la información general sobre el formato del módulo de biblioteca antes de volver a esta guía.
Por ejemplo, si desea evaluar si el usuario está en el host example.com
, el módulo puede tener un aspecto similar al siguiente:
module.exports = function(settings) {
return document.location.hostname === 'example.com';
};
Piense ahora en una situación en la que desee que el usuario de Adobe Experience Platform Launch pueda configurar el nombre del host. Puede permitir que el usuario introduzca un nombre de host y, a continuación, guardar el nombre de host en el objeto de configuración. El objeto podría tener este aspecto:
{
"hostname": "example.com"
}
Para poder modificar el nombre de host definido por el usuario, el módulo deberá cambiar a lo siguiente:
module.exports = function(settings) {
return document.location.hostname === settings.hostname;
};
Se pasa un segundo argumento al módulo que contiene información contextual sobre el evento que activó la regla. Esto puede ser beneficioso en algunos casos y se puede acceder a estos datos de la siguiente manera:
module.exports = function(settings, event) {
// event contains information regarding the event that fired the rule
};
El objeto event
debe contener las propiedades siguientes:
Propiedad | Descripción |
---|---|
$type |
Cadena que describe el nombre de la extensión y el nombre del evento, unidos mediante un punto. Por ejemplo, youtube.play . |
$rule |
Objeto que contiene información sobre la regla que se está ejecutando. El objeto debe contener las siguientes propiedades secundarias:
|
La extensión que proporciona el tipo de evento que activó la regla puede, de manera opcional, añadir cualquier otra información de utilidad a este objeto event
.