Options Manager Class
Used for managing application and user settings in the Bitrix24 application. It allows initializing data, getting, and setting options through messages to the parent window.
We are still updating this page. Some data may be missing here — we will complete it shortly.
Methods
appGet
appGet(option: string): any
Retrieves the value of an application option.
Returns the option value or throws an error if the option is not set.
// ... /////
$b24 = await initializeB24Frame()
// ... /////
const value: any = $b24.options.appGet('test')
appSet
async appSet(option: string, value: any): Promise<void>
Sets the value of an application option.
// ... /////
$b24 = await initializeB24Frame()
// ... /////
await $b24.options.appSet('test', 123)
userGet
userGet(option: string): any
Retrieves the value of a user option.
Returns the option value or throws an error if the option is not set.
// ... /////
$b24 = await initializeB24Frame()
// ... /////
const value: any = $b24.options.userGet('test')
userSet
async userSet(option: string, value: any): Promise<void>
Sets the value of a user option.
// ... /////
$b24 = await initializeB24Frame()
// ... /////
await $b24.options.userSet('test', 123)
Dialog
Wraps the BX24 system dialogs (user picker, access permission picker, CRM entity picker) so they can be opened from inside a Bitrix24 application iframe.
Parent
Provides methods for managing the parent application window in Bitrix24, including resizing the window, managing scroll, initiating calls, and opening the messenger.