Events

SDK экспортирует общие типы событий и перечисления допустимых событий для методов классов:

import type {
  EventCallback,
  EventCallbacks,
  FrameEventName,
  FrameOpenUrlEventName,
  FrameOpenHomepageEventName,
  OAuth2EventName,
  ToastEventName,
  SwalEventName,
  ModalEventName,
  SidepanelEventName
} from '@aspro-cloud/miniapp-jssdk'

Типы

`EventCallback`

Функция обратного вызова для событий

type EventCallback<T = any> = (data: T) => void

Параметр	Тип	Описание
`data`	`any`	Данные события

`EventCallbacks`

Объект с обработчиками событий, передаётся в параметрах методов и конструкторов

type EventCallbacks<TEventName extends string = string> =
  Partial<Record<TEventName, EventCallback<any> | null>> | null

Свойство	Тип	Описание
`[eventName: string]`	`EventCallback` \| `null`	Обработчик события

`FrameEventName`

Имена событий метода Frame.initialize()

Значение	Описание
`'onReady'`	Вызывается после того, как содержимое iframe загружено (`DOMContentLoaded`), `Frame` инициализирован и контекст получен, содержимое встроки отображено

`FrameOpenUrlEventName`

Имена событий метода Frame.openUrl()

Значение	Описание
`'onOpen'`	URL открыт
`'onCancel'`	Открытие URL отменено

`FrameOpenHomepageEventName`

Имена событий метода Frame.openHomepage()

Значение	Описание
`'onOpen'`	Домашняя страница приложения открыта
`'onCancel'`	Открытие отменено

`OAuth2EventName`

Имена событий метода OAuth2.refresh()

Значение	Описание
`'onRefresh'`	Токены успешно обновлены

`ToastEventName`

Имена событий метода Toast.show()

Значение	Описание
`'onShow'`	Уведомление отображено
`'onHide'`	Уведомление скрыто
`'onClose'`	Уведомление скрыто пользователем

`SwalEventName`

Имена событий метода Swal.alert()

Значение	Описание
`'onShow'`	Диалог отображен
`'onHide'`	Диалог скрыт
`'onCancel'`	Пользователь отменил действие

Имена событий метода Swal.confirm()

Значение	Описание
`'onShow'`	Диалог отображен
`'onHide'`	Диалог скрыт
`'onCancel'`	Пользователь отменил действие
`'onConfirm'`	Пользователь подтвердил действие

Имена событий метода Swal.prompt()

Значение	Описание
`'onShow'`	Диалог отображен
`'onHide'`	Диалог скрыт
`'onCancel'`	Пользователь отменил действие
`'onPrompt'`	Пользователь ввел значение

`ModalEventName`

Имена событий метода Modal.show()

Значение	Описание
`'onShow'`	Модальное окно отображено
`'onHide'`	Модальное окно скрыто
`'onClose'`	Модальное окно закрыто пользователем

`SidepanelEventName`

Имена событий метода Sidepanel.show()

Значение	Описание
`'onShow'`	Боковая панель отображена
`'onHide'`	Боковая панель скрыта
`'onClose'`	Боковая панель закрыта пользователем

Events ​

Типы ​

EventCallback ​

EventCallbacks ​

FrameEventName ​

FrameOpenUrlEventName ​

FrameOpenHomepageEventName ​

OAuth2EventName ​

ToastEventName ​

SwalEventName ​

ModalEventName ​

SidepanelEventName ​