Skip to content

User

User — classe para trabalhar com o usuário atual na miniaplicação instalada: verificação de permissões e papéis, acesso às suas configurações (UserOptions) e outros dados relacionados. A instância singleton fica disponível após a inicialização do Frame.

ts
import { User } from '@flowlu/miniapp-jssdk'

Propriedades

options

Instância de UserOptions para gerenciamento das configurações do usuário atual

ts
get options(): UserOptions

Métodos

getInstance

Retorna a instância singleton atual de User. Chame apenas após a inicialização do Frame

ts
static getInstance(): User

destroy

Remove inscrições e libera recursos

ts
destroy(): void

hasRole

Verifica se o usuário atual possui ao menos um dos papéis informados na miniaplicação instalada

ts
async hasRole(role: UserRole | UserRole[]): Promise<boolean>
ParâmetroTipoDescrição
roleUserRole | UserRole[]Um papel ou um array de papéis a verificar ('admin', 'employee', 'none')

isAdmin

Retorna true se o usuário atual for administrador do portal

ts
async isAdmin(): Promise<boolean>

Exemplo

ts
import { App, User } from '@flowlu/miniapp-jssdk'

await App.initializeFrame()

const user = User.getInstance()

// verificar se o usuário atual é administrador do portal
if (await user.isAdmin()) {
  console.log('O usuário é administrador do portal')
}

// verificar o papel do usuário atual
if (await user.hasRole('admin')) {
  console.log('O usuário atual tem o papel de administrador na aplicação')
}
js
const App = window.FlowluMiniApp;

const frame = await App.initializeFrame();

// verificar se o usuário atual é administrador do portal
if (await frame.user.isAdmin()) {
  console.log('O usuário é administrador do portal');
}

// verificar o papel do usuário atual
if (await frame.user.hasRole('admin')) {
  console.log('O usuário atual tem o papel de administrador na aplicação');
}

Publicado sob a licença MIT.