Методы и события Metaframe

Объект window.metaframe

После загрузки скрипта объект metaframe будет доступен в глобальном объекте window вашего приложения. Объект metaframe содержит список методов, необходимых для управления Metaframe в вашем веб-приложении.

Метод window.metaframe.create

Сигнатура метода:

window.metaframe.create: (parameters: {
 loginProjectId: string,
 merchantId?: number,
 projectId?: number,
 orbsApiHostId?: string,
 isMobile?: boolean,
 isCollapsed?: boolean,
 layoutSettings?: {
     desktop: {
       widgetMarginTop?: number,
     },
     mobile: {
       widgetMarginTop?: number,
     },
   },
}) => void;

Инициализирует Metaframe в вашем веб-приложении.

Метод window.metaframe.setIsMobile

Сигнатура метода:

window.metaframe.setIsMobile(isMobile: boolean)

Переключает Metaframe с настольной на мобильную версию или наоборот.

Объект window.metaframe.partnerActions

Объект содержит методы для инициирования действий в Metaframe.

Перед использованием методов этого объекта необходимо убедиться, что Metaframe полностью загружен. Для этого необходимо подписаться на событие загрузки Metaframe. Если событие было обработано, то методы объекта доступны.

Пример установки слушателя на событие загрузки Metaframe:

window.addEventListener("@metaframe-partner-events:app-loaded", () => {

 //Here you can use partner actions

});

Метод window.metaframe.partnerActions.openBackpackItemPage

Сигнатура метода:

openBackpackItemPage: (itemId: string) => void;

Открывает страницу указанного товара в разделе Backpack.

Для корректной работы метода необходимо соблюдение следующих условий:

• В Личном кабинете активирована функция Рюкзак.
• Пользователь авторизовался в Metaframe.

Метод window.metaframe.partnerActions.openLogin

Сигнатура метода:

openLogin: () => void;

Открывает форму авторизации пользователя. Если пользователь уже авторизован, в браузерную консоль выводится ошибка.

Метод window.metaframe.partnerActions.openProfile

Сигнатура метода:

openProfile: () => void;

Открывает раздел Profile. Если пользователь не авторизован, в браузерную консоль выводится ошибка.

Метод window.metaframe.partnerActions.openWallet

Сигнатура метода:

openWallet: () => void;

Открывает раздел Wallet. Если пользователь не авторизован, в браузерную консоль выводится ошибка.

Метод window.metaframe.partnerActions.openBackpack

Сигнатура метода:

openBackpack: () => void;

Открывает раздел Backpack. Если пользователь не авторизован, в браузерную консоль выводится ошибка.

Метод window.metaframe.partnerActions.openCustomMiniApp

Сигнатура метода:

openCustomMiniApp: (params: {miniAppName: string}) => void;

Открывает указанный пользовательский раздел с типом Iframe при соблюдении одного из следующих условий:

• Если в настройках указанного пользовательского раздела переключатель Показывать это приложение перед авторизацией пользователя установлен в активное приложение и текущий пользователь не авторизован.
• Если в настройках указанного пользовательского раздела переключатель Показывать это приложение после авторизации пользователя установлен в активное приложение и текущий пользователь авторизован.

Если условия не выполняются, в браузерную консоль выводится ошибка.

Метод window.metaframe.partnerActions.pushNotification

Сигнатура метода:

pushNotification: (params: {
  type: string; // use “success”, “warning”, “error” or “info”
  text: string;
  button?: {
    text: string;
    onClick: () => void;
  };
  durationInMs?: number;
}) => void;

Помещает новое уведомление в очередь.

Метод window.metaframe.partnerActions.setIsCustomMiniAppVisible

Сигнатура метода:

setIsCustomMiniAppVisible: (params: {
  miniAppName: string;
  isVisible: boolean;
}) => void;

Отображает или скрывает указанный пользовательский раздел.

События виджета

Вы можете подписаться на следующие события Metaframe:

Отслеживание событий пользовательских разделов

Вы можете добавить в Metaframe пользовательский раздел с типом Action. Такой раздел отображается в виде кнопки, при нажатии на которую совершается действие, например, переход на веб-сайт.

Для отслеживания события выбора пользовательского раздела вам требуется подписаться на событие @metaframe:custom-action:<ACTION_ID>, гдe <ACTION_ID> — ID действия, сформированный в Личном кабинете при настройке пользовательского раздела.

Пример установки слушателя на событие выбора пользовательского раздела:

document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {

 // Your code here...

})