XuqmGroup-Web/docs-site/docs/harmony/setup.md
XuqmGroup 277e8ed7c6 feat(im): 添加即时消息SDK核心功能实现
- 实现了聊天消息发送功能,支持文本、图片、视频、音频、文件等多种消息类型
- 集成了文件上传下载功能,支持多媒体文件的传输和管理
- 添加了群组管理功能,包括创建群组、成员管理、权限控制等操作
- 实现了好友系统,支持好友添加、删除、分组等功能
- 集成了黑名单管理,提供用户屏蔽和解除屏蔽功能
- 添加了会话管理功能,支持对话列表、未读消息统计等
- 实现了历史消息查询和搜索功能
- 添加了实时连接状态管理和自动重连机制
2026-05-03 00:11:06 +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',
})

登录

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

下一步