Explore os métodos e eventos Metaframe

Objeto window.metaframe

Quando o script é carregado, o objeto metaframe está disponível no objeto global window do seu aplicativo. O objeto metaframe contém uma lista de métodos necessários para gerenciar o Metaframe no seu aplicativo web.

Método window.metaframe.create

Método de assinatura:

Copy
Full screen
Small screen
 1window.metaframe.create: (parameters: {
 2 loginProjectId: string,
 3 merchantId?: number,
 4 projectId?: number,
 5 orbsApiHostId?: string,
 6 isMobile?: boolean,
 7 isCollapsed?: boolean,
 8 layoutSettings?: {
 9     desktop: {
10       widgetMarginTop?: number,
11     },
12     mobile: {
13       widgetMarginTop?: number,
14     },
15   },
16}) => void;

Inicializa o Metaframe no seu aplicativo web.

ParâmetroTipoDescrição
parameters
objectObjeto com parâmetros para inicializar o Metaframe.
parameters.loginProjectId
stringID de login. Para obtê-lo, abra a Conta de Distribuidor e vá para a seção Players > Login > Dashboard > Seu projeto de login. Obrigatório.
parameters.merchantId
stringID de comerciante. Você pode encontrar esse parâmetro em sua Conta de Distribuidor:
  • na seção Company settings > Company.
  • no URL na barra de endereço do navegador em qualquer página da Conta de Distribuidor. O URL possui o seguinte formato: https:​//publisher.xsolla.com/<merchantId>/.
Obrigatório, se a função Virtual currencies ou Backpack estiver habilitada nas configurações do projeto na Conta de Distribuidor.
parameters.projectID
stringID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Obrigatório, se a função Backpack estiver habilitada nas configurações do projeto na Conta de Distribuidor.
parameters.orbsApiHostId
stringHost ID. Para obtê-lo, entre em contato com a equipe de integração via integration@xsolla.com ou fale com o seu Gerente de Sucesso do Cliente pelo endereço csm@xsolla.com e passe o ID do projeto e ID do comerciante.
Obrigatório, se a função Virtual currencies estiver habilitada nas configurações do projeto na Conta de Distribuidor.
parameters.isMobile
booleanSe o Metaframe deve usar o layout móvel por padrão ou não.
parameters.isCollapsed
booleanSe o widget é exibido minimizado por padrão. O valor padrão é true.
parameters.layoutSettings
objectObjeto com parâmetros para personalizar o layout do widget.
parameters.layoutSettings.desktop
objectObjeto com parâmetros para personalizar o layout da versão desktop do widget. Obrigatório.
parameters.layoutSettings.desktop.widgetMarginTop
numberA margem de cima para o widget Metaframe em relação à tela de visualização (em px). O valor padrão é 16.
parameters.parameters.layoutSettings.mobile
objectObjeto com parâmetros para personalizar o layout da versão móvel do widget. Obrigatório.
parameters.layoutSettings.mobile.widgetMarginTop
numberA margem de cima para o widget Metaframe em relação à tela de visualização (em px). O valor padrão é 72.
Observação
A localização do widget na versão móvel pode ser configurada na Conta de Distribuidor. Informações detalhadas são fornecidas na seção Setting up mobile version.

Método window.metaframe.setIsMobile

Método de assinatura:

Copy
Full screen
Small screen
1window.metaframe.setIsMobile(isMobile: boolean)

Troca o Metaframe da versão desktop para a versão móvel, ou vice-versa.

ParâmetroTipoDescrição
isMobile
booleanSe o Metaframe deve trocar para a versão móvel ou não. Se definido como true, o Metaframe troca para a versão móvel. Se definido como false, o Metaframe troca para a versão desktop.
Observação
A localização do widget na versão móvel pode ser configurada na Conta de Distribuidor. Informações detalhadas são fornecidas na seção Setting up mobile version.

Objeto window.metaframe.partnerActions

O objeto contém métodos para acionar ações no Metaframe.

Antes de usar os métodos desse objeto, você deve garantir que o Metaframe seja totalmente carregado. Para fazer isso, inscreva-se no evento de carregamento Metafraem. Se o evento foi processado, os métodos do objeto ficarão disponíveis.

Exemplo de configuração de um ouvinte ao evento de carregamento do Metaframe:

Copy
Full screen
Small screen
1window.addEventListener("@metaframe-partner-events:app-loaded", () => {
2
3 //Here you can use partner actions
4
5});

Método window.metaframe.partnerActions.openBackpackItemPage

Método de assinatura:

Copy
Full screen
Small screen
1openBackpackItemPage: (itemId: string) => void;

Abre a página para um item especificado na seção Backpack.

Para que o método funcione corretamente, as seguintes condições devem ser cumpridas:

  • A função Backpack deve estar ativada na Conta de Distribuidor.
  • O usuário deve estar autenticado no Metaframe.

ParâmetroTipoDescrição
itemId
stringID interno do item que é passado ao chamar o método API para criar o item.

Método window.metaframe.partnerActions.openLogin

Método de assinatura:

Copy
Full screen
Small screen
1openLogin: () => void;

Abre o formulário de autorização do usuário. Se o usuário já está autorizado, é exibido um erro no console do navegador.

Método window.metaframe.partnerActions.openProfile

Método de assinatura:

Copy
Full screen
Small screen
1openProfile: () => void;

Abre seção Profile para o usuário atual. Se o usuário não for autorizado, um erro é exibido no console do navegador.

Métodos window.metaframe.partnerActions.openWallet

Método de assinatura:

Copy
Full screen
Small screen
1openWallet: () => void;

Abre a seção Wallet para o usuário atual. Se o usuário não for autorizado, um erro é exibido no console do navegador.

Observação
Para o método funcionar corretamente, a seção Wallet deve ser configurada no widget.

Método window.metaframe.partnerActions.openBackpack

Método de assinatura:

Copy
Full screen
Small screen
1openBackpack: () => void;

Abra a seção Backpack para o usuário atual. Se o usuário não for autorizado, um erro é exibido no console do navegador.

Observação
Para que o método funcione corretamente, as seguintes condições devem ser cumpridas:
  • A função Backpack deve estar ativada na Conta de Distribuidor.
  • O usuário deve estar autenticado no Metaframe.

Método window.metaframe.partnerActions.openCustomMiniApp

Método de assinatura:

Copy
Full screen
Small screen
1openCustomMiniApp: (params: {miniAppName: string}) => void;

Abre a seção personalizada especificada com o tipo Iframe se uma das seguintes condições for cumprida:

  • Se a opção Show this app before user login estiver ativa nas configurações da seção personalizada especificada, e o usuário atual não estiver autorizado.
  • Se a opção Show this app after user login estiver ativa nas configurações da seção personalizada especificada, e o usuário atual estiver autorizado.

Se as condições não forem cumpridas, é exibido um erro no console do navegador.

Observação
Para o método funcionar corretamente, deve ser configurada no widget uma seção personalizada com o tipo iframe. Antes de chamar o método, verifique que o widget Metaframe carregou com sucesso a seção personalizada especificada. Para fazer isso, acompanhe os eventos de carregamento das seções personalizadas.
ParâmetroTipoDescrição
params
objectObjeto com parâmetros.
params.miniAppName
stringNome de aplicativo especificado nas configurações da seção personalizada com o tipo Iframe. Obrigatório.

Métodos window.metaframe.partnerActions.pushNotification

Método de assinatura:

Copy
Full screen
Small screen
1pushNotification: (params: {
2  type: string; // use “success”, “warning”, “error” or “info”
3  text: string;
4  button?: {
5    text: string;
6    onClick: () => void;
7  };
8  durationInMs?: number;
9}) => void;

Coloca uma nova notificação no stack de notificações.

ParâmetroTipoDescrição
params
objectObjeto com parâmetros.
paramps.type
stringTipo de notificação. Possíveis valores: “success”, “warning”, “error”, “info”. Obrigatório.
paramps.text
stringTexto de notificação. Obrigatório.
params.button.text
stringTexto do botão. Obrigatório.
params.button.onClick
() => voidA função que é chamada quando o botão for clicado. Obrigatório.
params.durationInMs
numberDuração da exibição de notificação na tela em milissegundos.

Método window.metaframe.partnerActions.setIsCustomMiniAppVisible

Método de assinatura:

Copy
Full screen
Small screen
1setIsCustomMiniAppVisible: (params: {
2  miniAppName: string;
3  isVisible: boolean;
4}) => void;

Mostra ou esconde a seção personalizada especificada.

Observação
Para o método funcionar corretamente, deve ser configurada uma seção personalizada no widget. Antes de chamar o método, verifique que o widget Metaframe carregou com sucesso a seção personalizada especificada. Para fazer isso, acompanhe os eventos de carregamento das seções personalizadas.
ParâmetroTipoDescrição
params
objectObjeto com parâmetros.
params.miniAppName
stringNome de aplicativo especificado nas configurações da seção personalizada. Obrigatório.
params.isVisible
booleanSe a seção personalizada especificada deve ser exibida no widget. Obrigatório.

Eventos do Widget

Você pode inscrever-se nos seguintes eventos Metaframe:

ParâmetroTipo
@metaframe-partner-events:app-loadedO evento é acionado quando o Metaframe é carregado com sucesso depois que o método window.metaframe.create é chamado.
@metaframe-partner-events:not-authorized-mini-apps-loadedO evento é acionado quando o Metaframe carrega com sucesso as seções personalizadas nas configurações onde a opção Show this app before user login está ativada.
@metaframe-partner-events:authorized-mini-apps-loadedO evento é acionado quando o Metaframe carrega com sucesso todas as seções configuradas do widget, incluindo as seções personalizadas nas configurações onde a opção Show this app after user login está ativada.
@metaframe-partner-events:login-successfulEsse evento é acionado quando o usuário faz login com sucesso no Metaframe. Ele contém um objeto detail com o token de autorização do usuário.
@metaframe-partner-events:logout-successfulO evento é acionado quando um usuário sai de sua conta com sucesso.
@metaframe-partner-events:mini-app-menu-button-clicked:<YOUR_MINI_APP_NAME>O evento é acionado quando um usuário clica na seção personalizada Metaframe.
@metaframe:custom-action:<ACTION_ID>O evento é acionado quando um usuário seleciona uma seção personalizada do tipo Action no Metaframe. Para mais informações, veja Rastreamento de eventos de seções personalizadas.

Rastreamento de eventos de seções personalizadas

Você pode adicionar ao Metaframe uma seção personalizada com o tipo Action. Essa seção aparece como um botão que realiza uma ação ao ser acionado, tal como abrir um site.

Para rastrear o evento de clicar em uma seção personalizada, você precisa se inscrever ao evento @metaframe:custom-action:<ACTION_ID>, onde <ACTION_ID> é o ID de ação gerado na Conta de Distribuidor ao configurar uma seção personalizada.

Exemplo de configuração de um ouvinte para um evento de clique de seção personalizada:

Copy
Full screen
Small screen
1document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
2
3 // Your code here...
4
5})
Este artigo foi útil?
Obrigado!
Podemos melhorar alguma coisa? Mensagem
Que pena ouvir isso
Explique porque este artigo não foi útil para você. Mensagem
Obrigado pelo seu feedback!
Avaliaremos sua mensagem e a usaremos para melhorar sua experiência.
Última atualização: 19 de Setembro de 2025

Encontrou um erro de texto ou digitação? Selecione o texto e pressione Ctrl+Enter.

Relatar um problema
Nós sempre avaliamos nossos conteúdos. Seu feedback nos ajuda a melhorá-los.
Forneça um e-mail para que possamos responder
Obrigado pelo seu feedback!
Não conseguimos enviar seu feedback
Tente novamente mais tarde ou contate-nos via doc_feedback@xsolla.com.