Controlar as camadas do sistema a partir do seu website
Introdução e orientação
Ligue os botões do seu website à navegação entre as camadas do sistema.
Quando utilizar estas funções
Estas funções JavaScript estão disponíveis para o seu website quando é aberto no dispositivo através da aplicação Website. O programador do website, ou o próprio cliente se o desenvolver, pode ligá-las a botões personalizados na página para permitir aos visitantes abrir o menu de aplicações ou passar para a reprodução de campanhas.
Isto é útil para apresentar o website em ecrã inteiro sem os controlos do sistema e integrar a navegação entre camadas no seu próprio desenho. O exemplo mostra um mapa como aplicação predefinida, juntamente com um menu de outras aplicações.

1 — Menu: um botão personalizado abre o menu da camada de aplicações para que os visitantes saiam do mapa e escolham outra aplicação. showLayerBottom
2 — Publicidade: um botão personalizado muda para a camada de apresentação com as campanhas. showLayerTop
Ilustração localizada a partir da captura fornecida. Os textos do menu instalado podem ser diferentes.
Os nomes e o aspeto dos botões são exemplos. O programador ou fornecedor adiciona-os ao website integrado. Para os detalhes de implementação, consulte as funções de navegação e os exemplos de código abaixo.
Abrir o menu exige mais de uma aplicação atualmente disponível; mudar para publicidade exige que a camada de apresentação esteja ativada. Teste sempre a navegação prevista no dispositivo de destino.
A quem se destina este guia e responsabilidades
- O fornecedor da plataforma fornece as funções de navegação do leitor e documenta a sua utilização.
- O cliente seleciona o website apresentado na Website e combina os controlos necessários com o fornecedor.
- O fornecedor ou programador do website integrado altera o próprio website, por exemplo adicionando botões e ligando-os às funções aqui descritas. As instruções técnicas e os exemplos de código deste guia destinam-se a esse fornecedor ou programador. Se desenvolver o website, também assume esta função.
Referência técnica
Guia técnico para programadores web
Ligue os seus botões às funções de navegação do sistema. Comece pelas convenções comuns de chamada e avance para as funções e os exemplos de código.
O leitor fornece estas funções a um website aberto na aplicação Website. Verifique se a função está disponível antes de a chamar, como mostram os exemplos abaixo.
Convenções comuns de chamada
- Pedido:
requesté uma cadeia que contém um objeto JSON vazio. Utilizerequest: '{}', e não o objeto{}em si. - Sucesso:
onSuccessconfirma que o pedido foi aceite, não que a navegação tenha terminado ou que uma campanha específica esteja visível. A resposta não contém dados da aplicação; não baseie decisões no valor deresponse. - Falha: trate
onFailure(error_code, error_message). Os pedidos rejeitados descritos abaixo devolvem o código-1. As mensagens de erro são valores exatos da interface e não devem ser traduzidas.
Funções de navegação disponíveis
onUp
Pede um regresso através da navegação do sistema. O destino depende do modo da aplicação web e do percurso disponível. Não é um regresso ao URL anterior do histórico do navegador nem equivale a window.history.back(). Se não for possível regressar, a função comunica o erro abaixo.
if (typeof window.onUp !== 'function') {
console.warn("A função de navegação do leitor não está disponível.");
} else {
window.onUp({
request: '{}',
onSuccess: function () {
console.log("O pedido de navegação foi aceite.");
},
onFailure: function (error_code, error_message) {
console.warn(error_code, error_message);
}
});
}Erro: error_code -1, Disabled bottom layer. Single-app kiosk.
showLayerBottom
Pede o menu da camada de aplicações. Tem de existir mais de um item atualmente disponível na lista, tendo em conta a validade agendada. Se existir apenas um ou nenhum, a função comunica o erro abaixo.
if (typeof window.showLayerBottom !== 'function') {
console.warn("A função de navegação do leitor não está disponível.");
} else {
window.showLayerBottom({
request: '{}',
onSuccess: function () {
console.log("O pedido de navegação foi aceite.");
},
onFailure: function (error_code, error_message) {
console.warn(error_code, error_message);
}
});
}Erro: error_code -1, Single-app kiosk.
showLayerTop
Pede a camada de apresentação. Esta tem de estar ativada na configuração do dispositivo; caso contrário, a função comunica o erro abaixo. A aceitação do pedido não confirma que uma campanha específica tenha sido reproduzida nem que os conteúdos estejam disponíveis.
if (typeof window.showLayerTop !== 'function') {
console.warn("A função de navegação do leitor não está disponível.");
} else {
window.showLayerTop({
request: '{}',
onSuccess: function () {
console.log("O pedido de navegação foi aceite.");
},
onFailure: function (error_code, error_message) {
console.warn(error_code, error_message);
}
});
}Erro: error_code -1, Top layer disabled.
Utilize onUp para regressar de acordo com o contexto de navegação, showLayerBottom para o menu de aplicações e showLayerTop para conteúdos de apresentação. Evite chamadas repetidas rapidamente, por exemplo por várias pressões num botão. Chamar uma função em falta provoca um erro de JavaScript antes de onFailure poder ser executado, pelo que os exemplos verificam primeiro a disponibilidade.
Temas relacionados e passos seguintes
← Voltar à visão geral – Integrações e criação de conteúdos
Contacte o seu fornecedor de software.
