Integriere Mellowtel in deine Electron-App

Documentation Index

Fetch the complete documentation index at: https://docs.mellowtel.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Voraussetzungen

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

​

Installation

​

1. Konfiguriere npm-Authentifizierung

@mellowtel-inc:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_NPM_TOKEN

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

​

2. Installiere das Paket

npm install @mellowtel-inc/mellowtel-electron

​

3. Füge es deinem Code hinzu

import { app, BrowserWindow } from 'electron';
import Mellowtel from '@mellowtel-inc/mellowtel-electron';


// 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 derzeit 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 ein natürliches Electron-Nachrichtenfenster, das an das übergebene BrowserWindow verankert ist. Das zweite Argument ist die auffällige Ü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 Nutzer akzeptiert, false, wenn der Nutzer ablehnt oder den Dialog schließt, und undefined, wenn die Zustimmung bereits vorliegt. Das SDK speichert die Opt-in-Entscheidung automatisch, sodass du optIn() danach nicht aufrufen musst.
• init() wirft nur, wenn configurationKey leer ist. Wenn der Nutzer nicht zugestimmt hat, protokolliert es und gibt stillschweigend zurück. Andernfalls öffnet es einen WebSocket zum Mellowtel-Backend. Der Aufruf blockiert nicht die Renderer-UI, sodass Fenster reaktionsfähig bleiben, während die Verbindung hergestellt wird.

​

Verhindern von Systemdialogunterbrechungen (empfohlen)

​

Nutzerzustimmung

1. Verwende den eingebauten nativen Dialog über requestConsent(window, incentive). Dies ist der schnellste Weg und wird im obigen Snippet gezeigt. Es rendert einen nativen Electron dialog.showMessageBox mit deinem Anreiztext als Überschrift und speichert die Entscheidung des Nutzers automatisch.
2. Erstelle deine eigene Zustimmungs-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 Zustimmungsdialog enthalten muss

​

Erlaube Nutzern, ihre Zustimmung später zu ändern

​

Methodenreferenz

• init(): Promise<void> startet den Dienst, wenn der Nutzer zugestimmt hat, oder gibt stillschweigend frühzeitig zurück, wenn nicht. Wirft nur, wenn der Konfigurationsschlüssel leer ist.
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> zeigt den eingebauten nativen Zustimmungsdialog und speichert das Ergebnis. Gibt true bei Zustimmung, false bei Ablehnung oder Schließen, undefined, wenn die Zustimmung bereits gegeben wurde, zurück.
• showConsentSettings(window: BrowserWindow): Promise<void> zeigt den eingebauten Dialog zur Verwaltung der Zustimmung. Das SDK behandelt die Opt-in / Opt-out-Übergänge intern, wenn der Nutzer seine Wahl umschaltet.

• optIn(): Promise<void> markiert den Nutzer als zugestimmt, ohne einen Dialog anzuzeigen. Verwende dies nur, nachdem du die Zustimmung über deine eigene UI eingeholt hast.
• optOut(): Promise<void> markiert den Nutzer als abgelehnt und schließt die aktive WebSocket-Verbindung.
• getOptInStatus(): boolean | undefined gibt den aktuellen Opt-in-Status zurück, oder undefined, wenn der Nutzer 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 Anzahl als Karte zurück.
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } gibt die Anzahlen 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.

​

Herunterfahren und Lebenszyklus

​

Zustimmungsspeicherung

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

​

Fehlerbehebung