Referencia de la API de JavaScript de ContextHub contexthub-javascript-api-reference

La API de JavaScript de ContextHub está disponible para los scripts cuando se agrega el componente ContextHub a la página.

Constantes de ContextHub contexthub-constants

Valores constantes que define la API de JavaScript de ContextHub.

Constantes de evento event-constants

En la tabla siguiente se enumeran los nombres y eventos que se producen en las tiendas de ContextHub. Ver también ContextHub.Utils.Eventing.

Constantes de evento de IU ui-event-constants

En la tabla siguiente se enumeran los nombres de los eventos que se producen en la interfaz de usuario de ContextHub.

Referencia de la API de JavaScript de ContextHub contexthub-javascript-api-reference-2

El objeto ContextHub proporciona acceso a todas las tiendas.

Funciones (ContextHub) functions-contexthub

getAllStores() getallstores

Devuelve todas las tiendas registradas de ContextHub.

Esta función no tiene parámetros.

Devuelve

Un objeto que contiene todos los almacenes de ContextHub. Cada almacén es un objeto que utiliza el mismo nombre que el almacén.

Ejemplo

El ejemplo siguiente recupera todos los almacenes y, a continuación, recupera el almacén de geolocalización:

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation

getStore(nombre) getstore-name

Recupera un almacén como un objeto JavaScript.

Parámetros

Devuelve

Un objeto que representa el almacén.

Ejemplo

El siguiente ejemplo recupera el almacén de geolocalización:

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Representa un segmento de ContextHub. Utilice ContextHub.SegmentEngine.SegmentManager para obtener segmentos.

Funciones (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

Devuelve el nombre del segmento como un valor de tipo String.

getPath() getpath

Devuelve la ruta del repositorio de la definición del segmento como un valor de tipo String.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Proporciona acceso a los segmentos de ContextHub.

Funciones (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

Devuelve los segmentos resueltos en el contexto actual. Esta función no tiene parámetros.

Devuelve

Matriz de objetos ContextHub.SegmentEngine.Segment.

ContextHub.Store.Core contexthub-store-core

La clase base para las tiendas de ContextHub.

Propiedades (ContextHub.Store.Core) properties-contexthub-store-core

evento eventing

Un objeto ContextHub.Utils.Eventing. Utilice este objeto para enlazar funciones para almacenar eventos. Para obtener información acerca del valor predeterminado y la inicialización, vea init(name,config).

name name

El nombre de la tienda.

persistencia persistence

Un objeto ContextHub.Utils.Persistence. Para obtener información acerca del valor predeterminado y la inicialización, vea [init(name,config)](https://experienceleague.adobe.com/docs/experience-manager-65/content/implementing/developing/personlization/contexthub-api.html?lang=es#init-name-config).

Funciones (ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(árbol, opciones) addallitems-tree-options

Combina un objeto de datos o una matriz con los datos almacenados. Cada par clave/valor del objeto o matriz se agrega al almacén (mediante la función setItem):

Tenga en cuenta que los valores pueden ser objetos.

Parámetros

Devuelve

Un valor boolean:

addReference(key, otherKey) addreference-key-anotherkey

Crea una referencia de una clave a otra. Una clave no puede hacer referencia a sí misma.

Parámetros

Devuelve

Un valor boolean:

announcementReadiness() announcereadiness

Almacena en déclencheur el evento ready para este almacén. Esta función no tiene parámetros y no devuelve ningún valor.

clean() clean

Quita todos los datos del almacén. La función no tiene parámetros ni valor devuelto.

getItem(key) getitem-key

Devuelve el valor asociado a una clave.

Parámetros

Devuelve

Object que representa el valor de la clave.

getKeys(includeInternals) getkeys-includeinternals

Recupera las claves del almacén. Opcionalmente, puede recuperar las claves que utiliza internamente el marco de trabajo de ContextHub.

Parámetros

Devuelve

Una matriz de nombres de claves (string valores).

getReferences() getreferences

Recupera las referencias del almacén.

Devuelve

Matriz que utiliza claves de referencia como índices para las claves a las que se hace referencia:

getTree(includeInternals) gettree-includeinternals

Recupera el árbol de datos del almacén. Opcionalmente, puede incluir los pares clave/valor que utiliza internamente el marco de trabajo de ContextHub.

Parámetros

Devuelve

Objeto que representa el árbol de datos. Las claves son los nombres de propiedad del objeto.

init(nombre, configuración) init-name-config

Inicializa el almacén.

Parámetros

isEventingPaused() iseventingpaused

Determina si el evento está en pausa para este almacén.

Devuelve

Un valor booleano:

pauseEventing() pauseeventing

Pausa los eventos del almacén para que no se desencadene ningún evento. Esta función no requiere parámetros y no devuelve ningún valor.

removeItem(key, options) removeitem-key-options

Quita un par clave/valor del almacén.

Cuando se quita una clave, la función almacena en déclencheur el evento data. Los datos del evento incluyen el nombre del almacén, el nombre de la clave que se eliminó, el valor que se eliminó, el nuevo valor de la clave (nulo) y el tipo de acción "quitar".

Opcionalmente, puede evitar que se active el evento data.

Parámetros

Devuelve

Un valor boolean:

removeReference(key) removereference-key

Quita una referencia del almacén.

Parámetros

Devuelve

Un valor boolean:

reset(keepRemainingData) reset-keepremainingdata

Restablece los valores iniciales de los datos persistentes del almacén. De forma opcional, puede eliminar todos los demás datos del almacén. El evento se detiene para este almacén mientras se restablece el almacén. Esta función no devuelve ningún valor.

Los valores iniciales se proporcionan en la propiedad initialValues del objeto de configuración que se utiliza para crear una instancia del objeto de almacén.

Parámetros

Restablece los valores iniciales de los datos persistentes del almacén. De forma opcional, puede eliminar todos los demás datos del almacén. El evento se detiene para este almacén mientras se restablece el almacén. Esta función no devuelve ningún valor.

Los valores iniciales se proporcionan en la propiedad initialValues del objeto de configuración que se utiliza para crear una instancia del objeto de almacén.

Parámetros

resolveReference(key, retry) resolvereference-key-retry

Recupera una clave referenciada. De forma opcional, puede especificar el número de iteraciones que se utilizarán para resolver la mejor coincidencia.

Parámetros

Devuelve

Un valor string que representa la clave a la que se hace referencia. Si no se resuelve ninguna referencia, se devuelve el valor del parámetro key.

resumeEventing() resumeeventing

Reanuda los eventos de este almacén para que se activen eventos. Esta función no define parámetros y no devuelve ningún valor.

setItem(clave, valor, opciones) setitem-key-value-options

Agrega un par clave/valor al almacén.

Almacena en déclencheur el evento data solo si el valor de la clave es diferente del valor almacenado actualmente para la clave. Opcionalmente, puede evitar que se active el evento data.

Los datos del evento incluyen el nombre del almacén, la clave, el valor anterior, el nuevo valor y el tipo de acción de set.

Parámetros

Devuelve

Un valor boolean:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Un almacén que contiene datos JSON. Los datos se recuperan de un servicio JSONP externo o, opcionalmente, de un servicio que devuelve datos JSON. Especifique los detalles del servicio mediante la función init al crear una instancia de esta clase.

El almacén utiliza la persistencia en memoria (variable JavaScript). Los datos de almacenamiento solo están disponibles durante la duración de la página.

ContextHub.Store.JSONPStore amplía ContextHub.Store.Core y hereda las funciones de esa clase.

Funciones (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

Configura los detalles para conectarse al servicio JSONP que utiliza este objeto. Puede actualizar o reemplazar la configuración existente. La función no devuelve ningún valor.

Parámetros

getRawResponse() getrawresponse

Devuelve la respuesta sin procesar almacenada en caché desde la última llamada al servicio JSONP. La función no requiere parámetros.

Devuelve

Un objeto que representa la respuesta sin procesar.

getServiceDetails() getservicedetails

Recupera el objeto de servicio para este objeto ContextHub.Store.JSONPStore. El objeto de servicio contiene toda la información necesaria para crear la dirección URL del servicio.

Devuelve

Un objeto con las siguientes propiedades:

getServiceURL(resolve) getserviceurl-resolve

Recupera la dirección URL del servicio JSONP.

Parámetros

Devuelve

Valor string que representa la dirección URL del servicio.

init(nombre, configuración) init-name-config-1

inicializa el objeto ContextHub.Store.JSONPStore.

Parámetros

queryService(reload) queryservice-reload

Consulta el servicio JSONP remoto y almacena en caché la respuesta. Si el tiempo desde la llamada anterior a esta función es menor que el valor de config.service.ttl, no se llama al servicio y la respuesta almacenada en caché no cambia. De forma opcional, puede forzar la llamada al servicio. La propiedad config.service.ttlse establece al llamar a la función init para inicializar el almacén.

Almacena en déclencheur el evento ready cuando finaliza la consulta. Si no se establece la dirección URL del servicio JSONP, la función no hace nada.

Parámetros

restablecer reset

Restablece los valores iniciales de los datos persistentes del almacén y, a continuación, llama al servicio JSONP. De forma opcional, puede eliminar todos los demás datos del almacén. El evento se detiene para este almacén mientras se restablecen los valores iniciales. Esta función no devuelve ningún valor.

Los valores iniciales se proporcionan en la propiedad initialValues del objeto de configuración que se utiliza para crear una instancia del objeto de almacén.

Parámetros

resolveParameter(f) resolveparameter-f

Resuelve el parámetro dado.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore amplía ContextHub.Store.JSONPStore, de modo que hereda todas las funciones de esa clase. Sin embargo, los datos recuperados del servicio JSONP se conservan según la configuración de persistencia de ContextHub. (Consulte Modos de persistencia.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore amplía ContextHub.Store.Core de modo que hereda todas las funciones de esa clase. Los datos de este almacén se conservan según la configuración de persistencia de ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore amplía ContextHub.Store.Core de modo que hereda todas las funciones de esa clase. Los datos de este almacén se conservan utilizando la persistencia en memoria (objeto JavaScript).

ContextHub.UI contexthub-ui

Administra los módulos de IU y los procesadores de módulos de IU.

Funciones (ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender

Registra un procesador de módulos de IU con ContextHub. Una vez registrado el procesador, se puede usar para crear módulos de IU. Utilice esta función cuando esté ampliando ContextHub.UI.BaseModuleRenderer para crear un procesador de módulos de interfaz de usuario personalizado.

Parámetros

Ejemplo

En el ejemplo siguiente se registra un procesador como tipo de módulo contexthub.browserinfo.

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Cookie contexthub-utils-cookie

Una clase de utilidad para interactuar con cookies.

Funciones (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie

exists(key) exists-key

Determina si existe una cookie.

Parámetros

Devuelve

El valor boolean true indica que la cookie existe.

Ejemplo

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(filtro) getallitems-filter

Devuelve todas las cookies que tienen claves que coinciden con un filtro.

Parámetros

Devuelve

Un objeto de cookies. Las propiedades de objeto son claves de cookie y los valores de clave son valores de cookie.

Ejemplo

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key) getitem-key-1

Devuelve un valor de cookie.

Parámetros

Devuelve

El valor de la cookie o null si no se encontró ninguna cookie para la clave.

Ejemplo

ContextHub.Utils.Cookie.getItem("name");

getKeys(filtro) getkeys-filter

Devuelve una matriz de claves de cookies existentes que coinciden con un filtro.

Parámetros

Devuelve

Matriz de cadenas en la que cada cadena es la clave de una cookie que coincide con el filtro.

Ejemplo

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(key, options) removeitem-key-options-1

Quita una cookie. Para eliminar la cookie, el valor se establece en una cadena vacía y la fecha de caducidad se establece en el día anterior a la fecha actual.

Parámetros

Devuelve

Esta función no devuelve un valor.

Ejemplo

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(clave, valor, opciones) setitem-key-value-options-1

Crea una cookie de la clave y el valor dados y agrega la cookie al documento actual. Opcionalmente, puede especificar opciones que configuren los atributos de la cookie.

Parámetros

Devuelve

La cookie con el valor establecido.

Ejemplo

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

desvanecer(filtro, opciones) vanish-filter-options

Elimina todas las cookies que coinciden con un filtro determinado. Las cookies se comparan mediante la función getKeys y se eliminan mediante la función removeItem.

Parámetros

Devuelve

Esta función no devuelve un valor.

ContextHub.Utils.Eventing contexthub-utils-eventing

Permite enlazar y desenlazar funciones a eventos de tienda de ContextHub. Acceda a los objetos ContextHub.Utils.Eventing de un almacén mediante la propiedad eventing del almacén.

Funciones (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(nombre, selector) off-name-selector

Desenlaza una función de un evento.

Parámetros

Devuelve

Esta función no devuelve ningún valor.

on(nombre, controlador, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

Enlaza una función a un evento. Se llama a la función cada vez que se produce el evento. De forma opcional, se puede llamar a la función para eventos que se han producido en el pasado, antes de que se establezca el enlace.

Parámetros

Devuelve

Cuando el argumento triggerForPastEvents es true, esta función devuelve un valor boolean que indica si el evento se produjo en el pasado:

Si triggerForPastEvents es false, esta función no devuelve ningún valor.

Ejemplo

En el ejemplo siguiente se enlaza una función al evento de datos del almacén de geolocalización. La función rellena un elemento de la página con el valor del elemento de datos de latitud del almacén.

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(nombre, controlador, selector, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Enlaza una función a un evento. La función se llama solo una vez, para la primera aparición del evento. De forma opcional, se puede llamar a la función para el evento que se ha producido en el pasado, antes de que se establezca el enlace.

Parámetros

Devuelve

Cuando el argumento triggerForPastEvents es true, esta función devuelve un valor boolean que indica si el evento se produjo en el pasado:

Si triggerForPastEvents es false, esta función no devuelve ningún valor.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Clase de utilidad que permite a un objeto heredar las propiedades y los métodos de otro objeto.

Funciones (ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance

inherit(secundario, principal) inherit-child-parent

Hace que un objeto herede las propiedades y métodos de otro objeto.

Parámetros

ContextHub.Utils.JSON contexthub-utils-json

Proporciona funciones para serializar objetos en formato JSON y deserializar cadenas JSON en objetos.

Funciones (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(datos) parse-data

Analiza un valor de cadena como JSON y lo convierte en un objeto javascript.

Parámetros

Devuelve

Un objeto JavaScript.

Ejemplo

El código ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); devuelve el siguiente objeto:

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data) stringify-data

Serializa valores y objetos JavaScript en valores de cadena en formato JSON.

Parámetros

Devuelve

El valor de cadena serializado. Cuando data es un valor R egExp, esta función devuelve un objeto vacío. Cuando data es una función, devuelve undefined.

Ejemplo

El siguiente código devuelve "{'city':'Basel','country':'Switzerland','population':'173330'}":

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

Esta clase facilita la manipulación de los objetos de datos que se van a almacenar o recuperar de los almacenes de ContextHub.

Funciones (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

Crea una copia de un objeto de datos y le agrega el árbol de datos a partir de un segundo objeto. La función devuelve la copia y no modifica ninguno de los objetos originales. Cuando los árboles de datos de los dos objetos contienen claves idénticas, el valor del segundo objeto sobrescribe el valor del primer objeto.

Parámetros

Devuelve

Objeto que contiene los datos combinados.

cleanup() cleanup

Crea una copia de un objeto, busca y quita elementos en el árbol de datos que no contienen valores, valores nulos o valores indefinidos, y devuelve la copia.

Parámetros

Devuelve

Una copia del árbol que se ha limpiado.

getItem() getitem

Recupera el valor de un objeto para la clave.

Parámetros

Devuelve

El valor que corresponde a la clave. Cuando la clave tiene claves secundarias, esta función devuelve un objeto complejo. Cuando el tipo del valor de la clave es undefined, se devuelve null.

Ejemplo

Considere el siguiente objeto de JavaScript:

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

El siguiente código de ejemplo devuelve el valor 260:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

El siguiente código de ejemplo recupera el valor de una clave que tiene claves secundarias:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

La función devuelve el siguiente objeto:

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys() getkeys

Recupera todas las claves del árbol de datos de un objeto. De forma opcional, puede recuperar únicamente las claves secundarias de una clave específica. Si lo desea, también puede especificar un orden de las claves recuperadas.

Parámetros

Devuelve

Una matriz de claves.

Ejemplo

Considere el siguiente objeto:

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

El script ContextHub.Utils.JSON.tree.getKeys(myObject); devuelve la siguiente matriz:

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem() removeitem

Crea una copia de un objeto determinado, quita la rama especificada del árbol de datos y devuelve la copia modificada.

Parámetros

Devuelve

Una copia del objeto de datos original sin la clave.

Ejemplo

Considere el siguiente objeto:

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

La siguiente secuencia de comandos de ejemplo elimina la rama /uno/dos/tres/cuatro del árbol de datos:

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

La función devuelve el siguiente objeto:

myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key) sanitizekey-key

Sanea los valores de cadena para que se puedan utilizar como claves. Para sanear una cadena, esta función realiza las siguientes acciones:

Utilice la matriz resultante para crear una clave utilizable. Parámetros

Devuelve

Matriz de string valores donde cada cadena es la parte de key que fue demarcada con barras oblicuas. representa la clave saneada. Si la matriz saneada tiene una longitud de cero, esta función devuelve null.

Ejemplo

El siguiente código sanea una cadena para producir la matriz ["this", "is", "a", "path"] y, a continuación, genera la clave "/this/is/a/path" de la matriz:

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(árbol, clave, valor) setitem-tree-key-value

Agrega un par clave/valor al árbol de datos de una copia de un objeto. Para obtener información acerca de los árboles de datos, vea Persistencia.

Parámetros

Devuelve

Una copia del objeto tree que incluye el par key/ value.

Ejemplo

Considere el siguiente código JavaScript:

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

El objeto myObject tiene el siguiente valor:

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Permite registrar candidatos de tienda y obtener candidatos de tienda registrados.

Funciones (ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Devuelve los tipos de almacén que están registrados como candidatos de almacén. Recupere los candicados registrados de un tipo de tienda específico o de todos los tipos de tienda.

Parámetros

Devuelve

Un objeto de tipos de almacén. Las propiedades de objeto son los nombres de tipo de almacén y los valores de propiedad son una matriz de candidatos de almacén registrados.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Devuelve un tipo de almacén de los candidatos registrados. Si se registra más de un tipo de almacén con el mismo nombre, la función devuelve el tipo de almacén con la prioridad más alta.

Parámetros

Devuelve

Un objeto que representa el candidato de almacén registrado. Si el tipo de almacén solicitado no está registrado, se genera un error.

getSupportedStoreTypes() getsupportedstoretypes

Devuelve los nombres de los tipos de almacén que están registrados como candidatos de almacén. Esta función no requiere parámetros.

Devuelve

Una matriz de valores de cadena, donde cada cadena es el tipo de tienda con el que se registró un candidato a tienda. Ver el parámetro storeType de la función ContextHub.Utils.storeCandidates.registerStoreCandidate.

registerStoreCandidate(store, storeType, priority, applies) registerstorecandidate-store-storetype-priority-applies

Registra un objeto de almacén como candidato de almacén mediante un nombre y una prioridad.

La prioridad es un número que indica la importancia de las tiendas con el mismo nombre. Cuando un candidato a tienda se registra con el mismo nombre que un candidato a tienda ya registrado, se utiliza el candidato con la prioridad más alta. Al registrar un candidato a tienda, la tienda se registra solo si la prioridad es mayor que la de los candidatos a tienda registrados con el mismo nombre.

Parámetros

Ejemplo

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);