Ir para a navegação

Métodos de instância

Controle uma instância de widget criada após TradingWidget.create().

Ver como Markdown

Resumo do método

MétodoPropósito
destruir()Remova o iframe e libere ouvintes de eventos.
getState()Leia o estado atual do ciclo de vida SDK.
whenReady()Aguarde até que o iframe termine a inicialização.
setSymbol(símbolo)Troque o par de negociação dentro do iframe.
setTheme(tema)Atualize o parâmetro do tema iframe.
setLocale(localidade)Mude o idioma do iframe.
setSize(largura, altura)Atualize as dimensões do iframe.
recarregar()Recarregue o iframe atual.
refreshAuth(motivo)Acione o fluxo de atualização de autenticação do widget.
setTokenProvider(provedor)Substitua o provedor usado pelo modo token de parceiro.
on(evento, manipulador)Assine eventos de tempo de execução e receba uma função de cancelamento de assinatura.

destruir()

Remova o iframe, limpe os ouvintes e emita destruído uma vez para a instância atual.

widget.destroy()

getState()

Leia o estado atual do ciclo de vida da instância do widget.

const state = widget.getState()

Os valores de retorno incluem carregamento, autenticação, pronto, erro e destruído.

whenReady()

Aguarde até que o iframe termine a inicialização antes de executar a lógica da UI dependente.

await widget.whenReady()

setSymbol(símbolo)

Troque o par de negociação dentro do iframe. Se o iframe ainda estiver inicializando, o SDK coloca o comando na fila e o envia depois de pronto.

widget.setSymbol('ETHUSDT')

setTheme(tema)

Atualize o parâmetro do tema usado pelo iframe de negociação incorporado.

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

setLocale(localidade)

Mude o idioma do iframe. Os valores suportados são en, en-US e zh-CN.

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

setSize(largura, altura)

Atualize o tamanho do iframe DOM e notifique o iframe sobre o novo tamanho externo. Os valores numéricos são convertidos em px.

widget.setSize('100%', 720)

recarregar()

Recarregue o iframe atual e espere que ele seja inicializado novamente.

widget.reload()

refreshAuth(motivo)

Peça ao iframe para atualizar o fluxo de autenticação atual. O valor de motivo opcional é encaminhado para registro e controle de fluxo.

widget.refreshAuth('manual')

setTokenProvider(provedor)

Substitua o tokenProvider usado pelo modo token de parceiro. O SDK chama o provedor quando o iframe solicita um novo token incorporado.

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(evento, manipulador)

Inscreva-se em um evento de tempo de execução. A função retornada remove o ouvinte.

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

Guias de widgets relacionados

Métodos adicionais no tempo de execução v1 atual

MétodoPropósito
whenRendered()Aguarde a notificação renderizada do iframe; isso é separado do pronto.
setPage(page)Solicite uma página de produto compatível na instância atual. Não altera o ambiente dos fundos.
prepareForRecreate()Peça um iframe pronto para se preparar para substituição; retorna uma promessa e pode rejeitar se estiver indisponível, ocupado ou expirado.
cancelRecreate()Cancele um fluxo de substituição pendente/preparado.
TradingWidget.validateOptions(options)Valide as opções de inicialização antes de criar uma instância.

Para uma alteração de usuário ou de ambiente real/de demonstração, destrua a instância antiga e crie uma nova com a autenticação e o modo de destino. Não use setPage como uma opção de ambiente. Verifique os recursos antes de usar métodos opcionais.

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