Options

Options — a class for managing application options shared across all account users. Singleton instance is available after Frame initialization.

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

Methods

getInstance

Returns the current singleton instance of Options. Call only after Frame initialization

static getInstance(): Options

destroy

Removes subscriptions and releases resources

destroy(): void

get

Returns all options (OptionsValues) or a single option value (OptionValue) by identifier

async get(): Promise<OptionsValues>

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

Parameter	Type	Description
optionId	string	Option identifier

set

Saves multiple options at once or a single option value by identifier

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

Parameter	Type	Description
values	OptionsValues	Object with options to save multiple values

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

Parameter	Type	Description
optionId	string	Option identifier
value	OptionValue	Option value

Example

ESM

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

await App.initializeFrame()

const options = Options.getInstance()

// get all option values
const values = await options.get()

// get a single option value
const enabled = await options.get('enabled')
const token = await options.get('token')

// save an option value
await options.set('enabled', true)
await options.set('token', 'service-token-value')

// save multiple option values
await options.set({
  enabled: true,
  token: 'service-token-value'
})

UMD

const App = window.ACloudMiniApp

const frame = await App.initializeFrame()

// get all option values
const values = await frame.options.get();

// get a single option value
const enabled = await frame.options.get('enabled');
const token = await frame.options.get('token');

// save an option value
await frame.options.set('enabled', true);
await frame.options.set('token', 'service-token-value');

// save multiple option values
await frame.options.set({
  enabled: true,
  token: 'service-token-value'
});