Explore métodos y eventos de Metaframe
Objeto window.metaframe
Una vez cargado el script, el objeto metaframe está disponible en el objeto window global de su aplicación. El objeto metaframe contiene una lista de métodos necesarios para gestionar el Metaframe en su aplicación web.
Método window.metaframe.create
Firma del método:
window.metaframe.create: (parameters: {
loginProjectId: string,
merchantId?: number,
projectId?: number,
orbsApiHostId?: string,
isMobile?: boolean,
}) => void;
Inicia Metaframe en su aplicación web. El método acepta el objeto parameters con los siguientes parámetros necesarios para ejecutar Metaframe:
| Parámetro | Tipo | Descripción |
|---|---|---|
loginProjectId | string | ID de Login. Para obtenerlo, abra la Cuenta del editor y acceda a Login > Dashboard > la sección de su proyecto de Login. Obligatorio. |
merchantId | string | ID de comerciante. Encontrará este parámetro en su Cuenta del editor:
|
projectID | string | ID de proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.Obligatorio si la función Backpack está habilitada en la configuración del proyecto en la Cuenta del editor. |
orbsApiHostId | string | ID del host. Para obtenerlo, contacte con el equipo de integración enintegration@xsolla.com o con su gestor del éxito del cliente escribiendo a csm@xsolla.com y transmita el ID del proyecto y el ID del comerciante.Obligatorio si la función Virtual currencies está habilitada en la configuración del proyecto en la Cuenta del editor. |
isMobile | boolean | Si Metaframe utiliza el diseño para móviles por defecto. |
Método window.metaframe.setIsMobile
Firma del método:
window.metaframe.setIsMobile(isMobile: boolean)
Cambia Metaframe de la versión para ordenadores a la versión para móviles o viceversa.
| Parámetro | Tipo | Descripción |
|---|---|---|
isMobile | boolean | Si se cambia Metaframe a la versión para móviles. Si se establece como true, Metaframe cambia a la versión para móviles. Si se establece como false, Metaframe cambia a la versión para ordenadores. |
objeto window.metaframe.partnerActions
El objeto contiene métodos para realizar acciones en el Metaframe.
Antes de utilizar los métodos de este objeto, debe asegurarse de que el Metaframe está completamente cargado. Para ello, suscríbase al evento de carga del Metaframe. Si el evento se ha procesado, los métodos del objeto estarán disponibles.
Ejemplo de configuración de un agente de escucha del evento de carga de Metaframe:
- javascript
window.addEventListener("@metaframe-partner-events:app-loaded", () => {
//Here you can use partner actions
});
Método window.metaframe.partnerActions.openBackpackItemPage
Firma del método:
window.metaframe.partnerActions.openBackpackItemPage(itemId: string)
Abre la página del artículo especificado en la sección
Para que el método funcione correctamente, deben cumplirse las siguientes condiciones:
- La función Backpack está activada en Cuenta del editor.
- El usuario está autenticado en Metaframe.
| Parámetro | Tipo | Descripción |
|---|---|---|
itemId | string | ID interno del artículo que se transmite al llamar al método de la API para crear el artículo. |
Seguimiento de eventos
Puede suscribirse a los siguientes eventos de Metaframe:
| Parámetro | Tipo |
|---|---|
@metaframe-partner-events:app-loaded | El evento se desencadena cuando el Metaframe se descarga correctamente después de que se haya invocado el método window.metaframe.create. |
@metaframe-partner-events:login-successful | Este evento se desencadena cuando el usuario se conecta correctamente al Metaframe. Contiene un objeto detail con el token de autorización del usuario. |
@metaframe-partner-events:logout-successful | Este evento se desencadena cuando el usuario se desconecta correctamente del sistema. |
@metaframe:custom-action:<ACTION_ID> | El evento se desencadena cuando un usuario selecciona una sección personalizada del tipo Action en el Metaframe. Para obtener más información, consulte Seguimiento de eventos de las secciones personalizadas. |
Seguimiento de eventos de las secciones personalizadas
Puede añadir una sección personalizada al Metaframe con el tipo de Action. Esta sección aparece como un botón que realiza una acción, como abrir un sitio web.
Para seguir el evento de clic en una sección personalizada, debe suscribirse al evento @metaframe:custom-action:<ACTION_ID>, en el que <ACTION_ID> es el ID de acción generado en Cuenta del editor al configurar la sección personalizada.
Ejemplo de configuración de un agente de escucha para un evento de clic en una sección personalizada:
- javascript
document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
// Your code here...
})
¿Has encontrado una errata u otro error de texto? Selecciona el texto y pulsa Ctrl+Intro.
