Skip to content

index.md

Latest commit

 

History

History
87 lines (64 loc) · 7.5 KB

index.md

File metadata and controls

87 lines (64 loc) · 7.5 KB
Raw

Interface, Navigation, and Context: Overview of Methods

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

{% include notitle iframe context %}

Additional methods manage the interface of the embedded application in Bitrix24. They allow you to resize frames, open sliders and windows, handle page events, and send commands to the messenger and telephony.

Quick navigation: all methods

How to Choose the Right Method

  1. If you need to manage the application window or frame, start with BX24.resizeWindow, BX24.fitWindow, BX24.setTitle, BX24.openApplication, and BX24.closeApplication.
  2. If you need to open a section of Bitrix24, start a call, or open a chat from the application interface, use BX24.openPath, BX24.im.callTo, BX24.im.phoneTo, BX24.im.openMessenger, or BX24.im.openHistory.
  3. If you need to wait for the DOM structure of the page to be ready or bind an event handler, use BX24.ready, BX24.isReady, BX24.bind, BX24.unbind, BX24.proxy, and BX24.proxyContext.
  4. If you need to retrieve runtime environment data, check BX24.isAdmin, BX24.getLang, BX24.getDomain, and BX24.getScrollSize.
  5. If you need to connect an external JavaScript file on the application page, use BX24.loadScript.

Key Considerations

  • The methods work only inside the application frame and are called after BX24.init. The exceptions are BX24.ready and BX24.loadScript: they depend on the readiness of the page, not the library
  • Most of the methods do not return data. They send a command to the Bitrix24 interface, and the result arrives in a callback function
  • Environment data — BX24.isAdmin, BX24.getLang, BX24.getDomain, BX24.getScrollSize, BX24.isReady, BX24.proxy, BX24.proxyContext — is returned immediately, without a callback
  • The BX24.im.* methods are an exception: they take no callback at all and return no data (void). The command is posted to the parent window and nothing comes back, so a successful call means only that the command was sent — not that the call started or the chat opened
  • BX24.openPath does not work in the mobile application. The method reports this and an unavailable path with the codes METHOD_NOT_SUPPORTED_ON_DEVICE and PATH_NOT_AVAILABLE in the callback. The methods of this section return no other error codes
  • The methods require no scope of their own: they manage the interface instead of calling the REST API

Interaction with Other Objects

System Interface of Bitrix24. The method BX24.openPath opens pages and object detail forms in the built-in Bitrix24 slider. The path is passed as a relative one, from the root of Bitrix24: for example, /crm/deal/details/5/ for a deal. The methods BX24.im.callTo and BX24.im.phoneTo start a call via internal communication and a call to a phone number, while BX24.im.openMessenger and BX24.im.openHistory open the messenger window and the message history of a dialog.

Embedding Locations. For scenarios involving embeddings, register a handler via placement.bind and select an appropriate embedding location from the list of embedding locations. This is particularly important for the methods BX24.reloadWindow and BX24.scrollParentWindow, which depend on the context of the application's placement.

Application Initialization and Settings. Environment data becomes available after the library is initialized — this is described in the Initialization and Authorization section. The Calling REST Methods section helps you call Bitrix24 methods from the client side, and the App Configurations section helps you retain the user's choice between launches.

Overview of Methods {#all-methods}

Window and Frame Management

#| || Method | Description || || BX24.resizeWindow | Resizes the frame containing the application || || BX24.fitWindow | Adjusts the frame size to fit the content || || BX24.reloadWindow | Reloads the entire page with the application, not just the frame || || BX24.setTitle | Sets the page title || || BX24.openApplication | Opens a pop-up window with the application frame || || BX24.closeApplication | Closes the pop-up window with the application || || BX24.scrollParentWindow | Scrolls the parent window to the specified vertical position || |#

Page Events and Call Context

#| || Method | Description || || BX24.ready | Sets an event handler for "DOM structure of the document is ready for use" || || BX24.isReady | Indicates whether the DOM structure of the document is ready for use || || BX24.proxy | Creates a proxy function for calling a function in the required context || || BX24.proxyContext | Returns the original call context inside a proxy function || || BX24.bind | Sets an event handler for a page element || || BX24.unbind | Removes an event handler from a page element || |#

Environment Data and Resource Loading

#| || Method | Description || || BX24.isAdmin | Determines whether the current user has Bitrix24 administrator permissions || || BX24.getLang | Returns the language identifier in the current Bitrix24 || || BX24.getDomain | Returns the address of the Bitrix24 where the application is open || || BX24.getScrollSize | Returns the dimensions of the application frame content || || BX24.loadScript | Loads and executes a client-side JavaScript file || |#

Navigation and Communication

#| || Method | Description || || BX24.openPath | Opens a path within Bitrix24 in the slider || || BX24.im.callTo | Calls a Bitrix24 user via internal communication || || BX24.im.phoneTo | Calls a phone number || || BX24.im.openMessenger | Opens the messenger window or the chat list || || BX24.im.openHistory | Opens the message history window of a dialog || |#