Skip to navigation

Методи екземплярів

Керуйте створеним екземпляром віджета після TradingWidget.create().

View as Markdown

Резюме методу

методпризначення
знищити()Видаліть iframe і звільніть прослуховувачі подій.
getState()Прочитайте поточний стан життєвого циклу SDK.
whenReady()Зачекайте, поки iframe завершить ініціалізацію.
setSymbol(символ)Переключіть торгову пару в iframe.
setTheme(тема)Оновіть параметр теми iframe.
setLocale(локаль)Змініть мову iframe.
setSize(ширина, висота)Оновіть розміри iframe.
перезавантажити()Перезавантажте поточний iframe.
refreshAuth(причина)Запустити процес оновлення авторизації віджета.
setTokenProvider(постачальник)Замініть постачальника, який використовується в режимі маркера партнера.
on(подія, обробник)Підпишіться на події виконання та отримайте функцію скасування підписки.

знищити()

Видаліть iframe, очистіть прослуховувачі та видаліть один раз для поточного екземпляра.

widget.destroy()

getState()

Прочитайте поточний стан життєвого циклу примірника віджета.

const state = widget.getState()

Повернуті значення включають завантаження, автентифікацію, готовність, помилку та знищено.

whenReady()

Зачекайте, поки iframe завершить ініціалізацію, перш ніж запускати залежну логіку інтерфейсу користувача.

await widget.whenReady()

setSymbol(символ)

Переключіть торгову пару в iframe. Якщо iframe все ще ініціалізується, SDK ставить команду в чергу та надсилає її після завершення.

widget.setSymbol('ETHUSDT')

setTheme(тема)

Оновіть параметр теми, який використовується вбудованим торговим iframe.

widget.setTheme('dark')
widget.setTheme('light')

setLocale(локаль)

Змініть мову iframe. Підтримувані значення: en, en-US і zh-CN.

widget.setLocale('en')
widget.setLocale('en-US')
widget.setLocale('zh-CN')

setSize(ширина, висота)

Оновіть розмір iframe DOM і повідомте iframe про новий зовнішній розмір. Числові значення перетворюються на px.

widget.setSize('100%', 720)

перезавантажити()

Перезавантажте поточний iframe і зачекайте, доки він знову ініціалізується.

widget.reload()

refreshAuth(причина)

Попросіть iframe оновити поточний потік автентифікації. Додаткове значення причини пересилається для журналювання та керування потоком.

widget.refreshAuth('manual')

setTokenProvider(постачальник)

Замініть tokenProvider, який використовується режимом маркера партнера. SDK викликає постачальника, коли iframe запитує новий маркер вбудовування.

widget.setTokenProvider(async ({ channelId, symbol, reason }) => {
const resp = await fetch('/api/trading/embed-token', {
method: 'POST',
credentials: 'include',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ channelId, symbol, reason }),
})
return resp.json()
})

on(подія, обробник)

Підпишіться на подію виконання. Повернена функція видаляє слухача.

const off = widget.on('order_created', (event) => {
console.log(event)
})
off()

Пов’язані посібники для віджетів

Додаткові методи в поточній версії 1

методпризначення
whenRendered()Зачекайте на відтворене сповіщення iframe; це окремо від готового.
setPage(page)Запит на сторінку підтримуваного продукту в поточному екземплярі. Це не змінює середовище використання коштів.
prepareForRecreate()Попросіть готовий iframe підготувати до заміни; повертає обіцянку та може відхилити, якщо недоступний, зайнятий або минув час очікування.
cancelRecreate()Скасувати потік очікуваної/підготовленої заміни.
TradingWidget.validateOptions(options)Перевірте параметри ініціалізації перед створенням екземпляра.

Для зміни користувацького або реального/демонстраційного середовища знищіть старий екземпляр і створіть новий із цільовою автентифікацією та режимом. Не використовуйте setPage як перемикач середовища. Перевірте можливості перед використанням додаткових методів.

if (TradingWidget.capabilities.methods.includes('whenRendered')) {
await widget.whenRendered();
}
if (TradingWidget.capabilities.pages.includes('up-down')) {
widget.setPage('up-down');
}