метод REST
scope: placement
BX24.placement.getInterface
Получить информацию о js-интерфейсе текущей точки встраивания
Описание
Метод BX24.placement.getInterface получает информацию о js-интерфейсе текущей точки встраивания: список доступных команд и событий.
BX24.placement.getInterface(callback);Набор команд и событий у каждой точки встраивания свой. Проверяйте его этим методом перед вызовом BX24.placement.call и перед подпиской через BX24.placement.bindEvent.
Незнакомую команду и подписку на незарегистрированное событие Битрикс24 игнорирует молча, без ошибки.
Параметры
callback
callable
обязательный
Функция обратного вызова. В нее приходит объект с полями command и event
Примеры запроса
BX24.ready(function () {
BX24.init(function () {
BX24.placement.getInterface(function (result) {
console.info(result.command, result.event);
});
});
});// $b24 — инициализированный экземпляр SDK, см. руководство по началу работы
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type PlacementInterface = {
command: string[]
event: string[]
}
const result = await $b24.placement.getInterface() as PlacementInterface
console.info(result.command, result.event)<!-- Загрузка SDK в UMD-сборке, глобальный объект B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
document.addEventListener('DOMContentLoaded', async () => {
const $b24 = await B24Js.initializeB24Frame()
const result = await $b24.placement.getInterface()
console.info(result.command, result.event)
})
</script>
