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:
window.metaframe.create: (parameters: {
loginProjectId: string,
merchantId?: number,
projectId?: number,
orbsApiHostId?: string,
isMobile?: boolean,
}) => void;
Inicializa o Metaframe no seu aplicativo da web. O método aceita o objeto parameters com os seguintes parâmetros necessários para executar o Metaframe:
| Parâmetro | Tipo | Descrição |
|---|---|---|
loginProjectId | string | ID de login. Para obtê-lo, abra a Conta de Distribuidor e vá para a seção Login > Dashboard > Seu projeto de login. Obrigatório. |
merchantId | string | ID de comerciante. Você pode encontrar esse parâmetro em sua Conta de Distribuidor:
|
projectID | string | ID 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. |
orbsApiHostId | string | Host 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. |
isMobile | boolean | Se o Metaframe deve usar o layout móvel por padrão ou não. |
Método window.metaframe.setIsMobile
Método de assinatura:
window.metaframe.setIsMobile(isMobile: boolean)
Troca o Metaframe da versão desktop para a versão móvel, ou vice-versa.
| Parâmetro | Tipo | Descrição |
|---|---|---|
isMobile | boolean | Se 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. |
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:
- javascript
window.addEventListener("@metaframe-partner-events:app-loaded", () => {
//Here you can use partner actions
});
Método window.metaframe.partnerActions.openBackpackItemPage
Método de assinatura:
window.metaframe.partnerActions.openBackpackItemPage(itemId: string)
Abre a página para um item especificado na seçã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.
| Parâmetro | Tipo | Descrição |
|---|---|---|
itemId | string | ID interno do item que é passado ao chamar o método API para criar o item. |
Rastreamento de eventos
Você pode inscrever-se nos seguintes eventos Metaframe:
| Parâmetro | Tipo |
|---|---|
@metaframe-partner-events:app-loaded | O evento é acionado quando o Metaframe é carregado com sucesso depois que o método window.metaframe.create é chamado. |
@metaframe-partner-events:login-successful | Esse 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-successful | O evento é acionado quando um usuário sai de sua conta com sucesso. |
@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 uma seção personalizada ao Metaframe com o tipo Ação. 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:
- javascript
document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
// Your code here...
})
Encontrou um erro de texto ou digitação? Selecione o texto e pressione Ctrl+Enter.
