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

1.1 KiB

Vue3 SDK 安装配置

包名@xuqm/vue3-sdk · 版本0.1.0 · Vue 版本^3.5.0


npm 安装

npm install @xuqm/vue3-sdk
# 或
yarn add @xuqm/vue3-sdk
# 或
pnpm add @xuqm/vue3-sdk

CDN 方式

<script type="module">
  import { init, ImClient } from 'https://cdn.xuqinmin.com/npm/@xuqm/vue3-sdk@0.1.0/dist/index.es.js'
</script>

CDN 地址为示例,实际以您的 CDN 部署为准。


TypeScript 支持

@xuqm/vue3-sdk 内置完整类型定义,安装后无需额外配置 @types 包。

import type {
  SDKConfig,
  ImMessage,
  ImGroup,
  ChatType,
  MsgType,
  MsgStatus,
  ConversationView,
  PageResult,
  UserProfile,
  FriendRequest,
  GroupJoinRequest,
  BlacklistEntry,
  BlacklistCheckResult,
  GroupReadReceiptSummary,
  HistoryQuery,
  SendMessageParams,
  ImEventMap,
  ApiResponse,
} from '@xuqm/vue3-sdk'

初始化

import { init } from '@xuqm/vue3-sdk'

init({
  appKey: 'your_app_key',
  debug: true,              // 可选
  baseUrl: 'https://...',   // 可选,默认 https://dev.xuqinmin.com
})

下一步