You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 7, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: src/pages/concepts/funcionalidades/logar-com-layers.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,4 +12,4 @@ A funcionalidade "logar com Layers" permite que apps autentiquem usuários por m
12
12
13
13
## Usando a funcionalidade Logar com Layers
14
14
15
-
Para facilitar o uso da funcionalidade Logar com Layers, disponibilizamos um [tutorial sobre o SDK](./../../sdk/como-colocar-o-botao-logar-com-layers) disponibilizado para que apps possam usar o botão de logar com Layers em suas páginas de login.
15
+
Para facilitar o uso da funcionalidade Logar com Layers, disponibilizamos um [tutorial sobre a lib](./../../sdk/como-colocar-o-botao-logar-com-layers) disponibilizado para que apps possam usar o botão de logar com Layers em suas páginas de login.
Copy file name to clipboardExpand all lines: src/pages/concepts/funcionalidades/portais.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,4 +15,4 @@ A funcionalidade de Portais da Layers permite que apps adicionem telas personali
15
15
16
16
## Criando um portal na Layers
17
17
18
-
Para que um app possa utilizar essa funcionalidade da Layers ele deve estar cadastrado, ter a funcionalidade "portais" habilitada e disponibilizar o link de uma página que utilize o [SDK de portais](/docs/forstartups/portais/layers-portal) da Layers. Essa biblioteca permite que o app receba eventos quando o app estiver pronto e quando estiver conectado para que ele possa ser acessado através da Layers.
18
+
Para que um app possa utilizar essa funcionalidade da Layers ele deve estar cadastrado, ter a funcionalidade "portais" habilitada e disponibilizar o link de uma página que utilize a [lib de portais](/docs/forstartups/portais/layers-portal) da Layers. Essa biblioteca permite que o app receba eventos quando o app estiver pronto e quando estiver conectado para que ele possa ser acessado através da Layers.
Copy file name to clipboardExpand all lines: src/pages/forstartups/funcionalidades/logar-com-layers.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,4 +12,4 @@ A funcionalidade "logar com Layers" permite que apps autentiquem usuários por m
12
12
13
13
## Usando a funcionalidade Logar com Layers
14
14
15
-
Para facilitar o uso da funcionalidade Logar com Layers, disponibilizamos um [tutorial sobre o SDK](./../../sdk/como-colocar-o-botao-logar-com-layers) disponibilizado para que apps possam usar o botão de logar com Layers em suas páginas de login.
15
+
Para facilitar o uso da funcionalidade Logar com Layers, disponibilizamos um [tutorial sobre a lib](./../../sdk/como-colocar-o-botao-logar-com-layers) disponibilizado para que apps possam usar o botão de logar com Layers em suas páginas de login.
Copy file name to clipboardExpand all lines: src/pages/forstartups/portais.md
+19-19
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,28 @@
1
1
---
2
2
template: default
3
-
title: Layers Portal
3
+
title: LayersPortal.js
4
4
tableOfContents: false
5
5
previousText: 'Introdução'
6
6
previousUrl: '/docs/forstartups'
7
7
nextText: 'Single Sign-On na Layers'
8
8
nextUrl: '/docs/forstartups/sso'
9
9
---
10
10
11
-
# Layers Portal
11
+
# LayersPortal.js
12
12
13
13
A funcionalidade de Portais da Layers permite que apps adicionem telas personalizadas à nossa interface. Os Apps podem também habilitar a funcionalidade de autenticação OAuth para que os usuários que acessarem o portal sejam autenticados e o app possa acessar informações consentidas por eles. Além disso, utilizar essa funcionalidade permite que o App utilize nosso sistema de [Push Notifications](/docs/api/notifications/notification/post), que permite um fácil envio de push notifications para os usuários do app mobile e web.
14
14
15
15
16
16
### Criando um portal na Layers
17
17
18
-
Para que um app possa utilizar essa funcionalidade da Layers ele deve estar cadastrado, ter a funcionalidade "portais" habilitada e disponibilizar o link de uma página que utilize o [SDK de portais](/docs/forstartups/portais#layers-portal-sdk) da Layers. Essa biblioteca permite que o app receba eventos quando o app estiver pronto e quando estiver conectado para que ele possa ser acessado através da Layers.
18
+
Para que um app possa utilizar essa funcionalidade da Layers ele deve estar cadastrado, ter a funcionalidade "portais" habilitada e disponibilizar o link de uma página que utilize [a lib de portais](/docs/forstartups/portais#layersportal-js) da Layers. Essa biblioteca permite que o app receba eventos quando o app estiver pronto e quando estiver conectado para que ele possa ser acessado através da Layers.
19
19
20
20
21
-
## Layers Portal SDK
21
+
## LayersPortal.js
22
22
23
-
### Importando e configurando o SDK
23
+
### Importando e configurando a lib
24
24
25
-
Uma vez que o app está registrado ele poderá ser instalado nas comunidades e utilizado pelos usuários da comunidade em específico. Para que tudo funcione de forma segura e fluida para o usuário final, a página que será acessada através da Layers deve importar nosso SDK de portais da maneira que está exemplificado abaixo. Através desse SDK, apps podem acessar informações e funcionalidades da Layers.
25
+
Uma vez que o app está registrado ele poderá ser instalado nas comunidades e utilizado pelos usuários da comunidade em específico. Para que tudo funcione de forma segura e fluida para o usuário final, a página que será acessada através da Layers deve importar nossa lib de portais da maneira que está exemplificado abaixo. Através dessa lib, apps podem acessar informações e funcionalidades da Layers.
26
26
27
27
```html
28
28
<!DOCTYPE HTML>
@@ -48,44 +48,44 @@ O objeto `LayersPortalOptions` deve ser definido com as seguintes propriedades:
48
48
+**insidePortalOnly**: Booleano indicando se a página deve ser acessível apenas através da Layers
49
49
+**manualLoadingControl**: Booleano indicando se o app controlará o carregamento manualmente, chamando o método `LayersPortal.ready()` quando a página estiver carregada ou se o controle de carregamento deve ser feito automáticamente pela Layers
50
50
51
-
### Utilizando o SDK
51
+
### Utilizando a lib
52
52
53
-
O SDK de portais disponibiliza uma série de eventos e promises para que apps que usam a funcionalidade de portais possam monitorar o status do SDK e da sua conexão com a Layers.
53
+
A lib de portais disponibiliza uma série de eventos e promises para que apps que usam a funcionalidade de portais possam monitorar o status da lib e da sua conexão com a Layers.
54
54
55
55
#### Eventos
56
56
57
-
+**ready**: O evento `ready` é emitido quando o SDK de portais é carregado, indicando que ele foi importado com sucesso.
57
+
+**ready**: O evento `ready` é emitido quando a lib de portais é carregada, indicando que ele foi importado com sucesso.
58
58
59
59
```js
60
60
LayersPortal.on('ready', function(){
61
-
//função chamada quando o SDK for carregado
61
+
//função chamada quando a lib for carregada
62
62
})
63
63
```
64
64
65
-
+**connected**: O evento `connected` é emitido quando o SDK de portais está conectado com a Layers, indicando que apps podem acessar propriedades e métodos do SDK. 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.
65
+
+**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.
66
66
67
67
```js
68
68
LayersPortal.on('connected', function(data){
69
-
//função chamada quando o SDK estiver conectado com a Layers
69
+
//função chamada quando a lib estiver conectada com a Layers
70
70
})
71
71
```
72
72
73
73
#### Promises
74
74
75
-
Além dos eventos, apps podem optar por usar promises para controlar o status do SDK.
75
+
Além dos eventos, apps podem optar por usar promises para controlar o status da lib.
76
76
77
-
+**readyPromise**: A propriedade `readyPromise` é, como o nome sugere, uma promise que será resolvida quando o SDK for importado com sucesso.
77
+
+**readyPromise**: A propriedade `readyPromise` é, como o nome sugere, uma promise que será resolvida quando a lib for importada com sucesso.
78
78
79
-
+**connectedPromise**: Assim como a propriedade anterior, a propriedade `connectedPromise` será resolvida quando o SDK estiver conectado com a Layers retornando as informações de seção e do usuário acessando o portal.
79
+
+**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.
80
80
81
81
82
82
83
-
O SDK 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
83
+
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
84
84
85
85
#### Propriedades
86
86
87
-
+**ready**: Booleano que indica se o SDK de portais foi importado com sucesso
88
-
+**connected**: Booleano que indica se o SDK de portais está conectado com a Layers
87
+
+**ready**: Booleano que indica se a lib de portais foi importada com sucesso
88
+
+**connected**: Booleano que indica se a lib de portais está conectada com a Layers
89
89
+**platform**: String que pode ter o valor de `"iframe"`, `"ios"` ou `"android"` se a página estiver sendo acessada através da Layers ou `null` se estiver sendo acessada fora da Layers.
90
90
+**session**: String da seção
91
91
+**userId**: String do identificador único do usuário na Layers
@@ -111,7 +111,7 @@ LayersPortal.update(
111
111
112
112
#### Autenticação
113
113
114
-
A autenticação pode ser feita através do uso das informações no SDK 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 do SDK de portais da seguinte maneira:
114
+
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:
Copy file name to clipboardExpand all lines: src/pages/forstartups/portais/layers-portal.md
+17-17
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
1
---
2
2
template: default
3
-
title: Layers Portal SDK
3
+
title: LayersPortal.js
4
4
tableOfContents: true
5
5
nextText: 'Single Sign-On na Layers'
6
6
nextUrl: '/docs/forstartups/sso'
7
7
previousText: 'Portais na Layers'
8
8
previousUrl: '/docs/forstartups/portais'
9
9
---
10
10
11
-
# Layers Portal SDK
11
+
# LayersPortal.js
12
12
13
13
A funcionalidade de Portais da Layers permite que apps adicionem telas personalizadas à nossa interface, formando uma experiência unificada e integrando totalmente no ecossistema Layers.
14
14
15
-
## Importando e configurando o SDK
15
+
## Importando e configurando a lib
16
16
17
-
Uma vez que o app está registrado ele poderá ser instalado nas comunidades e utilizado pelos usuários da comunidade em específico. Para que tudo funcione de forma segura e fluida para o usuário final, a página que será acessada através da Layers deve importar nosso SDK de portais da maneira que está exemplificado abaixo. Através desse SDK, apps podem acessar informações e funcionalidades da Layers.
17
+
Uma vez que o app está registrado ele poderá ser instalado nas comunidades e utilizado pelos usuários da comunidade em específico. Para que tudo funcione de forma segura e fluida para o usuário final, a página que será acessada através da Layers deve importar nossa lib de portais da maneira que está exemplificado abaixo. Através dessa lib, apps podem acessar informações e funcionalidades da Layers.
18
18
19
19
```html
20
20
<!DOCTYPE HTML>
@@ -40,44 +40,44 @@ O objeto `LayersPortalOptions` deve ser definido com as seguintes propriedades:
40
40
+**insidePortalOnly**: Booleano indicando se a página deve ser acessível apenas através da Layers
41
41
+**manualLoadingControl**: Booleano indicando se o app controlará o carregamento manualmente, chamando o método `LayersPortal.ready()` quando a página estiver carregada ou se o controle de carregamento deve ser feito automáticamente pela Layers
42
42
43
-
## Utilizando o SDK
43
+
## Utilizando a lib
44
44
45
-
O SDK de portais disponibiliza uma série de eventos e promises para que apps que usam a funcionalidade de portais possam monitorar o status do SDK e da sua conexão com a Layers.
45
+
A lib de portais disponibiliza uma série de eventos e promises para que apps que usam a funcionalidade de portais possam monitorar o status da lib e da sua conexão com a Layers.
46
46
47
47
### Eventos
48
48
49
-
+**ready**: O evento `ready` é emitido quando o SDK de portais é carregado, indicando que ele foi importado com sucesso.
49
+
+**ready**: O evento `ready` é emitido quando a lib de portais é carregado, indicando que ele foi importado com sucesso.
50
50
51
51
```js
52
52
LayersPortal.on('ready', function(){
53
-
//função chamada quando o SDK for carregado
53
+
//função chamada quando a lib for carregada
54
54
})
55
55
```
56
56
57
-
+**connected**: O evento `connected` é emitido quando o SDK de portais está conectado com a Layers, indicando que apps podem acessar propriedades e métodos do SDK. 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.
57
+
+**connected**: O evento `connected` é emitido quando a lib de portais está conectado 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.
58
58
59
59
```js
60
60
LayersPortal.on('connected', function(data){
61
-
//função chamada quando o SDK estiver conectado com a Layers
61
+
//função chamada quando a lib estiver conectado com a Layers
62
62
})
63
63
```
64
64
65
65
### Promises
66
66
67
-
Além dos eventos, apps podem optar por usar promises para controlar o status do SDK.
67
+
Além dos eventos, apps podem optar por usar promises para controlar o status da lib.
68
68
69
-
+**readyPromise**: A propriedade `readyPromise` é, como o nome sugere, uma promise que será resolvida quando o SDK for importado com sucesso.
69
+
+**readyPromise**: A propriedade `readyPromise` é, como o nome sugere, uma promise que será resolvida quando a lib for importada com sucesso.
70
70
71
-
+**connectedPromise**: Assim como a propriedade anterior, a propriedade `connectedPromise` será resolvida quando o SDK estiver conectado com a Layers retornando as informações de seção e do usuário acessando o portal.
71
+
+**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.
72
72
73
73
74
74
75
-
O SDK 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
75
+
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
76
76
77
77
### Propriedades
78
78
79
-
+**ready**: Booleano que indica se o SDK de portais foi importado com sucesso
80
-
+**connected**: Booleano que indica se o SDK de portais está conectado com a Layers
79
+
+**ready**: Booleano que indica se a lib de portais foi importado com sucesso
80
+
+**connected**: Booleano que indica se a lib de portais está conectado com a Layers
81
81
+**platform**: String que pode ter o valor de `"iframe"`, `"ios"` ou `"android"` se a página estiver sendo acessada através da Layers ou `null` se estiver sendo acessada fora da Layers.
82
82
+**session**: String da seção
83
83
+**userId**: String do identificador único do usuário na Layers
@@ -103,7 +103,7 @@ LayersPortal.update(
103
103
104
104
### Autenticação
105
105
106
-
A autenticação pode ser feita através do uso das informações no SDK 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 do SDK de portais da seguinte maneira:
106
+
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:
0 commit comments