Referencia de la API de JavaScript de ContextHub

La API de JavaScript de ContextHub está disponible para los scripts cuando la variable El componente ContextHub se ha añadido a la página.

Constantes de ContextHub

Valores constantes que define la API de JavaScript de ContextHub.

Constantes de evento

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

Constante	Descripción	Valor
ContextHub.Constants.EVENT_NAMESPACE	Área de nombres de evento de ContextHub	ch
ContextHub.Constants.EVENT_ALL_STORES_READY	Indica que todas las tiendas requeridas están registradas, inicializadas y listas para consumirse	todo preparado para las tiendas
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY	Indica que no todos los almacenes se inicializaron dentro de un tiempo de espera determinado	store-partial-ready
ContextHub.Constants.EVENT_STORE_REGISTERED	Se activa cuando se registra una tienda	registrado en tienda
ContextHub.Constants.EVENT_STORE_READY	Indica que las tiendas están listas para funcionar. Se activa inmediatamente después del registro, excepto en los almacenes JSONP, donde se activa cuando se recuperan datos).	listo para almacenar
ContextHub.Constants.EVENT_STORE_UPDATED	Se activa cuando una tienda actualiza su persistencia	actualizado en tienda
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME	Nombre de contenedor de persistencia	ContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY	Almacena el nombre de clave de persistencia específico donde se almacena el resultado JSON sin procesar	/_/raw-response
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY	Almacena la marca de tiempo específica que indica cuándo se recuperaron los datos de JSON	/_/response-time
ContextHub.Constants.SERVICE_LAST_URL_KEY	Almacena la URL específica del servicio JSON utilizado durante la última llamada	/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDED	Indica si la IU de ContextHub está expandida	/_/container-expand

Constantes de evento de IU

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

Constante	Descripción	Valor
ContextHub.Constants.EVENT_UI_MODE_REGISTERED	Se activa cuando se registra un modo	ui-mode-registered
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED	Se activa cuando un modo no está registrado	ui-mode-unregistered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED	Se activa cuando se registra un procesador en modo	ui-mode-renderer-registered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED	Se activa cuando un procesador en modo no está registrado	ui-mode-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODE_ADDED	Se activa cuando se añade un nuevo modo	ui-mode-added
ContextHub.Constants.EVENT_UI_MODE_REMOVED	Se activa cuando se elimina un modo	ui-mode-remove
ContextHub.Constants.EVENT_UI_MODE_SELECTED	Se activa cuando el usuario selecciona un modo	ui-mode-selected
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED	Se activa cuando se registra un módulo nuevo	ui-module-registered
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED	Se activa cuando un módulo no está registrado	ui-module-unregistered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED	Se activa cuando se registra un procesador de módulos	ui-module-renderer-registered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED	Se activa cuando un procesador de módulos no está registrado.	ui-module-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODULE_ADDED	Se activa cuando se añade un módulo nuevo	ui-module-added
ContextHub.Constants.EVENT_UI_MODULE_REMOVED	Se activa cuando se elimina un módulo	ui-module-remove
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED	Se activa cuando se añade el contenedor de IU a la página	ui-container-added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED	Se activa al abrir la interfaz de usuario de ContextHub	ui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED	Se activa cuando la interfaz de usuario de ContextHub está contraída	ui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED	Se activa cuando se modifica una propiedad	ui-property-modified
ContextHub.Constants.EVENT_UI_RENDERED	Se activa cada vez que se procesa la interfaz de usuario de ContextHub (por ejemplo, después de un cambio de propiedad)	procesado por ui
ContextHub.Constants.EVENT_UI_INITIALIZED	Se activa cuando se inicializa el contenedor de IU	inicializado por la interfaz de usuario
ContextHub.Constants.ACTIVE_UI_MODE	Indica el modo de IU activo	/_/active-ui-mode

Referencia de la API de JavaScript de ContextHub

El objeto ContextHub proporciona acceso a todas las tiendas.

Funciones (ContextHub)

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)

Recupera un almacén como un objeto Javascript.

Parámetros

nombre: Nombre con el que se registró el almacén.

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

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

Funciones (ContextHub.ContextEngine.Segment)

getName()

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

getPath()

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

ContextHub.SegmentEngine.SegmentManager

Proporciona acceso a los segmentos de ContextHub.

Funciones (ContextHub.SegmentEngine.SegmentManager)

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

La clase base para las tiendas de ContextHub.

Propiedades (ContextHub.Store.Core)

evento

A ContextHub.Utils.Eventing objeto. Utilice este objeto para enlazar funciones para almacenar eventos. Para obtener información sobre el valor predeterminado y la inicialización, consulte init(name,config).

name

El nombre de la tienda.

persistencia

Un objeto ContextHub.Utils.Persistence. Para obtener información sobre el valor predeterminado y la inicialización, consulte [init(name,config)](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=es#init-name-config).

Funciones (ContextHub.Store.Core)

addAllItems(árbol, opciones)

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 (a través de la variable setItem función):

Objeto: Las claves son los nombres de propiedad.
Matriz: Las claves son los índices de matriz.

Tenga en cuenta que los valores pueden ser objetos.

Parámetros

árbol: (Objeto o matriz) Los datos que se van a agregar al almacén.
opciones: (Objeto) Un objeto opcional de opciones que se pasa a la función setItem. Para obtener más información, consulte options parámetro de setItem(clave;valor;opciones).

Devuelve

A boolean valor:

Un valor de true indica que el objeto de datos se ha almacenado.
Un valor de false indica que el almacén de datos no ha cambiado.

addReference(key, otherKey)

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

Parámetros

clave: La clave que hace referencia a anotherKey.
otra clave: Son claves a las que hace referencia key.

Devuelve

A boolean valor:

Un valor de true indica que se agregó la referencia.
Un valor de false indica que no se añadió ninguna referencia.

announcementReadiness()

Déclencheur el ready para esta tienda. Esta función no tiene parámetros y no devuelve ningún valor.

clean()

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

getItem(key)

Devuelve el valor asociado a una clave.

Parámetros

clave: (Cadena) Clave para la que se devuelve el valor.

Devuelve

Object que representa el valor de la clave.

getKeys(includeInternals)

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

Parámetros

includeInternals Un valor de true incluye claves utilizadas internamente en los resultados. Estas teclas comienzan con el carácter de subrayado ("_"). El valor predeterminado es false.

Devuelve

Una matriz de nombres de clave ( string valores).

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:

Las claves de referencia se corresponden con key parámetro del addReference función.
Las claves a las que se hace referencia corresponden con anotherKey parámetro del addReference función.

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

includeInternals: Un valor de true incluye pares clave/valor utilizados internamente en los resultados. Las claves de estos datos comienzan con el carácter de subrayado ("_"). El valor predeterminado es false.

Devuelve

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

init(nombre, configuración)

Inicializa el almacén.

Establece los datos de almacén en un objeto vacío.
Establece las referencias de almacén en un objeto vacío.
eventChannel es data:name, donde name es el nombre del almacén.
storeDataKey es /store/name, donde name es el nombre del almacén.

Parámetros

nombre: El nombre de la tienda.
configuración: Un objeto que contiene propiedades de configuración:
- eventDeferring: El valor predeterminado es 32.
- Evento: el ContextHub.Utils.Eventing objeto para este almacén. El valor predeterminado es el objeto ContextHub.eventing que utiliza.
- persistence: el objeto ContextHub.Utils.Persistence de este almacén. El valor predeterminado es el objeto ContextHub.persistence.

isEventingPaused()

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

Devuelve

Un valor booleano:

true: el evento se pone en pausa para que no se active ningún evento para este almacén.
false: el evento no está en pausa para que se activen eventos para este almacén.

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)

Quita un par clave/valor del almacén.

Cuando se quita una clave, la función déclencheur el data evento. 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".

De forma opcional, puede evitar que se active la variable data evento.

Parámetros

clave: (Cadena) Nombre de la clave que se va a quitar.
opciones: (Objeto) Un objeto de opciones. Las siguientes propiedades de objeto son válidas:
- silencioso: un valor de true evita la activación de la data evento. El valor predeterminado es false.

Devuelve

A boolean valor:

Un valor de true indica que se eliminó el par clave/valor.
Un valor de false indica que el almacén de datos no se ha modificado porque la clave no se encontró en el almacén.

removeReference(key)

Quita una referencia del almacén.

Parámetros

clave: La referencia clave que se va a quitar. Este parámetro corresponde a la variable key parámetro del addReference función.

Devuelve

A boolean valor:

Un valor de true indica que la referencia se ha eliminado.
Un valor de false indica que la clave no era válida y que el almacén no se ha modificado.

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

keepRemainingData: (Booleano) Un valor true hace que los datos no iniciales se mantengan. El valor false hace que se eliminen todos los datos excepto los valores iniciales.

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

keepRemainingData: (Boolean) un valor de true hace que se mantengan los datos no iniciales. El valor false hace que se eliminen todos los datos excepto los valores iniciales.

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

clave: (Cadena) Clave para la que se va a resolver la referencia. Esta key El parámetro corresponde a la variable key parámetro del addReference función.
reintentar: (Número) El número de iteraciones que se van a utilizar.

Devuelve

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

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)

Agrega un par clave/valor al almacén.

Déclencheur el data solo si el valor de la clave es diferente del valor almacenado actualmente para la clave. Si lo desea, puede evitar que se active la variable data evento.

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

clave: (Cadena) Nombre de la clave.
opciones: (Objeto) Un objeto de opciones. Las siguientes propiedades de objeto son válidas:
- silencioso: un valor de true evita la activación de la data evento. El valor predeterminado es false.
valor: (Objeto) Valor que se asocia a la clave.

Devuelve

A boolean valor:

Un valor de true indica que el objeto de datos se ha almacenado.
Un valor de false indica que el almacén de datos no ha cambiado.

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 variable init cuando se crea una instancia de esta clase.

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

ContextHub.Store.JSONPStore extiende ContextHub.Store.Core y hereda las funciones de esa clase.

Funciones (ContextHub.Store.JSONPStore)

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

serviceConfig: Un objeto que contiene las siguientes propiedades:
- host: (cadena) nombre del servidor o dirección IP.
- jsonp: (Boolean) Un valor de true indica que el servicio es un servicio JSONP; en caso contrario, false. Cuando es true, la llamada de retorno {callback}: "ContextHub.Callbacks.Object.name El objeto } se agrega al objeto service.params.
- params: Parámetros de URL (objeto) representados como propiedades de objeto. Los nombres de parámetro son nombres de propiedad y los valores de parámetro son valores de propiedad.
- path: (String) Ruta al servicio.
- port: (número) número de puerto del servicio.
- secure: (cadena o booleano) determina el protocolo que se utiliza para la dirección URL del servicio:
  - auto: //
  - true: https://
  - false: https://
omitir: (Boolean). Un valor de true hace que la configuración del servicio existente se reemplace por las propiedades de serviceConfig. Un valor de false hace que las propiedades de configuración del servicio existentes se combinen con las propiedades de serviceConfig.

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()

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:

host: (Cadena) El nombre del servidor o la dirección IP.
jsonp: (Booleano) Un valor de true indica que el servicio es un servicio JSONP; en caso contrario, false. Cuando es true, la llamada de retorno {callback}: "ContextHub.Callbacks.Object.name El objeto } se agrega al objeto service.params.
parámetros: Parámetros de URL (objeto) representados como propiedades de objeto. Los nombres de parámetro son nombres de propiedad y los valores de parámetro son valores de propiedad.
ruta: (Cadena) Ruta de acceso al servicio.
puerto: (Número) El número de puerto del servicio.
seguro: (Cadena o Booleano) Determina el protocolo que se utilizará para la URL del servicio:
- auto: //
- true: https://
- false: https://

getServiceURL(resolve)

Recupera la dirección URL del servicio JSONP.

Parámetros

resolver: (Booleano) Determina si se deben incluir los parámetros resueltos en la dirección URL. Un valor de true resuelve parámetros, y false no lo tiene.

Devuelve

A string valor que representa la URL del servicio.

init(nombre, configuración)

inicializa el objeto ContextHub.Store.JSONPStore.

Parámetros

nombre: (Cadena) Nombre de la tienda.
configuración: (Objeto) Un objeto que contiene la propiedad de servicio. El objeto JSONPStore utiliza las propiedades del service para construir la URL del servicio JSONP:
- eventDeferring: 32.
- Evento: el objeto ContextHub.Utils.Eventing de este almacén. El valor predeterminado es ContextHub.eventing objeto.
- persistence: el objeto ContextHub.Utils.Persistence de este almacén. De forma predeterminada, se utiliza la persistencia de la memoria (objeto Javascript).
- service: (objeto)
  - host: (cadena) nombre del servidor o dirección IP.
  - jsonp: (Boolean) Un valor de true indica que el servicio es un servicio JSONP; en caso contrario, false. Si es true, la variable {callback: "ContextHub.Callbacks.*Object.name*}se agrega el objeto a service.params.
  - params: Parámetros de URL (objeto) representados como propiedades de objeto. Los nombres y valores de parámetro son los nombres y valores de las propiedades de objeto, respectivamente.
  - path: (String) Ruta al servicio.
  - port: (número) número de puerto del servicio.
  - secure: (cadena o booleano) determina el protocolo que se utiliza para la dirección URL del servicio:
    - auto: //
    - true: https://
    - false: https://
  - timeout: (número) cantidad de tiempo de espera para que el servicio JSONP responda antes de que se agote el tiempo de espera, en milisegundos.
  - ttl: Cantidad mínima de tiempo en milisegundos que transcurre entre llamadas al servicio JSONP. (Consulte la queryService función).

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.ttlNo obstante, no se llama al servicio y la respuesta almacenada en caché no cambia. De forma opcional, puede forzar la llamada al servicio. El config.service.ttlse establece al llamar a la propiedad 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

recargar: (Booleano) Un valor true elimina la respuesta almacenada en caché y fuerza la llamada al servicio JSONP.

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

keepRemainingData: (Booleano) Un valor true hace que los datos no iniciales se mantengan. El valor false hace que se eliminen todos los datos excepto los valores iniciales.

resolveParameter(f)

Resuelve el parámetro dado.

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedJSONPStore extiende ContextHub.Store.JSONPStore por lo tanto, 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 amplía ContextHub.Store.Core por lo tanto, 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

Extensiones de ContextHub.Store.SessionStore ContextHub.Store.Core por lo tanto, hereda todas las funciones de esa clase. Los datos de este almacén se conservan utilizando la persistencia en memoria (objeto Javascript).

ContextHub.UI

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

Funciones (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

Registra un procesador de módulos de IU con ContextHub. Una vez registrado el procesador, se puede utilizar para lo siguiente crear módulos de IU. Utilice esta función cuando esté ampliar ContextHub.UI.BaseModuleRenderer para crear un procesador de módulos de IU personalizado.

Parámetros

moduleType: (Cadena) Identificador del procesador del módulo de interfaz de usuario. Si un procesador ya está registrado con el valor especificado, el procesador existente no estará registrado antes de que se registre este procesador.
procesador: (Cadena) Nombre de la clase que procesa el módulo de interfaz de usuario.
dontRender: (Booleano) Establezca en true para evitar que la interfaz de usuario de ContextHub se represente después de registrar el procesador. El valor predeterminado es false.

Ejemplo

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

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

Una clase de utilidad para interactuar con cookies.

exists(key)

Determina si existe una cookie.

Parámetros

clave: A String que contiene la clave de la cookie que está probando.

Devuelve

A boolean el valor true indica que la cookie existe.

Ejemplo

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

getAllItems(filtro)

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

Parámetros

(Opcional) filtro: Criterios para la coincidencia de claves de cookie. Para devolver todas las cookies, no especifique ningún valor. Se admiten los siguientes tipos:
- Cadena: La cadena se compara con la clave de la cookie.
- Matriz: cada elemento de la matriz es un filtro.
- Un objeto RegExp: la función de prueba del objeto se utiliza para hacer coincidir claves de cookie.
- Una función: Una función que prueba una clave de cookie para detectar una coincidencia. La función debe tomar la clave de cookie como parámetro y devolver true si la prueba confirma una coincidencia.

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)

Devuelve un valor de cookie.

Parámetros

clave: La clave de la cookie cuyo valor desea calcular.

Devuelve

El valor de la cookie, o null si no se ha encontrado ninguna cookie para la clave.

Ejemplo

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

getKeys(filtro)

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

Parámetros

filtro: Criterios para la coincidencia de claves de cookie. Se admiten los siguientes tipos:
- Cadena: La cadena se compara con la clave de la cookie.
- Matriz: cada elemento de la matriz es un filtro.
- Un objeto RegExp: la función de prueba del objeto se utiliza para hacer coincidir claves de cookie.
- Una función: Una función que prueba una clave de cookie para detectar una coincidencia. La función debe tomar la clave de cookie como parámetro y devolver true si la prueba confirma una coincidencia.

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)

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

clave: A String valor que representa la clave de la cookie que se va a quitar.
opciones: Un objeto que contiene valores de propiedad para configurar los atributos de la cookie. Consulte la [setItem](/docs/experience-manager-65/developing/personlization/contexthub-api.html?lang=es#setitem-key-value-options) para obtener más información. El expires no tiene ningún efecto.

Devuelve

Esta función no devuelve un valor.

Ejemplo

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

setItem(clave, valor, opciones)

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

clave: String que contiene la clave de la cookie.
valor: String que contiene el valor de la cookie.
opciones: (Opcional) Un objeto que contiene cualquiera de las siguientes propiedades que configuran los atributos de la cookie:
- caduca: A date o number valor que especifica cuándo caduca la cookie. Un valor de fecha especifica la hora absoluta de caducidad. Un número (en días) establece la hora de caducidad para la hora actual más el número. El valor predeterminado es undefined.
- secure: A boolean valor que especifica el Secure atributo de la cookie. El valor predeterminado es false.
- ruta: A String valor que se utilizará como Path atributo de la cookie. El valor predeterminado es undefined.

Devuelve

La cookie con el valor establecido.

Ejemplo

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

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

filtro: El filter argumento que se va a utilizar en la llamada a [getKeys](/docs/experience-manager-65/developing/personlization/contexthub-api.md#getkeys-filter) función.
opciones: El options argumento que se va a utilizar en la llamada a [removeItem](/docs/experience-manager-65/developing/personlization/contexthub-api.md#removeitem-key-options) función.

Devuelve

Esta función no devuelve un valor.

ContextHub.Utils.Eventing

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

Funciones (ContextHub.Utils.Eventing)

off(nombre, selector)

Desenlaza una función de un evento.

Parámetros

nombre: El nombre del evento para el que se desenlaza la función.
selector: El selector que identifica el enlace. (Consulte la selector parámetro para el y una vez funciones).

Devuelve

Esta función no devuelve ningún valor.

on(nombre, controlador, 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

nombre: (Cadena) El nombre del evento a la que está enlazando la función.
controlador: (Función) La función que se va a enlazar al evento.
selector: (Cadena) Identificador único del enlace. Necesita el selector para identificar el enlace si desea utilizar el off para eliminar el enlace.
triggerForPastEvents: (Booleano) Indica si el controlador debe ejecutarse para los eventos que se produjeron en el pasado. Un valor de true llama al controlador para eventos anteriores. Un valor de false llama al controlador para eventos futuros. El valor predeterminado es true.

Devuelve

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

true: el evento se produjo en el pasado y se llamará al controlador.
false: el evento no se ha producido en el pasado.

If 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)

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

nombre: (Cadena) El nombre del evento a la que está enlazando la función.
controlador: (Función) La función que se va a enlazar al evento.
selector: (Cadena) Identificador único del enlace. Necesita el selector para identificar el enlace si desea utilizar el off para eliminar el enlace.
triggerForPastEvents: (Booleano) Indica si el controlador debe ejecutarse para los eventos que se produjeron en el pasado. Un valor de true llama al controlador para eventos anteriores. Un valor de false llama al controlador para eventos futuros. El valor predeterminado es true.

Devuelve

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

true: el evento se produjo en el pasado y se llamará al controlador.
false: el evento no se ha producido en el pasado.

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

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)

inherit(secundario, principal)

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

Parámetros

secundario: (Objeto) El objeto que hereda.
principal: (Objeto) Objeto que define las propiedades y los métodos heredados.

ContextHub.Utils.JSON

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

Funciones (ContextHub.Utils.JSON)

parse(datos)

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

Parámetros

datos: Un valor de cadena en formato JSON.

Devuelve

Un objeto JavaScript.

Ejemplo

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

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

stringify(data)

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

Parámetros

datos: Valor u objeto que se va a serializar. Esta función admite valores booleanos, de matriz, numéricos, de cadena y de fecha.

Devuelve

El valor de cadena serializado. Cuándo data es una R egExp value, esta función devuelve un objeto vacío. Cuándo 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

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)

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

árbol: El objeto que se copia.
secondTree: El objeto que se combina con la copia del tree objeto.

Devuelve

Objeto que contiene los datos combinados.

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

árbol: Objeto que se va a limpiar.

Devuelve

Una copia del árbol que se ha limpiado.

getItem()

Recupera el valor de un objeto para la clave a.

Parámetros

árbol: El objeto de datos.
clave: La clave del valor que desea recuperar.

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, null se devuelve.

Ejemplo

Considere el siguiente objeto 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()

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

árbol: Objeto del que se recuperan las claves del árbol de datos.
principal: (Opcional) Clave de un elemento del árbol de datos del que desea recuperar las claves de los elementos secundarios.
pedido: (Opcional) Una función que determina el orden de las claves devueltas. (Consulte Array.prototype.sort en Mozilla Developer Network).

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 ContextHub.Utils.JSON.tree.getKeys(myObject); script 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()

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

Parámetros

árbol: un objeto de datos.
clave: La clave que se va a eliminar.

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)

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

Reduce varias barras diagonales consecutivas a una sola barra.
Elimina los espacios en blanco del principio y del final de la cadena.
Divide el resultado en una matriz de cadenas delimitadas por barras oblicuas.

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

clave: El string para desinfectar.

Devuelve

Una matriz de string valores, donde cada cadena es la parte del key que fue demarcado por 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" desde 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)

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

Parámetros

árbol: un objeto de datos.
clave: La clave que se asocia al valor que está agregando. La clave es la ruta al elemento en el árbol de datos. Esta función llama a ContextHub.Utils.JSON.tree.sanitize para sanear la clave antes de agregarla.
value: Valor que se agregará al árbol de datos.

Devuelve

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

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

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

Funciones (ContextHub.Utils.storeCandidates)

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

storeType: (Cadena) Nombre del tipo de almacén. Consulte la storeType parámetro del ContextHub.Utils.storeCandidates.registerStoreCandidate función.

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)

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

storeType: (String) nombre del candidato de la tienda. Consulte la storeType parámetro del ContextHub.Utils.storeCandidates.registerStoreCandidate función.

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()

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. Consulte la storeType parámetro del ContextHub.Utils.storeCandidates.registerStoreCandidate función.

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

tienda: (Objeto) El objeto store que se va a registrar como candidato de store.
storeType: (Cadena) Nombre del candidato de la tienda. Este valor es necesario al crear una instancia del candidato de tienda.
prioridad: (Número) Prioridad del candidato a tienda.
se aplica: (Función) La función que se va a invocar que evalúa la aplicabilidad del almacén en el entorno actual. La función debe devolver true si el almacén es aplicable, y false de lo contrario. El valor predeterminado es una función que devuelve true: function() {return true;}

Ejemplo

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

Recursos de Business.Adobe.com

Automated Onboarding Cms Cloud Embedded Charts Content As A Service Customer Experience Management Digital Asset Management

Referencia de la API de JavaScript de ContextHub

Constantes de ContextHub

Constantes de evento

Constantes de evento de IU

Referencia de la API de JavaScript de ContextHub

Funciones (ContextHub)

getAllStores()

getStore(nombre)

ContextHub.SegmentEngine.Segment

Funciones (ContextHub.ContextEngine.Segment)

getName()

getPath()

ContextHub.SegmentEngine.SegmentManager

Funciones (ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

ContextHub.Store.Core

Propiedades (ContextHub.Store.Core)

evento

name

persistencia

Funciones (ContextHub.Store.Core)

addAllItems(árbol, opciones)

addReference(key, otherKey)

announcementReadiness()

clean()

getItem(key)

getKeys(includeInternals)

getReferences()

getTree(includeInternals)

init(nombre, configuración)

isEventingPaused()

pauseEventing()

removeItem(key, options)

removeReference(key)

reset(keepRemainingData)

resolveReference(key, retry)

resumeEventing()

setItem(clave, valor, opciones)

ContextHub.Store.JSONPStore

Funciones (ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

getRawResponse()

getServiceDetails()

getServiceURL(resolve)

init(nombre, configuración)

queryService(reload)

reset

resolveParameter(f)

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedStore

ContextHub.Store.SessionStore

ContextHub.UI

Funciones (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

ContextHub.Utils.Cookie

Funciones (ContextHub.Utils.Cookie)

exists(key)

getAllItems(filtro)

getItem(key)

getKeys(filtro)

removeItem(key, options)

setItem(clave, valor, opciones)

desvanecer(filtro, opciones)

ContextHub.Utils.Eventing

Funciones (ContextHub.Utils.Eventing)

off(nombre, selector)

on(nombre, controlador, selector, triggerForPastEvents)

once(nombre, controlador, selector, triggerForPastEvents)

ContextHub.Utils.inheritance

Funciones (ContextHub.Utils.inheritance)

inherit(secundario, principal)

ContextHub.Utils.JSON

Funciones (ContextHub.Utils.JSON)

parse(datos)

stringify(data)

ContextHub.Utils.JSON.tree

Funciones (ContextHub.Utils.JSON.tree)

addAllItems()

cleanup()

getItem()