Pesquisar K
Appearance
Appearance
ready: O evento ready é emitido quando a lib de portais é carregada, indicando que ele foi importado com sucesso.
LayersPortal.on("ready", function () {
//função chamada quando a lib for carregada
});connected: O evento connected é emitido quando a lib de portais está conectada com a Layers, indicando que apps podem acessar propriedades e métodos da lib. A função chamada quando receber esse evento pode receber o objeto data com informações de usuário e seção como parâmetro.
LayersPortal.on("connected", function (data) {
//função chamada quando a lib estiver conectada com a Layers
});Além dos eventos, apps podem optar por usar promises para controlar o status da lib.
readyPromise: A propriedade readyPromise é, como o nome sugere, uma promise que será resolvida quando a lib for importada com sucesso.
connectedPromise: Assim como a propriedade anterior, a propriedade connectedPromise será resolvida quando a lib estiver conectada com a Layers retornando as informações de seção e do usuário acessando o portal.
A lib de portais também oferece propriedades e métodos que permitem que apps acessem informações não sensíveis do usuário acessando o portal e funcionalidades de navegação Layers
null se estiver sendo acessada fora da Layers.ready: Por padrão, o controle de carregamento de portais na Layers é automático, mas é possível também controlar o carregamento manualmente. Para isso, o portal deve estar configurado com a feature manually-control-loading. Se o portal estiver usando essa feature, o loading da Layers aparecerá enquanto o portal não chamar o método de ready como mostrado abaixo.
LayersPortal("ready");update: O parâmetro 'params' permite que apps atualizem a URL e/ou o título do portal. Para isso, o app deve chamar a função como mostrado no exemplo abaixo:
LayersPortal("update", {
url: String, // nova URL (opcional)
title: String, // novo título (opcional)
});go: O parâmetro 'go' permite que portais redirecionem para outras páginas de portais ou da Layers. Para isso, o app deve chamar a função passando como parâmetro a URL da página para a qual o usuário deve ser redirecionado.
close: O parâmetro 'close' permite que o app feche o portal
download: O parâmetro download permite que o app faça download de arquivos no dispositivo do usuário. Para isso o app deve chamar a função passando como parâmetro um objeto contendo a URL do arquivo e o nome do arquivo como mostrado no exemplo abaixo.
await LayersPortal("download", {
url: String, //URL do arquivo
filename: String, //Nome do arquivo com extensão
});startGeolocation: O parâmetro 'startGeolocation' permite que portais iniciem a coleta de localização de um usuário. Para isso o app deve chamar a função passando como parâmetro um objeto contendo o intervalo de tempo entre coletas de localização e a duração da coleta de localização.
await LayersPortal("startGeolocation", {
interval: Number, // Intervalo entre coleta de localização em milissegundos
duration: Number, // Tempo pelo qual o app permanecerá coletando localização em milissegundos
});Importante: o intervalo mínimo entre coletas de informação é de 5000ms (5s) e o máximo é de 60000ms (1min). A duração mínima para a coleta é de 5000ms (5s) e a máxima é de 3600000ms (1hr).
stopGeolocation: O parâmetro 'stopGeolocation' permite que portais parem a coleta de informação de localização de um usuário antes da expiração do duration enviado na função 'startGeolocation'.
openAppSettings: O parâmetro 'openAppSettings' permite que o portal abra, por cima dele, a tela de configuração do próprio app na Layers (acesso e permissões, autorizações, Hub de APIs etc.). O app aberto é sempre o do portal que fez a chamada, por isso o appId não é enviado. Para isso, o app deve chamar a função passando como parâmetro um objeto com a tela a ser aberta e, opcionalmente, seus modificadores, como mostrado no exemplo abaixo:
await LayersPortal("openAppSettings", {
view: String, // tela a ser aberta (opcional, padrão "overview")
params: Object, // modificadores da tela (opcional)
});Qualquer chave fora de view e params, assim como chaves desconhecidas dentro de params, é ignorada. As telas disponíveis são:
| view | O que abre | params | Quando não está disponível |
|---|---|---|---|
overview (padrão) | Visão geral do app | — | — |
about | Aba "Sobre o app" | — | — |
authorizations | Aba "Autorizações" | — | — |
access | Drawer "Acesso e permissões", com uma linha destacada | target (opcional): target ACL da linha a destacar. Se omitido, destaca o portal que fez a chamada | Se o target não corresponder a nenhuma linha, o drawer abre sem destaque |
services | Estatísticas do Hub de APIs | — | Se o app não tiver serviços, abre a Visão geral |
quality | Qualidade de dados da sincronização | — | Se o app não tiver sincronização com qualidade de dados, abre a Visão geral |
settings | Aba "Configurar app" (portal web:settings do app) | — | Se o app não tiver portal de configuração, abre a Visão geral |
Qualquer outro valor de view abre a Visão geral.
Importante:
params.targetdeve ser o mesmo target configurado para o portal no AppMaker, e não o alias curto do portal.
A promise sempre resolve com { opened: true }, inclusive quando a tela pedida não está disponível e a Visão geral é aberta no lugar. A promise é rejeitada com Error('forbidden') quando o usuário não é administrador da comunidade nem tem permissão para instalar apps.
// Abre "Acesso e permissões" destacando a linha de um portal
await LayersPortal("openAppSettings", {
view: "access",
params: { target: TARGET }, // target configurado para o portal no AppMaker
});
try {
await LayersPortal("openAppSettings", { view: "services" });
} catch (e) {
if (e.message === "forbidden") {
// usuário sem permissão de administrador
}
}A autenticação pode ser feita através do uso das informações na lib de portais e da rota de validar sessão. Essa rota recebe nos parâmetros da query a session, o userId e a community. Fora isso, a rota também necessita da utilização de um token de aplicação, que é fornecido pela Layers à Startup durante o processo de integração. As informações necessárias podem ser extraídas da lib de portais da seguinte maneira:
const { session, communityId, userId } = LayersPortal;Assim, a aplicação pode fazer uma requisição na URL de validação de sessão no seguinte formato:
curl -X GET "https://api.layers.digital/v1/sso/session/validate?session=SESSION&community=COMMUNITY&userId=USER_ID" \
-H "Authorization: Bearer [LAYERS_TOKEN]" \
-H "community-id: COMMUNITY"O header community-id é obrigatório e deve conter o mesmo identificador de comunidade enviado no parâmetro community (o valor de LayersPortal.communityId).
Caso as informações enviadas sejam válidas, a rota de validação de sessão responderá com status 200 confirmando que essa é uma sessão válida e o usuário está autenticado na Layers.
Com a sessão validada, para requisitar informações do usuário em questão basta utilizar a rota de informações do usuário do Layers Data Sync