Frame

Frame — основной объект SDK, представляющий текущее мини‑приложение в iframe платформы Аспро.Cloud. Является singleton — создаётся один раз через initialize() или обёртку App.initializeFrame().

import { Frame } from '@aspro-cloud/miniapp-jssdk'

Свойства

Modal

Ссылка на класс Modal

static Modal: typeof Modal

Sidepanel

Ссылка на класс Sidepanel

static Sidepanel: typeof Sidepanel

Swal

Ссылка на класс Swal

static Swal: typeof Swal

Toast

Ссылка на класс Toast

static Toast: typeof Toast

domain

Домен текущего аккаунта платформы Аспро.Cloud

get domain(): string

events

Объект типа EventCallbacks<FrameEventName> с обработчиками событий

get events(): EventCallbacks
set events(value: EventCallbacks)

https

Флаг HTTPS соединения

get https(): boolean

language

Текущий язык интерфейса платформы

get language(): string

options

Экземпляр Options для работы с настройками приложения

get options(): Options

rest

Экземпляр Rest для вызовов Rest API

get rest(): Rest

targetOrigin

Origin родительского окна, вычисляется автоматически

get targetOrigin(): string

uniqid

Уникальный идентификатор места встройки приложения

get uniqid(): string

userOptions

Экземпляр UserOptions для работы с настройками текущего пользователя

get userOptions(): UserOptions

Методы

initialize

Инициализирует мини‑приложение внутри iframe платформы Аспро.Cloud и возвращает singleton экземпляр Frame. Рекомендуется использовать обёртку App.initializeFrame()

static async initialize(params?: FrameParams): Promise<Frame>

Параметр	Тип	Описание
params	FrameParams	Параметры инициализации

События метода initialize():

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

Ошибки

Метод выбросит ошибку если:

• приложение запущено не в браузере
• приложение запущено не внутри iframe
• не удалось определить домен аккаунта платформы

getInstance

Возвращает текущий singleton экземпляр Frame. Вызывать только после initialize()

static getInstance(): Frame

destroy

Удаляет подписки и освобождает ресурсы

destroy(): void

getContext

Возвращает FrameContext — контекст текущего приложения

async getContext(): Promise<FrameContext>

openHomepage

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

async openHomepage(params: FrameOpenHomepageParams): Promise<any>

Параметр	Тип	Описание
params	FrameOpenHomepageParams	Параметры

События метода openHomepage():

Событие	Параметр	Тип	Описание
'onOpen'			Домашняя страница приложения открыта
'onCancel'			Открытие отменено

openUrl

Открывает URL в интерфейсе платформы. При переходе на внешний ресурс платформа запросит у пользователя подтверждение и откроет ссылку в новой вкладке браузера

async openUrl(params: FrameOpenUrlParams): Promise<any>

Параметр	Тип	Описание
params	FrameOpenUrlParams	Параметры

События метода openUrl():

Событие	Параметр	Тип	Описание
'onOpen'			URL успешно открыт
'onCancel'			Пользователь отменил действие

Пример

ESM

import { App, Toast } from '@aspro-cloud/miniapp-jssdk'

const frame = await App.initializeFrame({
  events: {
    onReady: (context) => {
      console.log(`Приложение готово к работе, полученный контекст: ${context}`)
    }
  }
})

// переход на страницу внутри платформы
await frame.openUrl({
  url: '/_module/crm/view/account_view/47547'
})

// переход на внешний ресурс (откроется в новой вкладке с подтверждением)
await frame.openUrl({
  url: 'https://aspro.cloud',
  events: {
    onOpen: () => console.log('Переход выполнен'),
    onCancel: () => console.log('Пользователь отменил переход')
  }
})

UMD

const App = window.ACloudMiniApp

const frame = await App.initializeFrame({
  events: {
    onReady: (context) => {
      console.log(`Приложение готово к работе, полученный контекст: ${context}`);
    }
  }
});

// переход на страницу внутри платформы
await frame.openUrl({
  url: '/_module/crm/view/account_view/47547'
});

// переход на внешний ресурс (откроется в новой вкладке с подтверждением)
await frame.openUrl({
  url: 'https://aspro.cloud',
  events: {
    onOpen: () => console.log('Переход выполнен'),
    onCancel: () => console.log('Пользователь отменил переход')
  }
});