Skip to content

B24Frame Initialization

ts
initializeB24Frame(): Promise<B24Frame>

The initializeB24Frame function is designed to initialize a B24Frame object, which is used for working with Bitrix24 applications.

It manages the initialization process and handles potential connection errors.

INFO

Supports repeated calls until initialization is complete, using a callback queue.

Return Value

  • Promise<B24Frame>: Returns a promise that resolves to a B24Frame object upon successful initialization.

Usage

ts
import { initializeB24Frame } from '@bitrix24/b24jssdk'

WARNING

The code must be run as a Bitrix24 application (in a frame).

ts
import {
	initializeB24Frame,
	B24Frame,
} from '@bitrix24/b24jssdk'
	
let $b24: B24Frame

initializeB24Frame()
.then((response: B24Frame) => {
	$b24 = response
})
.catch((error) => {
	console.error(error)
})
html
<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<title>Bitrix24 Frame Demo</title>
</head>
<body>
<p>See the result in the developer console</p>
<script src="https://unpkg.com/@bitrix24/b24jssdk@latest/dist/umd/index.min.js"></script>
<script>
document.addEventListener('DOMContentLoaded', async () => {
	try
	{
		let $b24 = await B24Js.initializeB24Frame();
	}
	catch (error)
	{
		console.error(error);
	}
});
</script>
</body>
</html>
vue
<script setup lang="ts">
import { onMounted, onUnmounted } from 'vue'
import {
	initializeB24Frame,
	B24Frame,
} from '@bitrix24/b24jssdk'

let $b24: B24Frame

onMounted(async () => {
	try
	{
		$b24 = await initializeB24Frame()
	}
	catch (error)
	{
		console.error(error)
	}
})

onUnmounted(() => {
	$b24?.destroy()
})
</script>

<template>
	<p>See the result in the developer console</p>
</template>

Released under the MIT License.