Методы и события Metaframe
Объект window.metaframe
После загрузки скрипта объект metaframe будет доступен в глобальном объекте window вашего приложения. Объект metaframe содержит список методов, необходимых для управления Metaframe в вашем веб-приложении.
Метод window.metaframe.create
Сигнатура метода:
window.metaframe.create: (parameters: {
loginProjectId: string,
merchantId?: number,
projectId?: number,
orbsApiHostId?: string,
isMobile?: boolean,
}) => void;
Инициализирует Metaframe в вашем веб-приложении. Метод принимает объект parameters со следующими параметрами, необходимыми для запуска Metaframe:
| Параметр | Тип | Описание |
|---|---|---|
loginProjectId | string | ID варианта авторизации. Чтобы получить его, откройте проект в Личном кабинете, перейдите в раздел Login > Дашборд > проект авторизации. Обязательный. |
merchantId | string | ID продавца. Вы можете найти этот параметр в Личном кабинете:
|
projectID | string | ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.Обязательный, если в настройках проекта в Личном кабинете активирована функция Рюкзак. |
orbsApiHostId | string | ID хоста. Для его получения обратитесь к команде интеграции через integration@xsolla.com или к персональному менеджеру проекта через csm@xsolla.com и передайте ID проекта и ID продавца.Обязательный, если в настройках проекта в Личном кабинете активирована функция Виртуальные валюты. |
isMobile | boolean | Использует ли Metaframe мобильную версию по умолчанию. |
Метод window.metaframe.setIsMobile
Сигнатура метода:
window.metaframe.setIsMobile(isMobile: boolean)
Переключает Metaframe с настольной на мобильную версию или наоборот.
| Параметр | Тип | Описание |
|---|---|---|
isMobile | boolean | Следует ли переключать Metaframe на мобильную версию. Если установлено значение true, то Metaframe переключится на мобильную версию. Если установлено значение false, то Metaframe переключится на настольную версию. |
Объект window.metaframe.partnerActions
Объект содержит методы для инициирования действий в Metaframe.
Перед использованием методов этого объекта необходимо убедиться, что Metaframe полностью загружен. Для этого необходимо подписаться на событие загрузки Metaframe. Если событие было обработано, то методы объекта доступны.
Пример установки слушателя на событие загрузки Metaframe:
- javascript
window.addEventListener("@metaframe-partner-events:app-loaded", () => {
//Here you can use partner actions
});
Метод window.metaframe.partnerActions.openBackpackItemPage
Сигнатура метода:
window.metaframe.partnerActions.openBackpackItemPage(itemId: string)
Открывает страницу указанного товара в разделе
Для корректной работы метода необходимо соблюдение следующих условий:
- В Личном кабинете активирована функция Рюкзак.
- Пользователь авторизовался в Metaframe.
| Параметр | Тип | Описание |
|---|---|---|
itemId | string | Внутренний ID предмета, который передается при вызове метода API на создание предмета. |
Отслеживание событий
Вы можете подписаться на следующие события Metaframe:
| Параметр | Тип |
|---|---|
@metaframe-partner-events:app-loaded | Событие срабатывает при успешной загрузке Metaframe после вызова метода window.metaframe.create. |
@metaframe-partner-events:login-successful | Событие срабатывает при успешной авторизации пользователя в Metaframe и содержит объект detail с авторизационным токеном пользователя. |
@metaframe-partner-events:logout-successful | Событие срабатывает при успешном выходе пользователя из системы. |
@metaframe:custom-action:<ACTION_ID> | Событие срабатывает, если пользователь выбирает в Metaframe пользовательский раздел с типом Действие. Подробные сведения приведены в разделе Отслеживание событий пользовательских разделов. |
Отслеживание событий пользовательских разделов
Вы можете добавить в Metaframe пользовательский раздел с типом Действие. Такой раздел отображается в виде кнопки, при нажатии на которую совершается действие, например, переход на веб-сайт.
Для отслеживания события выбора пользовательского раздела вам требуется подписаться на событие @metaframe:custom-action:<ACTION_ID>, гдe <ACTION_ID> — ID действия, сформированный в Личном кабинете при настройке пользовательского раздела.
Пример установки слушателя на событие выбора пользовательского раздела:
- javascript
document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
// Your code here...
})
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.
