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

B24Frame Class

Designed for managing Bitrix24 applications. It inherits functionality from AbstractB24 and provides methods for working with authentication, messages, sliders, and more.
We are still updating this page. Some data may be missing here — we will complete it shortly.

Implements the TypeB24 interface.

Constructor

constructor(queryParams: B24FrameQueryParams)

The B24FrameQueryParams type describes the parameters needed to initialize a Bitrix24 application frame.

FieldTypeDescription
DOMAINstringBitrix24 account domain name.
PROTOCOLbooleanConnection protocol.
LANGstringBitrix24 interface language.
APP_SIDstringApplication session identifier.

Getters

isInit

get isInit(): boolean

Indicates whether the data is initialized.

isFirstRun

get isFirstRun(): boolean

Returns a flag indicating whether this is the first run of the application.

isInstallMode

get isInstallMode(): boolean

Returns a flag indicating whether the application is in installation mode.

auth

get auth(): AuthManager

Returns the authorization manager.

parent

get parent(): ParentManager

Returns the parent window manager.

slider

get slider(): SliderManager

Returns the slider manager.

placement

get placement(): PlacementManager

Returns the placement manager.

options

get options(): OptionsManager

Returns the options manager.

dialog

get dialog(): DialogManager

Returns the dialog manager.

Methods

Implements the TypeB24 interface.

installFinish

async installFinish(): Promise<any>

Signals the completion of the application installation.

getAppSid

getAppSid(): string

Returns the application identifier relative to the parent window.

getLang

getLang(): B24LangList

Returns the localization of the Bitrix24 interface.

Limiters

The restrictions system provides a comprehensive mechanism for managing request frequency, operation execution time, and adaptive delays.

Initialization

Function is designed to initialize a B24Frame

On this page

  • Constructor
  • Getters
    • isInit
    • isFirstRun
    • isInstallMode
    • auth
    • parent
    • slider
    • placement
    • options
    • dialog
  • Methods
    • installFinish
    • getAppSid
    • getLang
Releases
Published under MIT License.

Copyright © 2024-present Bitrix24