Integriere Mellowtel in deine Electron-App

​

Voraussetzungen

• Ein Mellowtel-Konto und ein Konfigurationsschlüssel (erhalte deinen im Dashboard).
• Eine Electron-Anwendung mit Zugriff auf den Hauptprozess.

​

Installation

​

1. Paket installieren

npm install mellowtel-electron

​

2. In deinen Code einfügen

import { app, BrowserWindow } from 'electron';
import Mellowtel, { setupMellowtelApp } from 'mellowtel-electron';

// Optional: vor app.ready aufrufen, um unerwartete OS-Aufforderungen zu reduzieren
setupMellowtelApp();

// Wenn die App bereit ist, erstelle das Fenster
app.whenReady().then(async () => {
  let win = createWindow();

  const mellowtel: Mellowtel = new Mellowtel('YOUR_CONFIGURATION_KEY');

  await mellowtel.requestConsent(win, "Erhalte 3 Monate kostenlos")
  await mellowtel.init()
});

• new Mellowtel(configurationKey, options?) instanziiert das SDK. Die einzige heute verfügbare Option ist disableLogs, die standardmäßig auf true gesetzt ist. Setze sie auf false, während du integrierst, damit du den Verbindungsstatus und die Anforderungsaktivität in deinem Terminal sehen kannst.
• requestConsent(window, incentive) rendert eine native Electron-Nachricht verankert an das übergebene BrowserWindow. Das zweite Argument ist die prominente Überschrift des Dialogs (zum Beispiel, "Erhalte 3 Monate kostenlos"), die über einer festen Erklärung dessen, was Mellowtel tut, angezeigt wird. Es wird true zurückgegeben, wenn der Benutzer akzeptiert, false, wenn der Benutzer ablehnt oder den Dialog schließt, und undefined, wenn bereits eine Einwilligung vorliegt. Das SDK speichert die Opt-in-Entscheidung automatisch, sodass du danach nicht optIn() aufrufen musst.
• init() wirft nur, wenn configurationKey leer ist. Wenn der Benutzer nicht zugestimmt hat, wird protokolliert und ohne Start zurückgegeben. Andernfalls verbindet es sich mit Mellowtel, damit es Anfragen verarbeiten kann. Der Aufruf blockiert nicht die Renderer-UI, sodass Fenster reaktionsfähig bleiben, während die Verbindung hergestellt wird.

​

Optional: unerwartete OS-Aufforderungen reduzieren

​

Benutzereinwilligung

1. Verwende den eingebauten nativen Dialog über requestConsent(window, incentive). Dies ist der schnellste Weg und wird im obigen Snippet gezeigt. Es rendert ein natives Electron dialog.showMessageBox mit deinem Anreiztext als Überschrift und speichert die Entscheidung des Benutzers automatisch.
2. Erstelle deine eigene Einwilligungs-UI und steuere das SDK über optIn(), optOut() und getOptInStatus(). Verwende dies, wenn du benutzerdefiniertes Branding, reichhaltigere Erklärungen oder Lokalisierung über das hinaus möchtest, was der native Dialog bietet.

​

Was dein Einwilligungsdialog enthalten muss

​

Ermögliche Benutzern, ihre Einwilligung später zu ändern

​

Methodenreferenz

• init(): Promise<void> startet den Dienst, wenn der Benutzer zugestimmt hat, oder gibt ohne Start zurück, wenn nicht. Wirft nur, wenn der Konfigurationsschlüssel leer ist.
• shutdown(): Promise<void> bereinigt SDK-Ressourcen, wenn die Anwendung geschlossen wird. Schließt die Verbindung zu Mellowtel, gibt isolierte Anforderungsfenster frei und löscht Hintergrundtimer. Bewahrt die Opt-in-Präferenz des Benutzers.
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> zeigt den eingebauten nativen Einwilligungsdialog an und speichert das Ergebnis. Gibt true bei Zustimmung, false bei Ablehnung oder Schließen zurück, undefined, wenn bereits eine Einwilligung vorliegt.
• showConsentSettings(window: BrowserWindow): Promise<void> zeigt den eingebauten Einwilligungsverwaltungsdialog an. Das SDK verwaltet die Opt-in/Opt-out-Übergänge intern, wenn der Benutzer seine Wahl umschaltet.

• optIn(): Promise<void> markiert den Benutzer als zugestimmt, ohne einen Dialog anzuzeigen. Verwende dies nur, nachdem du die Einwilligung über deine eigene UI eingeholt hast.
• optOut(): Promise<void> markiert den Benutzer als abgemeldet und führt eine vollständige Bereinigung durch (gleiche Ressourcen wie shutdown(), plus Löschen der gespeicherten Einwilligungspräferenz). Es ist nicht erforderlich, shutdown() danach aufzurufen.
• getOptInStatus(): boolean | undefined gibt den aktuellen Opt-in-Status zurück, oder undefined, wenn der Benutzer noch keine Wahl getroffen hat.
• getNodeId(): string gibt die Mellowtel-Knotenkennung für diese Installation zurück. Nützlich beim Einreichen von Support-Tickets.

• getTotalRequestCount(): number gibt die Gesamtanzahl der seit der Installation verarbeiteten Anfragen zurück.
• getDailyRequestCount(): number gibt die Anzahl der heute verarbeiteten Anfragen zurück.
• getRequestCountForDate(date: string): number gibt die Anzahl für ein bestimmtes YYYY-MM-DD-Datum zurück.
• getDailyRequestsHistory(): { [date: string]: number } gibt jede tägliche Zählung als Karte zurück.
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } gibt Zählungen für einen Datumsbereich zurück.
• getRequestCounts(): { total: number; daily: number; dailyHistory: { [date: string]: number } } gibt alle drei Zähler in einem Aufruf zurück.

​

Lebenszyklus und App-Schließung

• Schließt die Verbindung zu Mellowtel.
• Gibt isolierte Anforderungsfenster frei.
• Löscht Hintergrundtimer.
• Bewahrt die Opt-in-Präferenz des Benutzers.

​

Einzel-Fenster-Anwendungen

mainWindow.on('closed', async () => {
  mainWindow = null;

  if (process.platform !== 'darwin') {
    await mellowtel.shutdown();
    app.quit();
  }
});

​

Tray-Anwendungen

trayQuitItem.click = async () => {
  await mellowtel.shutdown();
  app.quit();
};

​

macOS-Anwendungen

​

Abmelden

await mellowtel.optOut();

​

Erneut starten

await mellowtel.optIn(); // Nur nach optOut() erforderlich
await mellowtel.init();

​

Einwilligungsspeicherung

• macOS: ~/Library/Application Support/<YourAppName>/config.json
• Windows: %APPDATA%\<YourAppName>\config.json
• Linux: ~/.config/<YourAppName>/config.json

​

Fehlerbehebung