@layers.digital/layers-portal-sdk
v1.0.28
Published
O LayersPortal é uma camada de integração que permite que seu app seja acessado dentro do ecossistema Layers.
Downloads
1,715
Keywords
Readme
Layers Portal SDK
O LayersPortal é uma camada de integração que permite que seu app seja acessado dentro do ecossistema Layers.
Você pode encontrar tudo o que precisa saber através da documentação da Layers.
Instalação
Para a instalação, certifique-se de estar utilizando o Node.js
A instalação é feita pelo comando:
npm install @layers.digital/layers-portal-sdkLogo após instalado, algumas configurações do portal devem ser definidas para que a Layers consiga se conectar corretamente com o app. Você pode coloca-los no do seu index, como por exemplo:
<html>
<head>
<script>
window.LayersPortalOptions = {
appId: String, // Identificador do app
insidePortalOnly: Boolean, // O app deve ser acessado apenas através da Layers?
}
</script>
...
</head>
<body>
...
</body>
</html>Com o pacote @layers.digital/layers-portal-sdk instalado e com as configurações feitas, você agora poderá importar o pacote no inicio do ciclo do seu app para que ele seja iniciado corretamente, como mostrado no exemplo:
// main.js
...
import '@layers.digital/layers-portal-sdk';
...O LayersPortal agora pode ser acessado através da propriedade de window pelo JavaScript.
Exemplos
Exemplos de uso de alguns métodos do LayersPortal:
const { LayersPortal } = window; // Pegando o LayersPortal da propriedade window
await LayersPortal.readyPromise; // Esperando a lib ser importada com sucesso
const { userId, communityId } = LayersPortal; // Pegando as informações básicas do usuário conectado
console.log({ userId, communityId });const { LayersPortal } = window;
LayersPortal('download', { url: 'someUrl', filename: 'someFile' }); // Requisitando que a Layers faça o download de um arquivoTypeScript
O pacote do LayersPortal já vem com as interfaces que você precisa, para utiliza-las, importe as interfaces necessárias no seu arquivo de declaração global:
import { LayersPortalOptions, LayersPortalSDK } from '@layers.digital/layers-portal-sdk';
declare global {
interface Window {
LayersPortal: LayersPortalSDK
LayersPortalOptions: LayersPortalOptions
}
}