XuqmGroup-Web/docs-site/docs/harmony/setup.md
XuqmGroup 6cd938cfbc feat(android-sdk): 添加完整的IM客户端SDK实现
- 实现了Android SDK的完整IM功能接口,包括消息、群组、好友、会话等核心功能
- 添加了消息收发、历史记录、撤回编辑等完整的消息操作能力
- 实现了群组管理功能,包括创建、成员管理、权限设置等操作
- 添加了好友关系链管理,支持添加、删除、分组等操作
- 实现了会话管理功能,包括置顶、免打扰、已读状态等
- 添加了黑名单、资料管理、搜索等辅助功能
- 补齐了批量操作接口,提升客户端操作效率
- 实现了WebSocket连接管理和事件监听机制
- 添加了离线消息同步和状态管理功能
2026-05-02 22:57:55 +08:00

1.5 KiB

HarmonyOS 安装配置

包名@xuqm/harmony-sdk · 版本0.1.0 · 语言ArkTS


ohpm 安装

在 HarmonyOS 项目的 oh-package.json5 中添加:

{
  "dependencies": {
    "@xuqm/harmony-sdk": "^0.1.0"
  }
}

然后执行:

ohpm install

发布仓库:https://ohpm.openharmony.cn/ohpm/


最低 API 版本

  • API 12+HarmonyOS 4.0+
  • DevEco Studio 4.0 Release 或更高版本

权限配置

module.json5 中声明所需权限:

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      },
      {
        "name": "ohos.permission.GET_NETWORK_INFO"
      }
    ]
  }
}

如需使用相机、相册、麦克风等功能,额外添加:

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.CAMERA"
      },
      {
        "name": "ohos.permission.READ_MEDIA"
      },
      {
        "name": "ohos.permission.WRITE_MEDIA"
      },
      {
        "name": "ohos.permission.MICROPHONE"
      }
    ]
  }
}

初始化

import { XuqmSDK } from '@xuqm/harmony-sdk'
import common from '@ohos.app.ability.common'

// 在 EntryAbility.onCreate 或页面初始化时
const context = getContext(this) as common.UIAbilityContext
await XuqmSDK.init(context, {
  appKey: 'your_app_key',
  appSecret: 'your_app_secret',
})

登录

const session = await XuqmSDK.login('user_001', 'your_user_sig_jwt')

下一步