Version 1.0.1 is now available! Looking for a migration guide?
v1.0.1
/
  • Get Started
  • Working
  • GitHub
  • Overview
  • Introduction
  • Actions
  • Call
  • Call
  • CallList
  • CallList
  • FetchList
  • FetchList
  • Batch
  • Batch
  • BatchByChunk
  • BatchByChunk
  • Tools
  • HealthCheck
  • Ping
  • Logger
  • Logger
  • Telegram
  • Limiters
  • Limiters
  • B24Frame
  • Introduction
  • Initialization
  • Auth
  • Dialog
  • Options
  • Parent
  • Placement
  • Slider
  • b24ui
  • b24icons
v1.0.1
  • Get started
  • Working

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

Used for displaying standard dialogs.

Parent

Provides methods for managing the parent application window in Bitrix24, including resizing the window, managing scroll, initiating calls, and opening the messenger.

On this page

  • Methods
    • appGet
    • appSet
    • userGet
    • userSet
Releases
Published under MIT License.

Copyright © 2024-present Bitrix24