Przejdź do nawigacji

Metody instancji

Kontroluj utworzoną instancję widgetu po TradingWidget.create().

Zobacz jako Markdown

Podsumowanie metody

MetodaZamiar
zniszczyć()Usuń element iframe i zwolnij detektory zdarzeń.
getState()Odczytaj bieżący stan cyklu życia SDK.
whenReady()Poczekaj, aż element iframe zakończy inicjalizację.
setSymbol(symbol)Zmień parę handlową wewnątrz ramki iframe.
setTheme(motyw)Zaktualizuj parametr motywu iframe.
setLocale(lokalizacja)Zmień język elementu iframe.
setSize(szerokość, wysokość)Zaktualizuj wymiary elementu iframe.
przeładować()Załaduj ponownie bieżącą ramkę iframe.
refreshAuth(powód)Uruchom proces odświeżania uwierzytelniania widżetu.
setTokenProvider(dostawca)Zastąp dostawcę używanego przez tryb tokenu partnera.
on(zdarzenie, procedura obsługi)Subskrybuj zdarzenia wykonawcze i uzyskaj funkcję anulowania subskrypcji.

zniszczyć()

Usuń ramkę iframe, wyczyść słuchacze i raz zniszczoną emisję dla bieżącej instancji.

widget.destroy()

getState()

Przeczytaj bieżący stan cyklu życia instancji widżetu.

const state = widget.getState()

Zwracane wartości obejmują ładowanie, uwierzytelnianie, gotowość, błąd i zniszczenie.

whenReady()

Poczekaj, aż element iframe zakończy inicjalizację, zanim uruchomisz zależną logikę interfejsu użytkownika.

await widget.whenReady()

setSymbol(symbol)

Zmień parę handlową wewnątrz ramki iframe. Jeśli element iframe nadal się inicjuje, SDK umieszcza polecenie w kolejce i wysyła je po przygotowaniu.

widget.setSymbol('ETHUSDT')

setTheme(motyw)

Zaktualizuj parametr motywu używany przez osadzoną ramkę iframe handlową.

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

setLocale(lokalizacja)

Zmień język elementu iframe. Obsługiwane wartości to en, en-US i zh-CN.

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

setSize(szerokość, wysokość)

Zaktualizuj rozmiar elementu iframe DOM i powiadom element iframe o nowym rozmiarze zewnętrznym. Wartości numeryczne są konwertowane na piksele.

widget.setSize('100%', 720)

przeładować()

Załaduj ponownie bieżącą ramkę iframe i poczekaj, aż ponownie się zainicjuje.

widget.reload()

refreshAuth(powód)

Poproś element iframe o odświeżenie bieżącego przepływu uwierzytelniania. Opcjonalna wartość przyczyny jest przekazywana w celu rejestrowania i kontroli przepływu.

widget.refreshAuth('manual')

setTokenProvider(dostawca)

Zastąp tokenProvider używany przez tryb tokena partnera. SDK wywołuje dostawcę, gdy ramka iframe żąda nowego tokena do osadzenia.

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(zdarzenie, procedura obsługi)

Subskrybuj wydarzenie wykonawcze. Zwrócona funkcja usuwa słuchacza.

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

Powiązane przewodniki po widgetach

Dodatkowe metody w bieżącym środowisku wykonawczym wersji 1

MetodaZamiar
whenRendered()Poczekaj na wyrenderowane powiadomienie elementu iframe; jest to oddzielne od gotowego.
setPage(page)Poproś o obsługiwaną stronę produktu w bieżącej instancji. Nie zmienia to otoczenia funduszy.
prepareForRecreate()Poproś gotową ramkę iframe o przygotowanie do wymiany; zwraca obietnicę i może ją odrzucić, jeśli jest niedostępna, zajęta lub przekroczono limit czasu.
cancelRecreate()Anuluj oczekujący/przygotowany przepływ wymiany.
TradingWidget.validateOptions(options)Przed utworzeniem instancji sprawdź opcje inicjalizacji.

W przypadku zmiany środowiska użytkownika lub środowiska rzeczywistego/demo zniszcz starą instancję i utwórz nową z docelowym uwierzytelnianiem i trybem. Nie używaj setPage jako przełącznika środowiska. Sprawdź możliwości przed użyciem metod opcjonalnych.

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