Show Menu
TEMAS×

Referencia de la API de JavaScript de ContextHub

La API de JavaScript de ContextHub está disponible para las secuencias de comandos cuando se ha agregado el componente ContextHub a la página .

Constantes de ContextHub

Valores constantes que define la API de JavaScript de ContextHub.

Constantes de evento

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

Constantes de Evento de la interfaz de usuario

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

Referencia de la API de JavaScript de ContextHub

El objeto ContextHub proporciona acceso a todas las tiendas.

Funciones (ContextHub)

getAllStores()

Devuelve todos los almacenes de ContextHub registrados.
Esta función no tiene parámetros.
Devuelve
Objeto que contiene todos los almacenes de ContextHub. Cada tienda es un objeto que utiliza el mismo nombre que la tienda.
Ejemplo
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

getStore(name)

Recupera una tienda como un objeto Javascript.
Parámetros
  • name :: El nombre con el que se registró la tienda.
Devuelve
Objeto que representa la tienda.
Ejemplo
El ejemplo siguiente recupera el almacén de geolocalización:
var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment

Representa un segmento de ContextHub. Utilice el 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 ContextHub.SegmentEngine.Segment objetos.

ContextHub.Store.Core

La clase base de las tiendas de ContextHub.

Propiedades (ContextHub.Store.Core)

evento

Un ContextHub.Utils.Eventing objeto. 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) .

name

El nombre de la tienda.

persistencia

Un ContextHub.Utils.Persistence objeto. Para obtener información sobre el valor predeterminado y la inicialización, consulte init(name,config) .

Funciones (ContextHub.Store.Core)

addAllItems(tree, options)

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 (a través de la setItem función):
  • Objeto: Las claves son los nombres de las propiedades.
  • Matriz: Las claves son los índices de matriz.
Tenga en cuenta que los valores pueden ser objetos.
Parámetros
  • tree :: (Objeto o matriz) Los datos que se van a agregar al almacén.
  • options :: (Objeto) Objeto opcional de opciones que se pasa a la función setItem. Para obtener más información, consulte el options parámetro de setItem(key,value,options) .
Devuelve
Un boolean valor:
  • Un valor de true indica que se almacenó el objeto de datos.
  • Un valor de false indica que el almacén de datos no ha cambiado.

addReference(key, anotherKey)

Crea una referencia de una clave a otra. Una clave no se puede hacer referencia a sí misma.
Parámetros
  • key :: Clave a la que se hace referencia anotherKey .
  • anotherkey :: Clave a la que hace referencia key .
Devuelve
Un boolean valor:
  • Un valor de true indica que se agregó la referencia.
  • Un valor de false indica que no se agregó ninguna referencia.

publishReadiness()

Activa el ready evento de 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
  • key :: (Cadena) La clave para la que se devuelve el valor.
Devuelve
Objeto que representa el valor de la clave.

getKeys(includeInternals)

Recupera las claves de la tienda. Opcionalmente, puede recuperar las claves que utiliza internamente el marco 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
Matriz de nombres de clave ( string valores).

getReferences()

Recupera las referencias de la tienda.
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 el key parámetro de la addReference función.
  • Las claves a las que se hace referencia corresponden con el anotherKey parámetro de la 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 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 .
Devuelve
Objeto que representa el árbol de datos. Las claves son los nombres de propiedad del objeto.

init(name, config)

Inicializa la tienda.
  • Establece los datos de almacenamiento en un objeto vacío.
  • Establece las referencias de almacenamiento en un objeto vacío.
  • El eventChannel es data:<name> , donde <name> es el nombre de la tienda.
  • El storeDataKey es /store/<name> , donde <name> es el nombre de la tienda.
Parámetros
  • name :: El nombre de la tienda.
  • config :: Objeto que contiene propiedades de configuración:
    • eventDeferring : El valor predeterminado es 32.
    • eventing :: El objeto ContextHub.Utils.Eventing de esta tienda. El valor predeterminado es el que utiliza el ContextHub.eventing objeto.
    • persistence :: El ContextHub.Utils.Persistence objeto de esta tienda. El valor predeterminado es el ContextHub.persistence objeto.

isEventingPaused()

Determina si el evento está en pausa para esta tienda.
Devuelve
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.

pauseEventing()

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.

removeItem(key, options)

Quita un par clave/valor de la tienda.
Cuando se elimina una clave, la función activa el data evento. 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 que se active el data evento.
Parámetros
  • key :: (Cadena) El nombre de la clave que se va a quitar.
  • options :: (Objeto) Objeto de opciones. Las siguientes propiedades de objeto son válidas:
    • silencioso: Un valor de true impide el desencadenamiento del data evento. El valor predeterminado es false .
Devuelve
Un boolean valor:
  • Un valor de true indica que se ha eliminado el par clave/valor.
  • Un valor de false indica que el almacén de datos no ha cambiado porque la clave no se encontró en el almacén.

removeReference(key)

Elimina una referencia de la tienda.
Parámetros
  • key :: La referencia clave que se va a eliminar. Este parámetro corresponde al key parámetro de la addReference función.
Devuelve
Un boolean valor:
  • Un valor de true indica que se ha eliminado la referencia.
  • Un valor de false indica que la clave no era válida y que el almacén no ha cambiado.

reset(keepReminningData)

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 initialValues propiedad del objeto config que se utiliza para crear instancias del objeto store.
Parámetros
  • 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.

resolveReference(key, reintentar)

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.
Parámetros
  • key :: (Cadena) La clave para la que se resuelve la referencia. Este key parámetro corresponde al key parámetro de la addReference función.
  • retry :: (Número) El número de iteraciones que se van a utilizar.
Devuelve
Un string valor que representa la clave a la que se hace referencia. Si no se resuelve ninguna referencia, se devuelve el valor del key parámetro.

resumeEventing()

Reanuda el evento de esta tienda para que se activen eventos. Esta función no define parámetros y no devuelve ningún valor.

setItem(key, value, options)

Añade un par clave/valor en la tienda.
Activa el data evento solo si el valor de la clave es diferente al valor que está almacenado actualmente para la clave. De forma opcional, puede evitar que se active el data evento.
Los datos de 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
  • key :: (Cadena) El nombre de la clave.
  • options :: (Objeto) 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.
Devuelve
Un boolean valor:
  • Un valor de true indica que se almacenó el objeto de datos.
  • Un valor de false indica que el almacén de datos no ha cambiado.

ContextHub.Store.JSONPStore

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 init función 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.

Funciones (ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

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.
Parámetros
  • serviceConfig :: 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://
  • override: (Booleano). Un valor de 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 .

getRawResponse()

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

getServiceDetails()

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.
Devuelve
Un objeto con 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://

getServiceURL(resolve)

Recupera la dirección URL del servicio JSONP.
Parámetros
  • 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 resuelve.
Devuelve
Un string valor que representa la dirección URL del servicio.

init(name, config)

inicializa el ContextHub.Store.JSONPStore objeto.
Parámetros
  • name :: (Cadena) El nombre de la tienda.
  • config :: (Objeto) Objeto que contiene la propiedad service. El objeto JSONPStore utiliza las propiedades del service objeto para construir la URL del servicio JSONP:
    • eventDeferring : 32.
    • eventing :: El objeto ContextHub.Utils.Eventing para esta tienda. El valor predeterminado es el ContextHub.eventing objeto.
    • 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, se agrega el {callback: "ContextHub.Callbacks.*Object.name*} objeto 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 ).

queryService(reload)

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 config.service.ttl propiedad se establece al llamar a la función init para inicializar la tienda.
Activa el evento listo cuando la consulta ha finalizado. Si la URL del servicio JSONP no está configurada, la función no hace nada.
Parámetros
  • reload :: (Boolean) Un valor true elimina la respuesta en caché y fuerza la llamada al servicio JSONP.

reset

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.
Parámetros
  • 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.

resolveParameter(f)

Resuelve el parámetro dado.

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedJSONPStore amplía ContextHub.Store.JSONPStore para que hereda 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

ContextHub.Store.PersistedStore amplía ContextHub.Store.Core para que 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

ContextHub.Store.SessionStore amplía ContextHub.Store.Core para que hereda todas las funciones de esa clase. Los datos de este almacén se conservan mediante la resistencia en memoria (objeto Javascript).

ContextHub.UI

Gestiona los módulos de interfaz de usuario y los procesadores de módulos de interfaz de usuario.

Funciones (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

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 se extienda para crear un procesador de módulos de interfaz de usuario personalizado.
Parámetros
  • moduleType :: (Cadena) 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 :: (Cadena) El nombre de la clase que procesa el módulo de 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 .
Ejemplo
En el ejemplo siguiente se registra un procesador como tipo de contexthub.browserinfo módulo.
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Eventing

Permite enlazar y desenlazar funciones a eventos de la tienda de ContextHub. Acceda a ContextHub.Utils.Eventing los objetos de una tienda mediante la propiedad eventing de la tienda.

Funciones (ContextHub.Utils.Eventing)

off(name, selector)

Desenlaza una función de un evento.
Parámetros
  • name :: El nombre del evento para el que está desenlazando la función.
  • selector :: Selector que identifica el enlace. (Consulte el selector parámetro de las on funciones y once ).
Devuelve
Esta función no devuelve ningún valor.

on(nombre, controlador, selector, desencadenadorForPastEvents)

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.
Parámetros
  • 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 :: (Cadena) Un identificador único para el enlace. Necesita el selector para identificar el enlace si desea utilizar la off función 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 .
Devuelve
Cuando el triggerForPastEvents argumento es true , esta función devuelve un boolean valor que indica si el evento se ha producido 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.
Ejemplo
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>

once(nombre, controlador, selector, desencadenadorForPastEvents)

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.
Parámetros
  • 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 :: (Cadena) Un identificador único para el enlace. Necesita el selector para identificar el enlace si desea utilizar la off función 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 .
Devuelve
Cuando el triggerForPastEvents argumento es true , esta función devuelve un boolean valor que indica si el evento se ha producido 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.

ContextHub.Utils.herencia

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

Funciones (ContextHub.Utils.herencia)

inherit(child, parent)

Hace que un objeto herede las propiedades y los métodos de otro objeto.
Parámetros
  • child :: (Objeto) El objeto que hereda.
  • parent :: (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(data)

Analiza un valor de cadena como JSON y lo convierte en un objeto javascript.
Parámetros
  • data :: 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 siguiente objeto:
Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data)

Serializa los valores y objetos de JavaScript en valores de cadena de formato JSON.
Parámetros
  • data :: Valor u objeto que se va a serializar. Esta función admite valores booleanos, de matriz, de número, de cadena y de fecha.
Devuelve
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 .
Ejemplo
El siguiente código:
ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

Devuelve:
"{'city':'Basel','country':'Switzerland','population':'173330'}":

ContextHub.Utils.JSON.tree

Esta clase facilita la manipulación de 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 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.
Parámetros
  • tree :: 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 elimina los elementos del árbol de datos que no contienen valores, valores nulos o valores no definidos, y devuelve la copia.
Parámetros
  • tree :: El objeto que se va a limpiar.
Devuelve
Una copia del árbol que se limpia.

getItem()

Recupera el valor de un objeto para una clave.
Parámetros
  • tree :: El objeto de datos.
  • key :: 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 se devuelve el tipo de valor de la clave undefined , null .
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, 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.
Parámetros
  • 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) Función que determina el orden de clasificación de las claves devueltas. (Consulte Array.prototype.sort en Mozilla Developer Network.)
Devuelve
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
  }
}

La ContextHub.Utils.JSON.tree.getKeys(myObject); secuencia de comandos 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
  • tree :: Un objeto de datos.
  • key :: Clave que se va a quitar.
Devuelve
Una copia del objeto de datos original con la clave eliminada.
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 /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"
  }
}

sanitizeKey(key)

Sanitiza 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 diagonal.
  • Elimina los espacios en blanco del principio y del final de la cadena.
  • Divide el resultado en una matriz de cadenas que están delimitadas por barras diagonales.
Utilice la matriz resultante para crear una clave utilizable.
Parámetros
  • key :: El string para sanear.
Devuelve
Matriz de string valores en la que cada cadena es la porción de la key que se delimita con barras diagonales. representa la clave saneada. Si la matriz saneada tiene una longitud de cero, esta función devuelve null .
Ejemplo
El siguiente código sanitica una cadena para producir la matriz ["this", "is", "a", "path"] y, a continuación, genera la clave "/this/is/a/path" de la matriz:
var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value)

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.
Parámetros
  • tree :: Un objeto de datos.
  • key :: La clave que se asociará al valor que se está agregando. La clave es la ruta del elemento en el árbol de datos. Esta función llama ContextHub.Utils.JSON.tree.sanitize a sanear la clave antes de agregarla.
  • value :: Valor que se va a agregar al árbol de datos.
Devuelve
Una copia del tree objeto que incluye el par key / value .
Ejemplo
Considere el siguiente código Javascript:
var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

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

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

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

ContextHub.Utils.storeCandidate

Le permite registrar candidatos para tiendas y obtener candidatos para tiendas registradas.

Funciones (ContextHub.Utils.storeCandidate)

getRegisteredCandidate(storeType)

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.
Parámetros
Devuelve
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.

getStoreFromCandidate(storeType)

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.
Parámetros
Devuelve
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 tienda registrados como candidatos de tienda. Esta función no requiere parámetros.
Devuelve
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 storeType parámetro de la ContextHub.Utils.storeCandidates.registerStoreCandidate función.

registerStoreCandidate(store, storeType, priority, apply)

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.
Parámetros
  • store :: (Objeto) El objeto store que se va a registrar como candidato de almacén.
  • 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 del almacén.
  • applies :: (Función) 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 la tienda es aplicable y false de otro modo. El valor predeterminado es una función que devuelve true: function() {return true;}
Ejemplo
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);