@lynker-desktop/web v0.0.44

ELECTRON-SDK : web端JSSDK

1. 安装

npm install @lynker-desktop/web

2. 引入

import jssdk from '@lynker-desktop/web';

3. api文档

4. 全量 API 使用示例

建议在每个示例前都先引入 jssdk：

import jssdk from '@lynker-desktop/web';

1. 判断是否在桌面端

if (jssdk.isDesktop) {
  console.log('当前运行在桌面端环境');
}

2. 打开桌面端

jssdk.openDesktop();
// 或带参数
jssdk.openDesktop('yourLaunchOptions');

3. 获取桌面端配置信息

const config = await jssdk.getConfig();
console.log(config.env); // DEV/TEST/PRE/PROD

4. 获取 LocalStorage

const token = await jssdk.getLocalStorage('token');
console.log(token);

5. 设置 LocalStorage

await jssdk.setLocalStorage({ key: 'token', value: '测试' });

6. 获取启动/唤起参数

const launchOptions = await jssdk.getLaunchOptions();
console.log(launchOptions);

7. 清除启动/唤起参数

await jssdk.delLaunchOptions();

8. 打开 web 窗口

await jssdk.openWebWindow({
  name: '新窗口',
  url: 'https://www.baidu.com',
  extraData: '自定义数据',
  openDevTools: false
});

9. 打开浏览器

await jssdk.openBrowser('https://www.baidu.com');

10. 打开帮助中心

await jssdk.openMyHelpWindow({
  id: 1,
  module_id: 2,
  directory_id: 3
});
// 或无参数
await jssdk.openMyHelpWindow();

11. 打开我的订单

await jssdk.openMyOrderWindow();

12. 打开发票中心

await jssdk.openMyInvoiceWindow();

13. 打开选人组件

const members = await jssdk.openSelectMember();
// 返回数组
console.log(members);

14. 打开新窗口

await jssdk.openNewWindow({
  name: '新窗口',
  url: 'https://www.baidu.com',
  width: 800,
  height: 600
  // 其他 ElectronWindowsManagerOptions 字段
});

15. 设置 debug 模式

jssdk.setDebug(true);

16. 获取用户信息

const userInfo = await jssdk.getUserInfo();
console.log(userInfo.openid, userInfo.title, userInfo.email);

17. 获取唯一 ID

const uniqueId = await jssdk.getUniqueId();
console.log(uniqueId);

18. 设置环境

await jssdk.setEnv('DEV'); // DEV/TEST/PRE/PROD/RESET

19. 检查是否为手动环境

const isManual = await jssdk.checkIsManualEnv();
console.log(isManual);

20. 获取当前窗口

const win = await jssdk.getCurrentWindow();
console.log(win.id, win.title);

21. 打开外部窗口

await jssdk.openExternalWindow({
  url: 'https://www.baidu.com',
  options: {
    width: 800,
    height: 600
    // 其他 ElectronWindowsManagerOptions 字段
  }
});

22. 打开设置窗口

await jssdk.openSettingWindow('general');

23. 打开设置组窗口

await jssdk.openSetGroupWindow();

24. 打开我的地址窗口

await jssdk.openMyAddressWindow('user-address-key');

25. 打开政策详情窗口

await jssdk.openPolicyDetailWindow({ url: 'https://example.com/policy/123' });

26. 打开政策详情窗口2

await jssdk.openPolicyDetailWindow2({ url: 'https://example.com/policy/456' });

27. 注销

await jssdk.logout();

28. 打开调试工具

await jssdk.openDebugTools();

29. 打开 web 调试窗口

await jssdk.openWebDebugWindow();

30. 预览图片

await jssdk.previewImage({
  images: ['https://example.com/image1.png', 'https://example.com/image2.png'],
  index: 0,
  url: 'https://example.com/image1.png'
});

31. 预览视频

await jssdk.previewVideo({
  title: '演示视频',
  url: 'https://example.com/video.mp4',
  type: 'mp4',
  size: 1024 * 1024 * 10
});

32. 预览文件

await jssdk.previewFile({
  title: '文档',
  url: 'https://example.com/file.pdf',
  type: 'pdf',
  size: 1024 * 1024,
  officeId: 'office-123'
});

33. 下载文件

const filePath = await jssdk.downloadFile({
  title: '下载文件',
  url: 'https://example.com/file.pdf'
});
console.log(filePath);

34. 开始捕获

await jssdk.startCapture();

35. 停止捕获

await jssdk.stopCapture();

36. 主菜单打开工作台

await jssdk.mainMenu_openWorkBench({
  url: 'https://example.com/workbench',
  selected_path_uuid: 'uuid1',
  click_path_uuid: 'uuid2',
  teamId: 'team-001'
});

37. 工作台打开标签

await jssdk.workBench_openTab({
  options: {
    fullPath: '/workbench/tab',
    title: '标签页',
    icon: 'icon-url'
  },
  openWorkBench: true
});

38. 工作台打开标签用于 iframe

await jssdk.workBench_openTabForIframe({
  title: 'iframe标签',
  url: 'https://example.com/iframe',
  teamId: 'team-001'
});

39. 工作台打开标签用于 webview

await jssdk.workBench_openTabForWebview({
  title: 'webview标签',
  url: 'https://example.com/webview',
  teamId: 'team-001'
});

40. 工作台打开标签用于企业

await jssdk.workBench_openTabForEnterprise({
  teamId: 'team-001',
  menuId: 'menu-001'
});

41. 工作台打开标签用于商户申请

await jssdk.workBench_openTabForMerchantApply({
  teamId: 'team-001'
});

42. 工作台打开标签用于接收详情

await jssdk.workBench_openTabForReceiveDetail({
  title: '接收详情',
  url: 'https://example.com/receive',
  teamId: 'team-001',
  sn: 'SN123456'
});

43. 工作台打开标签用于退款详情

await jssdk.workBench_openTabForRefundDetail({
  title: '退款详情',
  url: 'https://example.com/refund',
  teamId: 'team-001',
  sn: 'SN654321',
  openLeftMenu: true
});

44. 工作台打开标签用于结算详情

await jssdk.workBench_openTabForSettlementDetail({
  title: '结算详情',
  url: 'https://example.com/settlement',
  teamId: 'team-001',
  sn: 'SN789012'
});