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.
Valores constantes que define la API de JavaScript de ContextHub.
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 |
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 |
El objeto ContextHub proporciona acceso a todas las tiendas.
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
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");
Representa un segmento de ContextHub. Utilice ContextHub.SegmentEngine.SegmentManager para obtener segmentos.
Devuelve el nombre del segmento como un valor de tipo String.
Devuelve la ruta del repositorio de la definición del segmento como un valor de tipo String.
Proporciona acceso a los segmentos de ContextHub.
Devuelve los segmentos resueltos en el contexto actual. Esta función no tiene parámetros.
Devuelve
Matriz de objetos ContextHub.SegmentEngine.Segment.
La clase base para las tiendas de ContextHub.
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).
El nombre de la tienda.
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).
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):
Tenga en cuenta que los valores pueden ser objetos.
Parámetros
options
parámetro de setItem(clave;valor;opciones).Devuelve
A boolean
valor:
true
indica que el objeto de datos se ha almacenado.false
indica que el almacén de datos no ha cambiado.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:
true
indica que se agregó la referencia.false
indica que no se añadió ninguna referencia.Déclencheur el ready
para esta tienda. Esta función no tiene parámetros y no devuelve ningún valor.
Quita todos los datos del almacén. La función no tiene parámetros ni valor devuelto.
Devuelve el valor asociado a una clave.
Parámetros
Devuelve
Object que representa el valor de la clave.
Recupera las claves del almacén. Opcionalmente, puede recuperar las claves que utiliza internamente el marco de trabajo de ContextHub.
Parámetros
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).
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.
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.
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:
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.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.
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:
true
evita la activación de la data
evento. El valor predeterminado es false
.Devuelve
A boolean
valor:
true
indica que se eliminó el par clave/valor.false
indica que el almacén de datos no se ha modificado porque la clave no se encontró en el almacén.Quita una referencia del almacén.
Parámetros
key
parámetro del addReference
función.Devuelve
A boolean
valor:
true
indica que la referencia se ha eliminado.false
indica que la clave no era válida y que el almacén no se ha modificado.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
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.
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.
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:
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:
true
indica que el objeto de datos se ha almacenado.false
indica que el almacén de datos no ha cambiado.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.
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:
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
.
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.
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:
Recupera la dirección URL del servicio JSONP.
Parámetros
true
resuelve parámetros, y false
no lo tiene.Devuelve
A string
valor que representa la URL del servicio.
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:
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).
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 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.ttl
se 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
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
Resuelve el parámetro dado.
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 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.
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).
Administra los módulos de IU y los procesadores de módulos de IU.
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
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.
Determina si existe una cookie.
Parámetros
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
}
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:
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/])
Devuelve un valor de cookie.
Parámetros
Devuelve
El valor de la cookie, o null
si no se ha encontrado ninguna cookie para la clave.
Ejemplo
ContextHub.Utils.Cookie.getItem("name");
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:
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/])
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']);
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:
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
.boolean
valor que especifica el Secure
atributo de la cookie. El valor predeterminado es false
.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.
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.
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.
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>
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.
Clase de utilidad que permite a un objeto heredar las propiedades y los métodos de otro objeto.
Hace que un objeto herede las propiedades y métodos de otro objeto.
Parámetros
Proporciona funciones para serializar objetos en formato JSON y deserializar cadenas JSON en objetos.
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 objeto siguiente:
Object {
city: "Basel",
country: "Switzerland",
population: 173330
}
Serializa valores y objetos Javascript en valores de cadena en formato JSON.
Parámetros
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
});
Esta clase facilita la manipulación de los objetos de datos que se van a almacenar o recuperar de los almacenes de ContextHub.
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
tree
objeto.Devuelve
Objeto que contiene los datos combinados.
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.
Recupera el valor de un objeto para la clave a.
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
, 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
}
}
}
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 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"]
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"
}
}
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
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("/");
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
ContextHub.Utils.JSON.tree.sanitize
para sanear la clave antes de agregarla.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:
Permite registrar candidatos de tienda y obtener candidatos de tienda registrados.
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
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.
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
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.
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.
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
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);