La API de JavaScript de ContextHub está disponible para los scripts cuando el componente ContextHub se ha agregado a la página.
Valores constantes que define la API de JavaScript de ContextHub.
La siguiente tabla lista los eventos de nombres que se producen en las tiendas de ContextHub. Consulte también ContextHub.Utils.Eventing.
Constante | Descripción | Value |
---|---|---|
ContextHub.Constants.EVENT_NAMESPACE |
Área de nombres de evento de ContextHub | ch |
ContextHub.Constants.EVENT_ALL_STORES_READY |
Indica que todos los almacenes requeridos están registrados, inicializados y listos para ser consumidos | all-stores-ready |
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY |
Indica que no todos los almacenes se inicializaron dentro de un tiempo de espera determinado | stores-partially-ready |
ContextHub.Constants.EVENT_STORE_REGISTERED |
Se activa cuando se registra una tienda | store-registered |
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). | store-ready |
ContextHub.Constants.EVENT_STORE_UPDATED |
Se activa cuando una tienda actualiza su persistencia | store-updated |
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME |
Nombre del 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 una marca de hora específica que indica cuándo se recuperaron los datos JSON | /_/response-time |
ContextHub.Constants.SERVICE_LAST_URL_KEY |
Almacena la dirección URL específica del servicio JSON utilizada durante la última llamada | /_/url |
ContextHub.Constants.IS_CONTAINER_EXPANDED |
Indica si la interfaz de usuario de ContextHub está expandida | /_/container-expanded |
La siguiente tabla lista los nombres de los eventos que se producen en la interfaz de usuario de ContextHub.
Constante | Descripción | Value |
---|---|---|
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 de modo | ui-mode-renderer-registered |
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED |
Se activa cuando un procesador de modo no está registrado | ui-mode-renderer-unregistered |
ContextHub.Constants.EVENT_UI_MODE_ADDED |
Se activa cuando se agrega un nuevo modo | ui-mode-added |
ContextHub.Constants.EVENT_UI_MODE_REMOVED |
Se activa cuando se elimina un modo | ui-mode-removed |
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 nuevo módulo | 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 agrega un nuevo módulo | ui-module-added |
ContextHub.Constants.EVENT_UI_MODULE_REMOVED |
Se activa cuando se elimina un módulo | ui-module-removed |
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED |
Se activa cuando se agrega el contenedor de IU a la página | ui-container-added |
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED |
Se activa cuando se abre 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) | ui-rendered |
ContextHub.Constants.EVENT_UI_INITIALIZED |
Se activa cuando se inicializa el contenedor de la interfaz de usuario | ui-initialized |
ContextHub.Constants.ACTIVE_UI_MODE |
Indica el modo de IU activo | /_/active-ui-mode |
El objeto ContextHub proporciona acceso a todas las tiendas.
Devuelve todos los almacenes de ContextHub registrados.
Esta función no tiene parámetros.
Objeto que contiene todos los almacenes de ContextHub. Cada tienda es un objeto que utiliza el mismo nombre que la tienda.
El ejemplo siguiente recupera todas las tiendas y, a continuación, recupera el almacén de geolocalización:
var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation
Recupera una tienda como un objeto Javascript.
name
: El nombre con el que se registró la tienda.Objeto que representa la tienda.
El ejemplo siguiente recupera el almacén de geolocalización:
var geoloc = ContextHub.getStore("geolocation");
Representa un segmento de ContextHub. Utilice el 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.
Matriz de objetos ContextHub.SegmentEngine.Segment
.
La clase base de las tiendas de ContextHub.
Un objeto ContextHub.Utils.Eventing
. Utilice este objeto para funciones de enlace 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)
.
Combina un objeto de datos o una matriz con los datos del almacén. 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.
tree
: (Objeto o matriz) Los datos que se van a agregar al almacén.options
: (Object) Objeto opcional de opciones que se pasa a la función setItem. Para obtener más información, consulte el parámetro options
de setItem(key,value,options)
.Un valor boolean
:
true
indica que se almacenó el objeto de datos.false
indica que el almacén de datos no ha cambiado.Crea una referencia de una clave a otra. Una clave no se puede hacer referencia a sí misma.
key
: La clave a la que se hace referencia anotherKey
.
anotherkey
: Clave a la que hace referencia key
.
Un valor boolean
:
true
indica que se agregó la referencia.false
indica que no se agregó ninguna referencia.Déclencheur el evento 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.
key
: (String) La clave para la que se devuelve el valor.Objeto que representa el valor de la clave.
Recupera las claves de la tienda. Opcionalmente, puede recuperar las claves que utiliza internamente el marco de ContextHub.
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
.Matriz de nombres de clave ( string
valores).
Recupera las referencias de la tienda.
Matriz que utiliza claves de referencia como índices para las claves a las que se hace referencia:
key
de la función addReference
.anotherKey
de la función addReference
.Recupera el árbol de datos del almacén. Opcionalmente, puede incluir los pares clave/valor que utiliza internamente el marco de trabajo de ContextHub.
includeInternals:
Un valor de true
incluye pares de clave/valor utilizados internamente en los resultados. Las claves de estos datos comienzan con el carácter de subrayado (_
). El valor predeterminado es false
.Objeto que representa el árbol de datos. Las claves son los nombres de propiedad del objeto.
Inicializa la tienda.
eventChannel
es data:<name>
, donde <name>
es el nombre del almacén.storeDataKey
es /store/<name>
, donde <name>
es el nombre del almacén.name
: El nombre de la tienda.config
: Un objeto que contiene propiedades de configuración:
eventDeferring
: El valor predeterminado es 32.eventing
:: El objeto ContextHub.Utils. Eventingpara esta tienda. El valor predeterminado es el objeto ContextHub.eventing
que utiliza.persistence
:: El ContextHub.Utils.Persistence
objeto de esta tienda. El valor predeterminado es el objeto ContextHub.persistence
.Determina si el evento está en pausa para esta tienda.
Un valor booleano:
true
:: El evento se pone en pausa para que no se activen eventos para esta tienda.false
:: La acción de evasión no se pone en pausa para que se activen eventos para esta tienda.Pone en pausa los eventos de la tienda para que no se active ningún evento. Esta función no requiere parámetros y no devuelve ningún valor.
Quita un par clave/valor de la tienda.
Cuando se elimina una clave, la función déclencheur el evento data
. Los datos de 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 "remove".
Opcionalmente, puede evitar la activación del evento data
.
key
: (String) El nombre de la clave que se va a quitar.options
: (Objeto) Un objeto de opciones. Las siguientes propiedades de objeto son válidas:
true
evita la activación del evento data
. El valor predeterminado es false
.Un valor boolean
:
true
indica que se ha quitado el par clave/valor.false
indica que el almacén de datos no ha cambiado porque la clave no se encontró en el almacén.Elimina una referencia de la tienda.
key
: La referencia clave que se va a quitar. Este parámetro corresponde al parámetro key
de la función addReference
.Un valor boolean
:
true
indica que se ha quitado la referencia.false
indica que la clave no es válida y que el almacén no ha cambiado.Restablece los valores iniciales de los datos persistentes del almacén. Opcionalmente, puede eliminar todos los demás datos de la tienda. El evento se pone en pausa para esta tienda mientras se restablece la tienda. Esta función no devuelve ningún valor.
Los valores iniciales se proporcionan en la propiedad initialValues
del objeto config que se utiliza para crear instancias del objeto store.
keepRemainingData
:: (Boolean) Un valor true hace que los datos no iniciales se mantengan. Un valor false hace que se eliminen todos los datos excepto los valores iniciales.Recupera una clave a la que se hace referencia. Opcionalmente, puede especificar el número de iteraciones que se utilizarán para resolver la mejor coincidencia.
key
: (String) La clave para la que se resuelve la referencia. Este parámetro key
se corresponde con el parámetro key
de la función addReference
.retry
: (Número) El número de iteraciones que se van a utilizar.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
.
Reanuda el evento de esta tienda para que se activen eventos. Esta función no define parámetros y no devuelve ningún valor.
Añade un par clave/valor en la tienda.
Déclencheur el evento data
sólo si el valor de la clave es diferente al valor que está almacenado actualmente para la clave. Opcionalmente, puede evitar la activación del evento data
.
Los datos de evento incluyen el nombre del almacén, la clave, el valor anterior, el nuevo valor y el tipo de acción set
.
key
: (String) El nombre de la clave.options
: (Objeto) Un objeto de opciones. Las siguientes propiedades de objeto son válidas:
silent
:: Un valor de true
impide el desencadenamiento del data
evento. El valor predeterminado es false
.value
: (Objeto) El valor que se va a asociar a la clave.Un valor boolean
:
true
indica que se almacenó el objeto de datos.false
indica que el almacén de datos no ha cambiado.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
cuando cree una instancia de esta clase.
La tienda utiliza la resistencia 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.
Configura los detalles para la conexión al servicio JSONP que utiliza este objeto. Puede actualizar o reemplazar la configuración existente. La función no devuelve ningún valor.
serviceConfig
: Un objeto que contiene las siguientes propiedades:
host
:: (Cadena) El nombre del servidor o la dirección IP.jsonp
:: (Boolean) Un valor true indica que el servicio es un servicio JSONP; en caso contrario, false. Cuando es true, la llamada de retorno {callback: "ContextHub.Callback.El objeto Object.name} se agrega al objeto service.params.params
:: (Objeto) Parámetros URL 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
:: (Cadena) La ruta al servicio.port
:: (Número) El número de puerto del servicio.secure
:: (Cadena o Booleano) Determina el protocolo que se usará para la dirección URL del servicio:
auto
: //true
: https://false
: sesión administrada de pantalla blanca http://true
hace que la configuración de servicio existente se reemplace por las propiedades de serviceConfig
. Un valor de false
hace que las propiedades de configuración de 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.
Objeto que representa la respuesta sin procesar.
Recupera el objeto de servicio para este objeto ContextHub.Store.JSONPStore. El objeto service contiene toda la información necesaria para crear la dirección URL del servicio.
Un objeto con las siguientes propiedades:
host
: (Cadena) El nombre del servidor o la dirección IP.jsonp
: (Booleano) Un valor true indica que el servicio es un servicio JSONP; en caso contrario, false. Cuando es true, la llamada de retorno {callback: "ContextHub.Callback.El objeto Object.name} se agrega al objeto service.params.params
: (Objeto) Parámetros URL 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) La ruta al servicio.port
: (Número) El número de puerto del servicio.secure
: (Cadena o Booleano) Determina el protocolo que se utilizará para la dirección URL del servicio:
auto
:: //true
:: https://false
: sesión administrada de pantalla blanca http://Recupera la dirección URL del servicio JSONP.
resolve
: (Booleano) Determina si se incluyen parámetros resueltos en la dirección URL. Un valor de true
resuelve los parámetros y false
no.Un valor string
que representa la dirección URL del servicio.
inicializa el objeto ContextHub.Store.JSONPStore
.
name
: (Cadena) El nombre de la tienda.config
: (Object) Objeto que contiene la propiedad service. El objeto JSONPStore utiliza las propiedades del objeto service
para construir la dirección URL del servicio JSONP:
eventDeferring
:: 32.eventing
:: El objeto ContextHub.Utils.Eventing para esta tienda. El valor predeterminado es el objeto ContextHub.eventing
.persistence
:: El objeto ContextHub.Utils.Persistence de esta tienda. De forma predeterminada, se utiliza la persistencia de memoria (objeto Javascript).service
: (Objeto)
host
:: (Cadena) El nombre del servidor o la dirección IP.jsonp
:: (Boolean) Un valor true indica que el servicio es un servicio JSONP; en caso contrario, false. Cuando es true, el objeto {callback: "ContextHub.Callbacks.*Object.name*}
se agrega a service.params
.params
:: (Objeto) Parámetros URL representados como propiedades de objeto. Los nombres y valores de los parámetros son los nombres y valores de las propiedades de los objetos, respectivamente.path
:: (Cadena) La ruta al servicio.port
:: (Número) El número de puerto del servicio.secure
:: (Cadena o Booleano) Determina el protocolo que se usará para la dirección URL del servicio:
auto
:: //true
:: https://false
: sesión administrada de pantalla blanca http://timeout
:: (Número) La cantidad de tiempo que se debe esperar 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 función queryService).Consulta el servicio JSONP remoto y almacena en caché la respuesta. Si la cantidad de tiempo desde la llamada anterior a esta función es menor que el valor de config.service.ttl
, no se llama al servicio y no se cambia la respuesta en caché. Opcionalmente, puede forzar la llamada del servicio. La propiedad config.service.ttl
se establece al llamar a la función init para inicializar el almacén.
Déclencheur el evento listo cuando la consulta haya finalizado. Si la URL del servicio JSONP no está configurada, la función no hace nada.
reload
: (Boolean) Un valor true elimina la respuesta en caché y fuerza la llamada al servicio JSONP.Restaura los valores iniciales de los datos persistentes del almacén y, a continuación, llama al servicio JSONP. Opcionalmente, puede eliminar todos los demás datos de la tienda. El evento se pone en pausa 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 config que se utiliza para crear una instancia del objeto store.
keepRemainingData
: (Booleano) Un valor true hace que se mantengan los datos no iniciales. Un valor false hace que se eliminen todos los datos excepto los valores iniciales.Resuelve el parámetro dado.
ContextHub.Store.PersistedJSONPStore
amplía ContextHub.Store. JSONPStorso para heredar todas las funciones de esa clase. Sin embargo, los datos recuperados del servicio JSONP se mantienen según la configuración de la persistencia de ContextHub. (Consulte Modos de persistencia:)
ContextHub.Store.PersistedStore
amplía ContextHub.Store. Coreso hereda todas las funciones de esa clase. Los datos de este almacén se conservan según la configuración de la persistencia de ContextHub.
ContextHub.Store.SessionStore
amplía ContextHub.Store. Coreso hereda todas las funciones de esa clase. Los datos de este almacén se conservan mediante la resistencia en memoria (objeto Javascript).
Gestiona los módulos de interfaz de usuario y los procesadores de módulos de interfaz de usuario.
Registra un procesador de módulos de interfaz de usuario con ContextHub. Una vez registrado el procesador, se puede utilizar para crear módulos de interfaz de usuario. Utilice esta función cuando extienda ContextHub.UI.BaseModuleRenderer
para crear un procesador de módulos de interfaz de usuario personalizado.
moduleType
: (String) El identificador del procesador de módulos 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.renderer
: (String) El nombre de la clase que procesa el módulo de la interfaz de usuario.dontRender
: (Booleano) Se establece en true
para evitar que la interfaz de usuario de ContextHub se procese después de registrar el procesador. El valor predeterminado es false
.En el ejemplo siguiente se registra un procesador como el tipo de módulo contexthub.browserinfo
.
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());
Clase de utilidad para interactuar con cookies.
Determina si existe una cookie.
key
: Un archivo String
que contiene la clave de la cookie para la que está realizando la prueba.Un valor boolean
de true indica que la cookie existe.
if (ContextHub.Utils.Cookie.exists("name")) {
// conditionally-executed code
}
Devuelve todas las cookies que tienen claves que coinciden con un filtro.
filter
: (Opcional) Criterios para coincidencia de claves de cookie. Para devolver todas las cookies, especifique ningún valor. Se admiten los siguientes tipos:
Objeto de cookies. Las propiedades de objeto son claves de cookie y los valores clave son valores de cookie.
ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])
Devuelve un valor de cookie.
key
: La clave de la cookie para la que desea el valor.El valor de la cookie o null
si no se encontró ninguna cookie para la clave.
ContextHub.Utils.Cookie.getItem("name");
Devuelve una matriz de las claves de las cookies existentes que coinciden con un filtro.
filter
: Criterios para coincidencia de claves de cookie. Se admiten los siguientes tipos:
true
si la prueba confirma una coincidencia.Matriz de cadenas donde cada cadena es la clave de una cookie que coincide con el filtro.
ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])
Elimina 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.
key
: Un String
valor que representa la clave de la cookie que se va a eliminar.options
: Objeto que contiene valores de propiedad para configurar los atributos de cookie. Consulte la función setItem
para obtener más información. La propiedad expires
no tiene ningún efecto.Esta función no devuelve un valor.
ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);
Crea una cookie de la clave y el valor dados y la agrega al documento actual. De forma opcional, puede especificar opciones para configurar los atributos de la cookie.
key
: Una cadena que contiene la clave de la cookie.value
: Una cadena que contiene el valor de la cookie.options
: (Opcional) Objeto que contiene cualquiera de las siguientes propiedades que configuran los atributos de cookie:
expires
:: Un date
valor number
o 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 en la hora actual más el número. El valor predeterminado es undefined
.secure
:: Un boolean
valor que especifica el Secure
atributo de la cookie. El valor predeterminado es false
.path
:: Un String
valor que se usará como Path
atributo de la cookie. El valor predeterminado es undefined
.La cookie con el valor establecido.
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
.
filter
: El filter
argumento que se usará en la llamada a la getKeys
función.options
: El options
argumento que se usará en la llamada a la removeItem
función.Esta función no devuelve un valor.
Permite enlazar y desenlazar funciones a eventos de la tienda de ContextHub. Obtenga acceso a los objetos ContextHub.Utils.Eventing
de una tienda mediante la propiedad eventing de la tienda.
Desenlaza una función de un evento.
name
: El nombre del evento para el que está desenlazando la función.selector
: El selector que identifica el enlace. (Consulte el parámetro selector
para las funciones on
y once
).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. Opcionalmente, la función se puede llamar para eventos que hayan ocurrido en el pasado, antes de que se establezca el enlace.
name
: (Cadena) El nombre del evento al que está enlazando la función.handler
: (Función) La función que se va a enlazar al evento.selector
: (String) Un identificador único para el enlace. Necesita el selector para identificar el enlace si desea utilizar la función off
para quitar el enlace.triggerForPastEvents
: (Booleano) Indica si el controlador debe ejecutarse para 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 futuros eventos. El valor predeterminado es true
.Cuando el argumento triggerForPastEvents
es true
, esta función devuelve un valor boolean
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 ha ocurrido en el pasado.Si triggerForPastEvents
es false
, esta función no devuelve ningún valor.
El ejemplo siguiente 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 una sola vez, para la primera incidencia del evento. Opcionalmente, la función se puede llamar para el evento que se ha producido en el pasado, antes de que se establezca el enlace.
name
: (Cadena) El nombre del evento al que está enlazando la función.handler
: (Función) La función que se va a enlazar al evento.selector
: (String) Un identificador único para el enlace. Necesita el selector para identificar el enlace si desea utilizar la función off
para quitar el enlace.triggerForPastEvents
: (Booleano) Indica si el controlador debe ejecutarse para 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 futuros eventos. El valor predeterminado es true
.Cuando el argumento triggerForPastEvents
es true
, esta función devuelve un valor boolean
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 ha ocurrido en el pasado.Si 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 los métodos de otro objeto.
child
: (Objeto) El objeto que hereda.parent
: (Objeto) El objeto que define las propiedades y los métodos heredados.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.
data
: Un valor de cadena en formato JSON.Un objeto Javascript.
El código:
ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");
Devuelve el siguiente objeto:
Object {
city: "Basel",
country: "Switzerland",
population: 173330
}
Serializa los valores y objetos de JavaScript en valores de cadena de formato JSON.
data
: El valor u objeto que se va a serializar. Esta función admite valores booleanos, de matriz, de número, de cadena y de fecha.El valor de la cadena serializada. Cuando data
es un valor R egExp
, esta función devuelve un objeto vacío. Cuando data
es una función, devuelve undefined
.
El siguiente código:
ContextHub.Utils.JSON.stringify({
city: "Basel",
country: "Switzerland",
population: 173330
});
Devuelve:
"{'city':'Basel','country':'Switzerland','population':'173330'}":
Esta clase facilita la manipulación de 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 desde 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.
tree
: El objeto que se copia.secondTree
: El objeto que se combina con la copia del tree
objeto.Objeto que contiene los datos combinados.
Crea una copia de un objeto, busca y elimina los elementos del árbol de datos que no contienen valores, valores nulos o valores no definidos, y devuelve la copia.
tree
: El objeto que se va a limpiar.Una copia del árbol que se limpia.
Recupera el valor de un objeto para una clave.
tree
: El objeto de datos.key
: La clave del valor que desea recuperar.El valor que corresponde a la clave. Cuando la clave tiene claves secundarias, esta función devuelve un objeto complejo. Cuando el tipo de valor de la clave es undefined
, se devuelve null
.
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, solo puede recuperar las claves de los elementos secundarios de una clave específica. También puede especificar de forma opcional un orden de las claves recuperadas.
tree
: El objeto desde el que se recuperan las claves del árbol de datos.parent
: (Opcional) La clave de un elemento del árbol de datos para el que desea recuperar las claves de los elementos secundarios.order
: (Opcional) Una función que determina el orden de clasificación de las claves devueltas. (Consulte Array.prototype.sort
en Mozilla Developer Network.)Matriz de claves.
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
}
}
La secuencia de comandos 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"]
Crea una copia de un objeto determinado, quita la rama especificada del árbol de datos y devuelve la copia modificada.
tree
: Un objeto de datos.key
: La tecla que se va a quitar.Una copia del objeto de datos original con la clave eliminada.
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 /one/two/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"
}
}
Sanitiza 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.
key
: El string
sanitizar.Matriz de valores string
donde cada cadena es la porción del key
que se delimitó mediante barras diagonales. representa la clave saneada. Si la matriz saneada tiene una longitud de cero, esta función devuelve null
.
El siguiente código elimina 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("/");
Añade un par clave/valor en el árbol de datos de una copia de un objeto. Para obtener información sobre los árboles de datos, consulte Persistencia.
tree
: Un objeto de datos.key
: La clave para asociar con el valor que está agregando. La clave es la ruta del elemento en el árbol de datos. Esta función llama a ContextHub.Utils.JSON.tree.sanitize
para sanear la clave antes de agregarla.value
: El valor que se va a agregar al árbol de datos.Una copia del objeto tree
que incluye el par key
/ value
.
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);
Le permite registrar candidatos para tiendas y obtener candidatos para tiendas registradas.
Devuelve los tipos de tienda registrados como candidatos de tienda. Puede recuperar los candidatos registrados de un tipo de tienda específico o de todos los tipos de tienda.
storeType
: (Cadena) El nombre del tipo de tienda. Consulte el parámetro storeType
de la función ContextHub.Utils.storeCandidates.registerStoreCandidate
.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 tienda 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.
storeType
:: (Cadena) El nombre del candidato de la tienda. Consulte el parámetro storeType
de la función ContextHub.Utils.storeCandidates.registerStoreCandidate
.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 tienda registrados como candidatos de tienda. Esta función no requiere parámetros.
Matriz de valores de cadena, donde cada cadena es el tipo de tienda con el que se registró un candidato a la tienda. Consulte el parámetro storeType
de la función ContextHub.Utils.storeCandidates.registerStoreCandidate
.
Registra un objeto de almacén como candidato de almacén con 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 mayor prioridad. Cuando se registra un candidato a tienda, la tienda se registra solo si la prioridad es mayor que la de los candidatos a tiendas registradas con el mismo nombre.
store
: (Objeto) El objeto store que se va a registrar como candidato de tienda.storeType
: (Cadena) El nombre del candidato de la tienda. Este valor es necesario cuando se crea una instancia del candidato de la tienda.priority
: (Número) La prioridad del candidato de la tienda.applies
: (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
en caso contrario. El valor predeterminado es una función que devuelve true: function() {return true;}
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
'contexthub.mystorecandiate', 0);