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

1.3 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',
  appSecret: 'your_app_secret',
  debug: true,              // 可选
  baseUrl: 'https://...',   // 可选,默认 https://dev.xuqinmin.com
  wsUrl: 'wss://.../ws/im', // 可选,默认 wss://dev.xuqinmin.com/ws/im
})

下一步