79 行
1.3 KiB
Markdown
79 行
1.3 KiB
Markdown
|
# Vue3 SDK 安装配置
|
|||
|
|
|
|||
|
|
**包名**：`@xuqm/vue3-sdk` · **版本**：0.1.0 · **Vue 版本**：^3.5.0
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## npm 安装
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
npm install @xuqm/vue3-sdk
|
|||
|
|
# 或
|
|||
|
|
yarn add @xuqm/vue3-sdk
|
|||
|
|
# 或
|
|||
|
|
pnpm add @xuqm/vue3-sdk
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## CDN 方式
|
|||
|
|
|
|||
|
|
```html
|
|||
|
|
<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` 包。
|
|||
|
|
|
|||
|
|
```ts
|
|||
|
|
import type {
|
|||
|
|
SDKConfig,
|
|||
|
|
ImMessage,
|
|||
|
|
ImGroup,
|
|||
|
|
ChatType,
|
|||
|
|
MsgType,
|
|||
|
|
MsgStatus,
|
|||
|
|
ConversationView,
|
|||
|
|
PageResult,
|
|||
|
|
UserProfile,
|
|||
|
|
FriendRequest,
|
|||
|
|
GroupJoinRequest,
|
|||
|
|
BlacklistEntry,
|
|||
|
|
BlacklistCheckResult,
|
|||
|
|
GroupReadReceiptSummary,
|
|||
|
|
HistoryQuery,
|
|||
|
|
SendMessageParams,
|
|||
|
|
ImEventMap,
|
|||
|
|
ApiResponse,
|
|||
|
|
} from '@xuqm/vue3-sdk'
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 初始化
|
|||
|
|
|
|||
|
|
```ts
|
|||
|
|
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
|
|||
|
|
})
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 下一步
|
|||
|
|
|
|||
|
|
- [Vue3 IM 接入 →](./im)
|
