Integreer Mellowtel in je 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.

​

Vereisten

• Een Mellowtel-account en configuratiesleutel (verkrijg deze via het dashboard).
• Een Electron-applicatie met toegang tot het hoofdproces.

​

Installatie

​

1. Configureer npm Authenticatie

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

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

​

2. Installeer het Pakket

npm install @mellowtel-inc/mellowtel-electron

​

3. Voeg toe aan je Code

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


// Wanneer de app klaar is, maak het venster aan
app.whenReady().then(async () => {
  let win = createWindow();
  
  const mellowtel: Mellowtel = new Mellowtel('YOUR_CONFIGURATION_KEY');

  await mellowtel.requestConsent(win, "Krijg 3 maanden gratis")
  await mellowtel.init()
});

• new Mellowtel(configurationKey, options?) installeert de SDK. De enige beschikbare optie vandaag is disableLogs, die standaard op true staat. Zet het op false tijdens de integratie zodat je de verbindingsstatus en verzoekactiviteit in je terminal kunt zien.
• requestConsent(window, incentive) rendert een native Electron-berichtvenster gekoppeld aan het BrowserWindow dat je doorgeeft. Het tweede argument is de prominente kop van de dialoog (bijvoorbeeld, "Krijg 3 maanden gratis"), weergegeven boven een vaste uitleg van wat Mellowtel doet. Het lost op naar true als de gebruiker accepteert, false als de gebruiker weigert of de dialoog sluit, en undefined als toestemming al is vastgelegd. De SDK slaat de opt-in beslissing automatisch op, dus je hoeft daarna niet optIn() aan te roepen.
• init() gooit alleen een fout wanneer configurationKey leeg is. Als de gebruiker niet heeft ingestemd, logt het en keert het stilletjes terug. Anders opent het een WebSocket naar Mellowtel’s backend. De oproep is niet-blokkerend voor de renderer UI, dus vensters blijven responsief terwijl de verbinding wordt opgezet.

​

Voorkomen van systeemdialoogonderbrekingen (aanbevolen)

​

Gebruikersinstemming

1. Gebruik de ingebouwde native dialoog via requestConsent(window, incentive). Dit is het snelste pad en is wat het bovenstaande fragment laat zien. Het rendert een native Electron dialog.showMessageBox met je incentive tekst als de kop en slaat de beslissing van de gebruiker automatisch op.
2. Bouw je eigen toestemmings-UI en stuur de SDK aan via optIn(), optOut(), en getOptInStatus(). Gebruik dit als je aangepaste branding, rijkere uitleg of lokalisatie wilt die verder gaat dan wat de native dialoog biedt.

​

Wat je toestemmingsdialoog moet bevatten

​

Laat gebruikers later hun toestemming wijzigen

​

Methode Referentie

• init(): Promise<void> start de service als de gebruiker heeft ingestemd, of keert stilletjes vroegtijdig terug als dat niet het geval is. Gooit alleen een fout als de configuratiesleutel leeg is.
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> toont de ingebouwde native toestemmingsdialoog en slaat het resultaat op. Geeft true terug bij acceptatie, false bij weigering of sluiten, undefined als toestemming al was gegeven.
• showConsentSettings(window: BrowserWindow): Promise<void> toont de ingebouwde beheertoestemmingsdialoog. De SDK behandelt de opt-in / opt-out overgangen intern wanneer de gebruiker zijn keuze wijzigt.

• optIn(): Promise<void> markeert de gebruiker als ingestemd zonder een dialoog te tonen. Gebruik dit alleen nadat je toestemming hebt verzameld via je eigen UI.
• optOut(): Promise<void> markeert de gebruiker als uitgeschreven en sluit de actieve WebSocket-verbinding.
• getOptInStatus(): boolean | undefined geeft de huidige opt-in status terug, of undefined als de gebruiker nog nooit een keuze heeft gemaakt.
• getNodeId(): string geeft de Mellowtel knooppuntidentificatie voor deze installatie terug. Handig bij het indienen van supporttickets.

• getTotalRequestCount(): number geeft het totale aantal verwerkte verzoeken sinds installatie terug.
• getDailyRequestCount(): number geeft het aantal vandaag verwerkte verzoeken terug.
• getRequestCountForDate(date: string): number geeft het aantal voor een specifieke YYYY-MM-DD datum terug.
• getDailyRequestsHistory(): { [date: string]: number } geeft elke dagelijkse telling als een kaart terug.
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } geeft tellingen voor een datumbereik terug.
• getRequestCounts(): { total: number; daily: number; dailyHistory: { [date: string]: number } } geeft alle drie de tellers in één oproep terug.

​

Afsluiten en Levenscyclus

​

Toestemming Persistentie

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

​

Probleemoplossing