Skip to content

UserOptions

UserOptions — classe para gerenciamento das configurações pessoais do usuário atual. A instância singleton fica disponível após a inicialização do Frame.

As configurações de usuário não substituem os valores das configurações da aplicação.

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

Métodos

getInstance

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

ts
static getInstance(): UserOptions

destroy

Remove inscrições e libera recursos

ts
destroy(): void

get

Retorna todas as configurações (OptionsValues) ou o valor de uma única configuração (OptionValue) por identificador

ts
async get(): Promise<OptionsValues>
ts
async get(optionId: string): Promise<OptionValue>
ParâmetroTipoDescrição
optionIdstringIdentificador da configuração

set

Salva várias configurações de uma vez ou o valor de uma única configuração por identificador

ts
async set(values: OptionsValues): Promise<OptionsValues>
ParâmetroTipoDescrição
valuesOptionsValuesObjeto com as configurações para salvar vários valores
ts
async set(optionId: string, value: OptionValue): Promise<OptionValue>
ParâmetroTipoDescrição
optionIdstringIdentificador da configuração
valueOptionValueValor da configuração

Exemplo

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

await App.initializeFrame()

const userOptions = UserOptions.getInstance()

// obter o valor de uma opção do usuário
const theme = await userOptions.get('theme')

// salvar o valor de uma opção
await userOptions.set('theme', 'dark')

// salvar vários valores de opções
await userOptions.set({
  theme: 'dark',
  compact: true
})
js
const App = window.FlowluMiniApp;

const frame = await App.initializeFrame();

// obter o valor de uma opção do usuário
const theme = await frame.userOptions.get('theme');

// salvar o valor de uma opção
await frame.userOptions.set('theme', 'dark');

// salvar vários valores de opções
await frame.userOptions.set({
  theme: 'dark',
  compact: true
});

Publicado sob a licença MIT.