अपने Electron ऐप में Mellowtel को एकीकृत करें

​

पूर्व आवश्यकताएँ

• एक Mellowtel खाता और कॉन्फ़िगरेशन कुंजी (अपना डैशबोर्ड से प्राप्त करें)।
• एक Electron एप्लिकेशन जिसमें मुख्य प्रक्रिया तक पहुंच हो।

​

स्थापना

​

1. npm प्रमाणीकरण कॉन्फ़िगर करें

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

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

​

2. पैकेज इंस्टॉल करें

npm install @mellowtel-inc/mellowtel-electron

​

3. अपने कोड में जोड़ें

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


// जब ऐप तैयार हो, विंडो बनाएं
app.whenReady().then(async () => {
  let win = createWindow();
  
  const mellowtel: Mellowtel = new Mellowtel('YOUR_CONFIGURATION_KEY');

  await mellowtel.requestConsent(win, "3 महीने मुफ्त प्राप्त करें")
  await mellowtel.init()
});

• new Mellowtel(configurationKey, options?) SDK को इंस्टेंटिएट करता है। आज उपलब्ध एकमात्र विकल्प disableLogs है, जो डिफ़ॉल्ट रूप से true है। इसे false पर सेट करें ताकि आप अपने टर्मिनल में कनेक्शन स्थिति और अनुरोध गतिविधि देख सकें।
• requestConsent(window, incentive) एक मूल Electron संदेश बॉक्स प्रस्तुत करता है जिसे आप पास किए गए BrowserWindow से एंकर किया जाता है। दूसरा तर्क संवाद का प्रमुख शीर्षक है (उदाहरण के लिए, "3 महीने मुफ्त प्राप्त करें"), जो Mellowtel क्या करता है, के एक स्थिर स्पष्टीकरण के ऊपर दिखाया गया है। यदि उपयोगकर्ता स्वीकार करता है तो यह true पर हल करता है, यदि उपयोगकर्ता अस्वीकार करता है या संवाद बंद करता है तो false, और यदि सहमति पहले से फ़ाइल में है तो undefined। SDK स्वचालित रूप से ऑप्ट-इन निर्णय को बनाए रखता है, इसलिए आपको बाद में optIn() कॉल करने की आवश्यकता नहीं है।
• init() केवल तभी फेंकता है जब configurationKey खाली हो। यदि उपयोगकर्ता ने ऑप्ट-इन नहीं किया है, तो यह लॉग करता है और चुपचाप लौटता है। अन्यथा यह Mellowtel के बैकएंड के लिए एक WebSocket खोलता है। कॉल रेंडरर UI के लिए गैर-अवरोधक है, इसलिए जब कनेक्शन स्थापित होता है तब भी विंडो उत्तरदायी रहती हैं।

​

सिस्टम संवाद व्यवधानों को रोकना (अनुशंसित)

​

उपयोगकर्ता सहमति

1. बिल्ट-इन मूल संवाद का उपयोग करें requestConsent(window, incentive) के माध्यम से। यह सबसे तेज़ रास्ता है और यही ऊपर दिया गया स्निपेट दिखाता है। यह आपके प्रोत्साहन कॉपी को शीर्षक के रूप में प्रदर्शित करते हुए एक मूल Electron dialog.showMessageBox प्रस्तुत करता है और उपयोगकर्ता के निर्णय को स्वचालित रूप से बनाए रखता है।
2. अपना स्वयं का सहमति UI बनाएं और SDK को optIn(), optOut(), और getOptInStatus() के माध्यम से चलाएं। इसका उपयोग करें यदि आप कस्टम ब्रांडिंग, समृद्ध स्पष्टीकरण, या मूल संवाद से परे स्थानीयकरण चाहते हैं।

​

आपके सहमति संवाद में क्या शामिल होना चाहिए

​

उपयोगकर्ताओं को बाद में अपनी सहमति बदलने दें

​

विधि संदर्भ

• init(): Promise<void> सेवा शुरू करता है यदि उपयोगकर्ता ने ऑप्ट-इन किया है, या चुपचाप जल्दी लौटता है यदि नहीं। केवल तभी फेंकता है जब कॉन्फ़िगरेशन कुंजी खाली हो।
• requestConsent(window: BrowserWindow, incentive: string): Promise<boolean | undefined> बिल्ट-इन मूल सहमति संवाद दिखाता है और परिणाम को बनाए रखता है। स्वीकार करने पर true लौटाता है, अस्वीकार या बंद करने पर false, यदि सहमति पहले से दी गई हो तो undefined।
• showConsentSettings(window: BrowserWindow): Promise<void> बिल्ट-इन प्रबंध-सहमति संवाद दिखाता है। जब उपयोगकर्ता अपनी पसंद टॉगल करता है तो SDK आंतरिक रूप से ऑप्ट-इन / ऑप्ट-आउट संक्रमणों को संभालता है।

• optIn(): Promise<void> उपयोगकर्ता को ऑप्ट-इन के रूप में चिह्नित करता है बिना कोई संवाद दिखाए। इसका उपयोग केवल अपने स्वयं के UI के माध्यम से सहमति एकत्र करने के बाद करें।
• optOut(): Promise<void> उपयोगकर्ता को ऑप्ट-आउट के रूप में चिह्नित करता है और सक्रिय WebSocket कनेक्शन को बंद करता है।
• getOptInStatus(): boolean | undefined वर्तमान ऑप्ट-इन स्थिति लौटाता है, या undefined यदि उपयोगकर्ता ने कभी कोई विकल्प नहीं बनाया हो।
• getNodeId(): string इस स्थापना के लिए Mellowtel नोड पहचानकर्ता लौटाता है। समर्थन टिकट दाखिल करते समय उपयोगी।

• getTotalRequestCount(): number स्थापना के बाद से संसाधित कुल अनुरोध लौटाता है।
• getDailyRequestCount(): number आज संसाधित अनुरोधों की संख्या लौटाता है।
• getRequestCountForDate(date: string): number एक विशिष्ट YYYY-MM-DD तिथि के लिए गणना लौटाता है।
• getDailyRequestsHistory(): { [date: string]: number } हर दैनिक गणना को एक मैप के रूप में लौटाता है।
• getRequestCountsInRange(startDate: string, endDate: string): { [date: string]: number } एक तिथि सीमा के लिए गणनाएँ लौटाता है।
• getRequestCounts(): { total: number; daily: number; dailyHistory: { [date: string]: number } } एक कॉल में सभी तीन काउंटर लौटाता है।

​

शटडाउन और जीवनचक्र

​

सहमति स्थायित्व

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

​

समस्या निवारण