Referência de API do Javascript do ContextHub contexthub-javascript-api-reference

A API Javascript do ContextHub está disponível para seus scripts quando a variável O componente ContextHub foi adicionado à página.

Constantes do ContextHub contexthub-constants

Valores constantes que a API Javascript do ContextHub define.

Constantes do evento event-constants

A tabela a seguir lista os nomes dos eventos que ocorrem para as lojas do ContextHub. Consulte também ContextHub.Utils.Eventing.

Constantes de evento da interface do usuário ui-event-constants

A tabela a seguir lista os nomes dos eventos que ocorrem para a interface do usuário do ContextHub.

Referência de API do Javascript do ContextHub contexthub-javascript-api-reference-2

O objeto ContextHub fornece acesso a todos os armazenamentos.

Funções (ContextHub) functions-contexthub

getAllStores() getallstores

Retorna todos os armazenamentos registrados do ContextHub.

Essa função não tem parâmetros.

Devoluções

Um objeto que contém todos os armazenamentos do ContextHub. Cada loja é um objeto que usa o mesmo nome da loja.

Exemplo

O exemplo a seguir recupera todos os armazenamentos e recupera o armazenamento de geolocalização:

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

getStore(name) getstore-name

Recupera uma loja como um objeto Javascript.

Parâmetros

Devoluções

Um objeto que representa o armazenamento.

Exemplo

O exemplo a seguir recupera o armazenamento de geolocalização:

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

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Representa um segmento do ContextHub. Use o ContextHub.SegmentEngine.SegmentManager para obter segmentos.

Funções (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

Retorna o nome do segmento como um valor de String.

getPath() getpath

Retorna o caminho do repositório da definição do segmento como um valor de String.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Fornece acesso aos segmentos do ContextHub.

Funções (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

Retorna os segmentos que são resolvidos no contexto atual. Essa função não tem parâmetros.

Devoluções

Uma matriz de objetos ContextHub.SegmentEngine.Segment.

ContextHub.Store.Core contexthub-store-core

A classe base dos armazenamentos do ContextHub.

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

evento eventing

A ContextHub.Utils.Eventing objeto. Use esse objeto para vincular funções a fim de armazenar eventos. Para obter informações sobre o valor padrão e a inicialização, consulte init(name,config).

name name

O nome da loja.

persistência persistence

Um objeto ContextHub.Utils.Persistence. Para obter informações sobre o valor padrão e a inicialização, consulte init(name,config).

Funções (ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

Une um objeto de dados ou uma matriz aos dados da loja. Cada par de chave/valor no objeto ou na matriz é adicionado ao armazenamento (por meio do setItem função):

Observe que os valores podem ser objetos.

Parâmetros

Devoluções

A boolean valor:

addReference(key, anotherKey) addreference-key-anotherkey

Cria uma referência de uma chave para outra chave. Uma chave não pode fazer referência a si mesma.

Parâmetros

Devoluções

A boolean valor:

advertisingReadiness() announcereadiness

Dispara o ready para esta loja. Essa função não tem parâmetros e não retorna valor.

clean() clean

Remove todos os dados do armazenamento. A função não tem parâmetros e nenhum valor de retorno.

getItem(key) getitem-key

Retorna o valor associado a uma chave.

Parâmetros

Devoluções

Um Objeto que representa o valor da chave.

getKeys(includeInternals) getkeys-includeinternals

Recupera as chaves da loja. Opcionalmente, é possível recuperar as chaves usadas internamente pela estrutura do ContextHub.

Parâmetros

Devoluções

Uma matriz de nomes de chaves ( string valores).

getReferences() getreferences

Recupera as referências da loja.

Devoluções

Uma matriz que usa chaves de referência como índices para as chaves referenciadas:

getTree(includeInternals) gettree-includeinternals

Recupera a árvore de dados do armazenamento. Opcionalmente, é possível incluir os pares chave/valor usados internamente pela estrutura do ContextHub.

Parâmetros

Devoluções

Um objeto que representa a árvore de dados. As chaves são os nomes de propriedade do objeto.

init(name, config) init-name-config

Inicializa o armazenamento.

Parâmetros

isEventingPaused() iseventingpaused

Determina se o evento está pausado para esta loja.

Devoluções

Um valor booleano:

pauseEventing() pauseeventing

Pausa o evento para a loja para que nenhum evento seja acionado. Essa função não requer parâmetros e não retorna valor.

removeItem(key, options) removeitem-key-options

Remove um par de chave/valor do armazenamento.

Quando uma chave é removida, a função aciona a variável data evento. Os dados do evento incluem o nome do armazenamento, o nome da chave que foi removida, o valor que foi removido, o novo valor para a chave (nulo) e o tipo de ação "remover".

Como opção, você pode impedir o acionamento da variável data evento.

Parâmetros

Devoluções

A boolean valor:

removeReference(key) removereference-key

Remove uma referência da loja.

Parâmetros

Devoluções

A boolean valor:

reset(keepRemainingData) reset-keepremainingdata

Redefine os valores iniciais dos dados persistentes do armazenamento. Como opção, você pode remover todos os outros dados do armazenamento. O evento é pausado para esta loja enquanto ela é redefinida. Essa função não retorna valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração que é usado para instanciar o objeto de armazenamento.

Parâmetros

Redefine os valores iniciais dos dados persistentes do armazenamento. Como opção, você pode remover todos os outros dados do armazenamento. O evento é pausado para esta loja enquanto ela é redefinida. Essa função não retorna valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração que é usado para instanciar o objeto de armazenamento.

Parâmetros

resolveReference(key, retry) resolvereference-key-retry

Recupera uma chave referenciada. Como opção, você pode especificar o número de iterações a serem usadas para resolver a melhor correspondência.

Parâmetros

Devoluções

A string que representa a chave referenciada. Se nenhuma referência for resolvida, o valor da variável key é retornado.

resumeEventing() resumeeventing

Retoma o evento para esta loja para que os eventos sejam acionados. Essa função não define parâmetros e não retorna valor.

setItem(key, value, options) setitem-key-value-options

Adiciona um par de chave/valor à loja.

Dispara o data somente se o valor da chave for diferente do valor armazenado para a chave no momento. Opcionalmente, é possível impedir o acionamento da variável data evento.

Os dados do evento incluem o nome da loja, a chave, o valor anterior, o novo valor e o tipo de ação de set.

Parâmetros

Devoluções

A boolean valor:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Um armazenamento que contém dados JSON. Os dados são recuperados de um serviço JSONP externo ou, opcionalmente, de um serviço que retorna dados JSON. Especifique os detalhes do serviço usando o init ao criar uma instância dessa classe.

O armazenamento usa persistência na memória (variável Javascript). Os dados de armazenamento estão disponíveis somente durante a vida útil da página.

ContextHub.Store.JSONPStore estende ContextHub.Store.Core e herda as funções dessa classe.

Funções (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

Configura os detalhes para conexão com o serviço JSONP que este objeto usa. Você pode atualizar ou substituir a configuração existente. A função não retorna valor.

Parâmetros

getRawResponse() getrawresponse

Retorna a resposta bruta armazenada em cache desde a última chamada para o serviço JSONP. A função não requer parâmetros.

Devoluções

Um objeto que representa a resposta bruta.

getServiceDetails() getservicedetails

Recupera o objeto de serviço para este objeto ContextHub.Store.JSONPStore. O objeto de serviço contém todas as informações necessárias para criar o URL de serviço.

Devoluções

Um objeto com as seguintes propriedades:

getServiceURL(resolve) getserviceurl-resolve

Recupera o URL do serviço JSONP.

Parâmetros

Devoluções

A string que representa o URL do serviço.

init(name, config) init-name-config-1

inicializa o objeto ContextHub.Store.JSONPStore .

Parâmetros

queryService(reload) queryservice-reload

Consulta o serviço JSONP remoto e armazena em cache a resposta. Se a quantidade de tempo desde a chamada anterior para essa função for menor que o valor de config.service.ttl, o serviço não é chamado e a resposta em cache não é alterada. Como opção, você pode forçar a chamada do serviço. O config.service.ttlé definida ao chamar a variável init para inicializar o armazenamento.

Aciona o evento ready quando o query for concluído. Se o URL do serviço JSONP não estiver definido, a função não fará nada.

Parâmetros

redefinir reset

Redefine os valores iniciais dos dados persistentes do armazenamento e, em seguida, chama o serviço JSONP. Como opção, você pode remover todos os outros dados do armazenamento. O evento é pausado para esta loja enquanto os valores iniciais são redefinidos. Essa função não retorna valor.

Os valores iniciais são fornecidos na propriedade initialValues do objeto de configuração que é usado para instanciar o objeto de armazenamento.

Parâmetros

resolveParameter(f) resolveparameter-f

Resolve o parâmetro especificado.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore estende ContextHub.Store.JSONPStore portanto, ela herda todas as funções dessa classe. No entanto, os dados recuperados do serviço JSONP são mantidos de acordo com a configuração de persistência do ContextHub. (Consulte Modos de persistência.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

O ContextHub.Store.PersistedStore estende ContextHub.Store.Core portanto, ela herda todas as funções dessa classe. Os dados nesse armazenamento são mantidos de acordo com a configuração da persistência do ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore estende ContextHub.Store.Core portanto, ela herda todas as funções dessa classe. Os dados nesse armazenamento são mantidos com persistência na memória (objeto Javascript).

ContextHub.UI contexthub-ui

Gerencia módulos de interface e renderizadores de módulo de interface do usuário.

Funções (ContextHub.UI) functions-contexthub-ui

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

Registra um renderizador de módulo de interface do usuário com o ContextHub. Depois que o renderizador é registrado, ele pode ser usado para criar módulos de interface. Use esta função quando você extensão do ContextHub.UI.BaseModuleRenderer para criar um renderizador de Módulo de interface do usuário personalizado.

Parâmetros

Exemplo

O exemplo a seguir registra um renderizador como o tipo de módulo contexthub.browserinfo .

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

ContextHub.Utils.Cookie contexthub-utils-cookie

Uma classe de utilitário para interagir com cookies.

Funções (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie

exists(key) exists-key

Determina se um cookie existe.

Parâmetros

Devoluções

A boolean valor true indica que o cookie existe.

Exemplo

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

getAllItems(filter) getallitems-filter

Retorna todos os cookies que têm chaves que correspondem a um filtro.

Parâmetros

Devoluções

Um objeto de cookies. As propriedades do objeto são chaves de cookie e os valores-chave são valores de cookie.

Exemplo

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

getItem(key) getitem-key-1

Retorna um valor de cookie.

Parâmetros

Devoluções

O valor do cookie ou null se nenhum cookie foi encontrado para a chave.

Exemplo

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

getKeys(filter) getkeys-filter

Retorna uma matriz das chaves dos cookies existentes que correspondem a um filtro.

Parâmetros

Devoluções

Uma matriz de strings na qual cada string é a chave de um cookie que corresponde ao filtro.

Exemplo

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

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

Remove um cookie. Para remover o cookie, o valor é definido como uma string vazia e a data de expiração é definida como o dia antes da data atual.

Parâmetros

Devoluções

Essa função não retorna um valor.

Exemplo

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

setItem(key, value, options) setitem-key-value-options-1

Cria um cookie da chave e valor fornecidos e adiciona o cookie ao documento atual. Como opção, você pode especificar opções que configuram os atributos do cookie.

Parâmetros

Devoluções

O cookie com o valor definido.

Exemplo

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

vanish(filter, options) vanish-filter-options

Remove todos os cookies que correspondem a um determinado filtro. Os cookies são combinados usando a função getKeys e removidos usando a função removeItem .

Parâmetros

Devoluções

Essa função não retorna um valor.

ContextHub.Utils.Eventing contexthub-utils-eventing

Permite vincular e desvincular funções a eventos de armazenamento do ContextHub. Acesse os objetos ContextHub.Utils.Eventing de um armazenamento usando a evento da loja.

Funções (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(nome, seletor) off-name-selector

Desvincula uma função de um evento.

Parâmetros

Devoluções

Essa função não retorna valor.

on(name, handler, seletor, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

Vincula uma função a um evento. A função é chamada sempre que o evento ocorre. Como opção, a função pode ser chamada para eventos que ocorreram no passado, antes que o vínculo seja estabelecido.

Parâmetros

Devoluções

Quando a variável triggerForPastEvents argumento é true, essa função retorna um boolean que indica se o evento ocorreu no passado:

If triggerForPastEvents é false, essa função não retorna valor.

Exemplo

O exemplo a seguir vincula uma função ao evento de dados do armazenamento de geolocalização. A função preenche um elemento na página com o valor do item de dados de latitude da loja.

<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(name, handler, seletor, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Vincula uma função a um evento. A função é chamada somente uma vez, para a primeira ocorrência do evento. Como opção, a função pode ser chamada para o evento que ocorreu no passado, antes que o vínculo seja estabelecido.

Parâmetros

Devoluções

Quando a variável triggerForPastEvents argumento é true, essa função retorna um boolean que indica se o evento ocorreu no passado:

If triggerForPastEvents é false, essa função não retorna valor.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Uma classe de utilitário que permite a um objeto herdar as propriedades e os métodos de outro objeto.

Funções (ContextHub.Utils.hereditance) functions-contexthub-utils-inheritance

herdar(filho, pai) inherit-child-parent

Faz com que um objeto herde as propriedades e os métodos de outro objeto.

Parâmetros

ContextHub.Utils.JSON contexthub-utils-json

Fornece funções para serializar objetos no formato JSON e desserializar cadeias JSON em objetos.

Funções (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(data) parse-data

Analisa um valor de string como JSON e o converte em um objeto javascript.

Parâmetros

Devoluções

Um objeto Javascript.

Exemplo

O código ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); retorna o seguinte objeto:

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

stringify(data) stringify-data

Serializa valores e objetos Javascript em valores de string de formato JSON.

Parâmetros

Devoluções

O valor da string serializada. When data é um R egExp , essa função retorna um objeto vazio. When data é uma função, retorna undefined.

Exemplo

O código a seguir retorna "{'city':'Basel','country':'Switzerland','population':'173330'}":

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

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

Essa classe facilita a manipulação de objetos de dados que serão armazenados ou recuperados de armazenamentos do ContextHub.

Funções (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

Cria uma cópia de um objeto de dados e adiciona a ele a árvore de dados de um segundo objeto. A função retorna a cópia e não modifica nenhum dos objetos originais. Quando as árvores de dados dos dois objetos contêm chaves idênticas, o valor do segundo objeto substitui o valor do primeiro objeto.

Parâmetros

Devoluções

Um objeto que contém os dados unidos.

cleanup() cleanup

Cria uma cópia de um objeto, localiza e remove itens na árvore de dados que não contêm valores, valores nulos ou valores indefinidos e retorna a cópia.

Parâmetros

Devoluções

Uma cópia da árvore que é limpa.

getItem() getitem

Recupera o valor de um objeto para a chave a.

Parâmetros

Devoluções

O valor que corresponde à chave. Quando a chave tem chaves secundárias, essa função retorna um objeto complexo. Quando o tipo do valor da chave é undefined, null é retornado.

Exemplo

Considere o seguinte objeto Javascript:

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

O código de exemplo a seguir retorna o valor 260:

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

O código de exemplo a seguir recupera o valor de uma chave que tenha chaves secundárias:

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

A função retorna o seguinte objeto:

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

getKeys() getkeys

Recupera todas as chaves da árvore de dados de um objeto. Como opção, você pode recuperar apenas as chaves dos filhos de uma chave específica. Opcionalmente, também é possível especificar uma ordem de classificação das chaves recuperadas.

Parâmetros

Devoluções

Uma matriz de chaves.

Exemplo

Considere o seguinte objeto:

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

O ContextHub.Utils.JSON.tree.getKeys(myObject); o script retorna a seguinte matriz:

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

removeItem() removeitem

Cria uma cópia de um determinado objeto, remove a ramificação especificada da árvore de dados e retorna a cópia modificada.

Parâmetros

Devoluções

Uma cópia do objeto de dados original com a chave removida.

Exemplo

Considere o seguinte objeto:

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

O script de exemplo a seguir remove a ramificação /um/dois/três/quatro da árvore de dados:

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

A função retorna o seguinte objeto:

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

sanitizeKey(key) sanitizekey-key

Limpa os valores da sequência de caracteres para torná-los utilizáveis como chaves. Para limpar uma string, essa função executa as seguintes ações:

Use a matriz resultante para criar uma chave utilizável. Parâmetros

Devoluções

Uma matriz de string valores em que cada string é a parte da variável key que foi demarcada por barras. representa a chave sanitizada. Se a matriz sanitizada tiver um comprimento de zero, essa função retornará null.

Exemplo

O código a seguir limpa uma string para produzir a matriz ["this", "is", "a", "path"]e então gera a chave "/this/is/a/path" do storage:

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

setItem(tree, key, value) setitem-tree-key-value

Adiciona um par chave/valor à árvore de dados de uma cópia de um objeto. Para obter informações sobre árvores de dados, consulte Persistência.

Parâmetros

Devoluções

Uma cópia do tree que inclui a variável key/ value par.

Exemplo

Considere o seguinte 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);

O objeto myObject tem o seguinte valor:

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Permite registrar candidatos a lojas e obter candidatos a lojas registradas.

Funções (ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Retorna os tipos de loja que são registrados como candidatos de loja. Recupere os predicados registrados de um tipo de armazenamento específico ou de todos os tipos de armazenamento.

Parâmetros

Devoluções

Um objeto de tipos de armazenamento. As propriedades do objeto são os nomes do tipo de armazenamento e os valores da propriedade são uma matriz de candidatos a armazenamento registrado.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Retorna um tipo de armazenamento dos candidatos registrados. Se mais de um tipo de armazenamento do mesmo nome for registrado, a função retornará o tipo de armazenamento com a prioridade mais alta.

Parâmetros

Devoluções

Um objeto que representa o candidato de armazenamento registrado. Se o Tipo de armazenamento solicitado não estiver registrado, um erro será lançado.

getSupportedStoreTypes() getsupportedstoretypes

Retorna os nomes dos tipos de loja que estão registrados como candidatos de loja. Essa função não requer parâmetros.

Devoluções

Uma matriz de valores da string, em que cada string é o tipo de armazenamento com o qual um candidato a loja foi registrado. Consulte a storeType do ContextHub.Utils.storeCandidates.registerStoreCandidate .

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

Registra um objeto de loja como candidato de loja usando um nome e uma prioridade.

A prioridade é um número que indica a importância das lojas com mesmo nome. Quando um candidato de loja é registrado usando o mesmo nome de um candidato de loja já registrado, o candidato com prioridade mais alta é usado. Ao registrar um candidato a loja, a loja é registrada somente se a prioridade for maior que os candidatos a loja registrada com o mesmo nome.

Parâmetros

Exemplo

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