Metaframe-Methoden und Ereignisse

window.metaframe-Objekt

Sobald das Skript geladen wurde, ist das metaframe-Objekt im globalen window-Objekt Ihrer Anwendung verfügbar. Das Metaframe-Objekt enthält eine Liste von Methoden, die für die Verwaltung von Metaframe in Ihrer Web-Anwendung erforderlich sind.

Methode window.metaframe.create

Signatur der Methode:

window.metaframe.create: (parameters: {
 loginProjectId: string,
 merchantId?: number,
 projectId?: number,
 orbsApiHostId?: string,
 isMobile?: boolean,
 isCollapsed?: boolean,
 layoutSettings?: {
     desktop: {
       widgetMarginTop?: number,
     },
     mobile: {
       widgetMarginTop?: number,
     },
   },
}) => void;

Initialisiert Metaframe in Ihrer Webanwendung.

Methode window.metaframe.setIsMobile

Signatur der Methode:

window.metaframe.setIsMobile(isMobile: boolean)

Wechselt Metaframe von der Desktop- zur mobilen Version und umgekehrt.

window.metaframe.partnerActions-Objekt

Das Objekt enthält Methoden, die Aktionen im Metaframe auslösen.

Bevor Sie Methoden an diesem Objekt anwenden, müssen Sie sicherstellen, dass Metaframe vollständig geladen wurde. Abonnieren Sie dafür das Metaframe Ladeereignis. Wenn das Ereignis verarbeitet wurde, sind die Methoden des Objekts verfügbar.

Beispiel für das Einrichten eines Listeners für das Metaframe-Ladeereignis:

window.addEventListener("@metaframe-partner-events:app-loaded", () => {

 //Here you can use partner actions

});

Methode window.metaframe.partnerActions.openBackpackItemPage

Signatur der Methode:

openBackpackItemPage: (itemId: string) => void;

Öffnet die Seite für den angegebenen Artikel im Abschnitt Backpack

Damit die Methode korrekt funktioniert, müssen folgende Bedingungen erfüllt sein:

• Die Funktion Rucksack ist im Kundenportal aktiviert.
• Der Benutzer ist bei Metaframe authentifiziert.

Methode window.metaframe.partnerActions.openLogin

Signatur der Methode:

openLogin: () => void;

Öffnet die Maske für die Nutzerautorisierung. Wenn der Nutzer bereits autorisiert ist, wird in der Browserkonsole ein Fehler angezeigt.

Methode window.metaframe.partnerActions.openProfile

Signatur der Methode:

openProfile: () => void;

Öffnet den Abschnitt Profile für den aktuellen Nutzer. Wenn der Nutzer nicht autorisiert ist, wird in der Browserkonsole ein Fehler angezeigt.

Methoden window.metaframe.partnerActions.openWallet

Signatur der Methode:

openWallet: () => void;

Öffnet den Abschnitt Wallet für den aktuellen Nutzer. Wenn der Nutzer nicht autorisiert ist, wird in der Browserkonsole ein Fehler angezeigt.

Methode window.metaframe.partnerActions.openBackpack

Signatur der Methode:

openBackpack: () => void;

Öffnet den Abschnitt Backpack für den aktuellen Nutzer. Wenn der Nutzer nicht autorisiert ist, wird in der Browserkonsole ein Fehler angezeigt.

Methode window.metaframe.partnerActions.openCustomMiniApp

Signatur der Methode:

openCustomMiniApp: (params: {miniAppName: string}) => void;

Öffnet den angegebenen benutzerdefinierten Abschnitt vom Typ Iframe, wenn eine der folgenden Bedingungen erfüllt ist:

• Wenn die Option Diese App vor der Nutzeranmeldung anzeigen in den Einstellungen des angegebenen benutzerdefinierten Abschnitts aktiviert ist und der aktuelle Nutzer nicht autorisiert ist.
• Wenn die Option Diese App nach der Nutzeranmeldung anzeigen in den Einstellungen des angegebenen benutzerdefinierten Abschnitts aktiviert ist und der aktuelle Nutzer autorisiert ist.

Wenn keine der Bedingungen erfüllt ist, wird in der Browserkonsole ein Fehler angezeigt.

Methoden window.metaframe.partnerActions.pushNotification

Signatur der Methode:

pushNotification: (params: {
  type: string; // use “success”, “warning”, “error” or “info”
  text: string;
  button?: {
    text: string;
    onClick: () => void;
  };
  durationInMs?: number;
}) => void;

Pusht eine neue Benachrichtigung in den Benachrichtigungsstapel.

Methode window.metaframe.partnerActions.setIsCustomMiniAppVisible

Signatur der Methode:

setIsCustomMiniAppVisible: (params: {
  miniAppName: string;
  isVisible: boolean;
}) => void;

Blendet den angegebenen benutzerdefinierten Abschnitt ein oder aus.

Widget-Ereignisse

Sie können folgende Metaframe-Ereignisse abonnieren:

Ereignisse in benutzerdefinierten Abschnitten nachverfolgen

Sie können dem Metaframe einen benutzerdefinierten Abschnitt vom Typ “Action” hinzufügen. Dieser Abschnitt erscheint als Schaltfläche, die beim Anklicken eine Aktion ausführt, z. B. eine Website öffnet.

Um das Ereignis nachzuverfolgen, bei dem ein benutzerdefinierter Abschnitt angeklickt wird, müssen Sie das Ereignis @metaframe:custom-action:<ACTION_ID> abonnieren, wobei die Aktions-ID <ACTION_ID> im Kundenportal bei der Einrichtung des benutzerdefinierten Abschnitts generiert wird.

Beispiel für das Einrichten eines Listeners für ein Klickereignis eines benutzerdefinierten Abschnitts:

document.addEventListener("@metaframe:custom-action:00000000-0000-0000-0000-000000000000", () => {

 // Your code here...

})