Découvrir les méthodes et événements Metaframe
Objet window.metaframe
Une fois le script chargé, l’objet metaframe devient accessible dans l’objet global window de votre application. Cet objet metaframe contient une série de méthodes essentielles pour gérer Metaframe dans votre application Web.
Méthode window.metaframe.create
Signature de la méthode :
window.metaframe.create: (parameters: {
loginProjectId: string,
merchantId?: number,
projectId?: number,
orbsApiHostId?: string,
isMobile?: boolean,
}) => void;
Initialise Metaframe dans votre application Web. La méthode accepte l’objet parameters avec les paramètres suivants nécessaires à l’exécution de Metaframe :
| Paramètre | Type | Description |
|---|---|---|
loginProjectId | string | ID de Login. Pour l’obtenir, ouvrez le Compte éditeur et accédez à la section Login > Dashboard > votre projet de Login. Obligatoire. |
merchantId | string | ID de commerçant. Ce paramètre se trouve dans le Compte éditeur :
|
projectID | string | ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.Obligatoire, si la fonction Backpack est activée dans les paramètres du projet dans le Compte éditeur. |
orbsApiHostId | string | ID d’hôte. Pour l’obtenir, contactez l’équipe d’intégration à integration@xsolla.com ou votre responsable de la réussite client à csm@xsolla.com, et communiquez l’ID du projet ou l’ID du commerçant.Obligatoire, si la fonction Virtual currencies est activée dans les paramètres du projet dans le Compte éditeur. |
isMobile | boolean | Détermine l’utilisation par Metaframe de la disposition mobile par défaut. |
Méthode window.metaframe.setIsMobile
Signature de la méthode :
window.metaframe.setIsMobile(isMobile: boolean)
Bascule Metaframe de la version bureau à la version mobile ou vice versa.
| Paramètre | Type | Description |
|---|---|---|
isMobile | boolean | Détermine si Metaframe doit utiliser la version mobile ou bureau. Si la valeur est true, Metaframe bascule vers la version mobile. Si la valeur est false, il passe à la version bureau. |
Objet window.metaframe.partnerActions
L’objet contient des méthodes permettant de déclencher des actions dans Metaframe.
Avant d’utiliser les méthodes de cet objet, vérifiez que Metaframe est entièrement chargé. Pour cela, souscrivez à l’événement de chargement de Metaframe. Une fois l’événement traité, les méthodes de l’objet deviennent disponibles.
Exemple d’implémentation d’un écouteur pour l’événement de chargement de Metaframe :
- javascript
window.addEventListener("@metaframe-partner-events:app-loaded", () => {
//Here you can use partner actions
});
Méthode window.metaframe.partnerActions.openBackpackItemPage
Signature de la méthode :
window.metaframe.partnerActions.openBackpackItemPage(itemId: string)
Ouvre la page de l’objet spécifié dans la section
Pour que la méthode fonctionne correctement, les conditions suivantes doivent être remplies :
- La fonction Backpack est activée dans le Compte éditeur.
- L’utilisateur est authentifié dans Metaframe.
| Paramètre | Type | Description |
|---|---|---|
itemId | string | ID interne de l’objet passé lors de l’appel à la méthode API pour créer l’objet. |
Suivi des événements
Vous pouvez vous abonner aux événements Metaframe suivants :
| Paramètre | Type |
|---|---|
@metaframe-partner-events:app-loaded | L’événement se déclenche lorsque Metaframe se charge avec succès, après l’appel à la méthode window.metaframe.create. |
@metaframe-partner-events:login-successful | Cet événement se déclenche lorsque l’utilisateur se connecte avec succès à Metaframe. Il inclut un objet detail contenant le jeton d’autorisation de l’utilisateur. |
@metaframe-partner-events:logout-successful | L’événement se déclenche lorsque l’utilisateur se déconnecte avec succès du système. |
@metaframe:custom-action:<ACTION_ID> | L’événement se déclenche lorsque l’utilisateur sélectionne une section personnalisée de type Action dans Metaframe. Pour plus d’informations, voir Suivi des événements des sections personnalisées. |
Suivi des événements des sections personnalisées
Vous pouvez ajouter une section personnalisée de type Action au Metaframe. Cette section apparaît sous forme de bouton et exécute une action, comme ouvrir un site Web, lorsque l’utilisateur clique dessus.
Pour suivre l’événement du clic sur une section personnalisée, vous devez vous abonner à l’événement @metaframe:custom-action:<ACTION_ID>, où <ACTION_ID> est l’ID de l’action généré dans le Compte éditeur lors de la configuration de la section personnalisée.
Exemple configuration d’un écouteur pour un événement de clic de section personnalisé :
- javascript
document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {
// Your code here...
})
Faute de frappe ou autre erreur dans le texte ? Sélectionnez le texte concerné et appuyez sur Ctrl+Entée.
