Aptabase 电子 SDK

以 Aptabase 、 开源、 隐私第一 、 移动、 桌面和 Web Apps 的简单分析设备为电子应用设备.

安装

使用您的首选 JavaScript 软件包管理器安装 SDK

npm add @aptabase/electron

使用量

首先,你必须得到你的 App Key 从Aptabase可以找到它 Instructions 菜单.

在您的电子主程序上, 在应用程序准备好前初始化 SDK :

import { initialize } from "@aptabase/electron/main";

initialize("<YOUR_APP_KEY>"); // 👈 this is where you enter your App Key

app.whenReady().then(() => {
  // ... the rest of your app initialization code
});

之后,你可以开始跟踪事件 trackEvent数字 :

import { trackEvent } from "@aptabase/electron/renderer";

trackEvent("app_started"); // An event with no properties
trackEvent("screen_view", { name: "Settings" }); // An event with a custom property

注: 这个 trackEvent 函数可以在单独的导入路径下使用,这取决于您要从何处跟踪事件.

• 从 @aptabase/electron/renderer 以跟踪 renderer 进程
• 从 @aptabase/electron/main 以跟踪 main 进程

以上指示被推荐为电机的现代设置. 关于Electron的旧版本,请参见: 备选说明。 。 。 .

几个重要说明:

1. SDK会用一些有用的信息自动增强事件,如OS,app版本等.
2. 你控制着被送到阿普塔基地的东西 此 SDK 不自动跟踪任何事件, 您需要呼叫 trackEvent 手动.
   • 因此,一般建议在启动时至少跟踪一个事件
3. 你不需要等待着 trackEvent 函数,会在后台运行.
4. 只允许自定义属性上的字符串和数字值