UserOptions

UserOptions — класс для работы с персональными настройками текущего пользователя. Singleton экземпляр доступен после инициализации Frame.

Пользовательские настройки не переопределяют значения общих настроек приложения.

import { UserOptions } from '@aspro-cloud/miniapp-jssdk'

Методы

getInstance

Возвращает текущий singleton экземпляр UserOptions. Вызывать только после инициализации Frame

static getInstance(): UserOptions

destroy

Удаляет подписки и освобождает ресурсы

destroy(): void

get

Возвращает все настройки (OptionsValues) или значение настройки (OptionValue) по идентификатору

async get(): Promise<OptionsValues>

async get(optionId: string): Promise<OptionValue>

Параметр	Тип	Описание
optionId	string	Идентификатор настройки

set

Сохраняет несколько настроек одновременно или значение одной настройки по идентификатору

async set(values: OptionsValues): Promise<OptionsValues>

Параметр	Тип	Описание
values	OptionsValues	Объект с настройками для сохранения нескольких значений

async set(optionId: string, value: OptionValue): Promise<OptionValue>

Параметр	Тип	Описание
optionId	string	Идентификатор настройки
value	OptionValue	Значение настройки

Пример

ESM

import { App, UserOptions } from '@aspro-cloud/miniapp-jssdk'

await App.initializeFrame()

const userOptions = UserOptions.getInstance()

// получение значения настройки пользователя
const theme = await userOptions.get('theme')

// сохранение значения настройки
await userOptions.set('theme', 'dark')

// сохранение значений нескольких настроек
await userOptions.set({
  theme: 'dark',
  compact: true
})

UMD

const App = window.ACloudMiniApp

const frame = await App.initializeFrame()

// получение значения настройки пользователя
const theme = await frame.userOptions.get('theme');

// сохранение значения настройки
await frame.userOptions.set('theme', 'dark');

// сохранение значений нескольких настроек
await frame.userOptions.set({
  theme: 'dark',
  compact: true
});