XuqmGroup H5 SDK
- core/sdk: add initializeFromLicense(), awaitInitialization(), isInitialized() - index: export new functions Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> |
||
|---|---|---|
| src | ||
| .gitignore | ||
| .nvmrc | ||
| Jenkinsfile | ||
| package-lock.json | ||
| package.json | ||
| package.private.json | ||
| README.md | ||
| tsconfig.json | ||
| vite.config.ts | ||
@xuqm/h5-sdk
XuqmGroup 纯 JavaScript/TypeScript H5 SDK,从 Vue3 SDK 提取核心,移除 Vue 依赖。
安装
npm install @xuqm/h5-sdk
使用
import { init, ImManager, login } from '@xuqm/h5-sdk'
// 初始化
init({ appKey: 'your-app-key', baseUrl: 'https://dev.xuqinmin.com' })
// 登录
login('userId', 'userSig')
// 创建 IM 管理器
const im = new ImManager()
// 监听状态变化
im.on('connected', () => console.log('connected'))
im.on('messages', (msgs) => console.log('messages', msgs))
im.on('conversations', (convs) => console.log('conversations', convs))
im.on('error', (err) => console.error('error', err))
// 连接
im.connect()
// 发送消息
im.send({ toId: 'target', chatType: 'SINGLE', msgType: 'TEXT', content: 'Hello' })
// 发送图片(自动上传)
import { sendImageMessage } from '@xuqm/h5-sdk'
await sendImageMessage('target', 'SINGLE', fileInput.files[0], 800, 600)
API
Core
init(config)— 初始化 SDKlogin(userId, userSig)/logout()— 登录/登出setToken(token)/getToken()/getUserId()/getConfig()http.get/post/put/delete— HTTP 请求工具uploadFile(file)— 文件上传
IM Manager
connect()/disconnect()— WebSocket 连接管理send(params)/revoke(msgId)/edit(msgId, content)— 消息操作messages/conversations/connected/error— 状态属性on(event, handler)/off(event, handler)— 事件订阅refreshConversations()— 刷新会话列表loadHistory(toId, query?)/loadGroupHistory(groupId, query?)— 加载历史setConversationRead(targetId, chatType?)— 标记已读
IM API (HTTP)
sendMessage/sendImageMessage/sendVideoMessage/sendFileMessage/sendAudioMessagefetchHistory/fetchGroupHistory/revokeMessage/editMessagelistConversations/markRead/setDraft/deleteConversationlistFriends/addFriend/removeFriend/sendFriendRequest...listGroups/getGroupInfo/createGroup...
构建
npm run build
产出 dist/index.es.js (ESM) 和 dist/index.umd.js (UMD)。