diff --git a/docs/.vuepress/sidebar/document.ts b/docs/.vuepress/sidebar/document.ts index 3fa72b057..40c2757de 100644 --- a/docs/.vuepress/sidebar/document.ts +++ b/docs/.vuepress/sidebar/document.ts @@ -199,6 +199,7 @@ const documentSidebar = [ children: [ { text: '集成介绍', + collapsible: true, children: [ { text: '微信小程序', link: 'wechat.html' }, { text: 'QQ 小程序', link: 'qq.html' }, @@ -206,7 +207,6 @@ const documentSidebar = [ { text: '抖音小程序', link: 'bytedance.html' }, { text: '支付宝小程序', link: 'alipay.html' }, { text: 'Uniapp 全平台', link: 'uniapp.html' }, - { text: '小程序 API 文档', link: 'apidoc.html' }, ], }, { text: '初始化', link: 'initialization.html' }, @@ -311,6 +311,7 @@ const documentSidebar = [ { text: '其他帮助', children: [ + { text: '小程序 API 文档', link: 'apidoc.html' }, { text: 'Uniapp 生成原生 Android、iOS 应用', link: 'uniappnativeapp.html' }, { text: '小程序模板使用指南', link: 'uniappuikit.html' }, { text: '如何配置服务器域名', link: 'serverconfig.html' }, diff --git a/docs/document/applet/intergrated.md b/docs/document/applet/intergrated.md deleted file mode 100644 index 5e27149c8..000000000 --- a/docs/document/applet/intergrated.md +++ /dev/null @@ -1,122 +0,0 @@ -# 集成 SDK - -本文介绍如何将环信即时通讯 IM SDK 集成到你的 Web 项目。 - -## 开发环境要求 - -- 支持的浏览器: - - Chrome 54+ - - Firefox 10+ - - Safari 6+ - -## 安装 - -### 使用 npm 安装 - -```bash -npm install easemob-websdk -``` - -## 引入 SDK - -### js 引入 SDK - -对于 JavaScript SDK,导入代码如下: - -```javascript -import ChatSDK from "easemob-websdk"; -``` - -### Ts 引入 SDK - -对于 TypeScript SDK,导入代码如下, EasemobChat 是 SDK 类型的命名空间。 - -```typescript -import ChatSDK, { EasemobChat } from "easemob-websdk"; -``` - -### 按需导入 SDK 模块 - -SDK 提供了灵活的模块化设计,允许开发者根据需求引入功能模块,并将其注册到 miniCore 中使用。 - -miniCore 是一个基座,支持登录登出和发送消息等基础功能,而且包含消息对象。因此,若只使用收发消息功能,则只需引入 miniCore。若使用其他功能,miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合,从而避免不必要的代码加载,减小了应用程序的体积。 - -tip: -只有按需导入 SDK 的方式才支持本地会话管理功能。 -小程序 uniapp 不支持使用 miniCore 的集成方式。 - -```javascript -import MiniCore from "easemob-websdk/miniCore/miniCore"; -import * as contactPlugin from "easemob-websdk/contact/contact"; -``` - -支持按需导入的 SDK 模块 - -| 模块名称 | 导入文件 | 使用方式 | -| -------- | -------- | -------- | -| 联系人和消息管理 | import * as contactPlugin from "easemob-websdk/contact/contact"; | miniCore.usePlugin(contactPlugin, "contact") | -| 群组 | import * as groupPlugin from "easemob-websdk/group/group"; | miniCore.usePlugin(groupPlugin, "group") | -| 聊天室 | import * as chatroomPlugin from "easemob-websdk/chatroom/chatroom"; | miniCore.usePlugin(chatroomPlugin, "chatroom") | -| 子区 | import * as threadPlugin from "easemob-websdk/thread/thread"; | miniCore.usePlugin(threadPlugin, "thread"); | -| 翻译 | import * as translationPlugin from "easemob-websdk/translation/translation";| miniCore.usePlugin(translationPlugin, "translation"); | -| 在线状态订阅 | import * as presencePlugin from "easemob-websdk/presence/presence"; | miniCore.usePlugin(presencePlugin, "presence"); | -| 会话免打扰 | import * as silentPlugin from "easemob-websdk/silent/silent";| miniCore.usePlugin(silentPlugin, "silent"); - | - - -### 注册模块到 miniCore - -```javascript -const miniCore = new MiniCore({ - appKey: "your appKey", -}); - -// "contact" 为固定值 -miniCore.usePlugin(contactPlugin, "contact"); -``` - -### 使用注册的模块 - -```javascript -// 获取联系人列表 -miniCore.contact.getContacts(); - -// 登录 -miniCore.open({ - username: "username", - password: "password", - // accessToken: 'token' -}); - -// 登出 -miniCore.close(); - -// 监听事件 -miniCore.addEventHandler("handlerId", { - onTextMessage: (message) => { - console.log(message); - }, -}); - -//发送文本消息 -const sendTextMsg = () => { - const option: EasemobChat.CreateTextMsgParameters = { - chatType: "singleChat", - type: "txt", - to: "to", - msg: "hello", - }; - const msg = miniCore.Message.create(option); - miniCore - .send(msg) - .then((res: any) => { - console.log("发送成功", res, msg); - }) - .catch((err: any) => { - console.log("发送失败", err); - }); -}; - -``` - - diff --git a/docs/document/flutter/integration.md b/docs/document/flutter/integration.md index ebafad146..3f0387c01 100644 --- a/docs/document/flutter/integration.md +++ b/docs/document/flutter/integration.md @@ -1,11 +1,11 @@ # 集成 SDK -本文介绍如何将环信即时通讯 IM SDK 集成到你的 Android 项目。 +本文介绍如何将环信即时通讯 IM SDK 集成到你的项目。 ## 开发环境要求 - Flutter 2.0.0 或以上版本; -- Dart 2.12 或以上版本; +- Dart 2.12 或以上版本; ### 使用命令创建项目 @@ -15,7 +15,7 @@ flutter create quick_start ### 设置 Android -1. 打开文件 quick_start/android/app/build.gradle 在文件最后添加: +1. 打开文件 `quick_start/android/app/build.gradle` 在文件最后添加: ```dart android { @@ -25,7 +25,7 @@ android { } ``` -2. 打开文件 quick_start/android/app/src/main/AndroidManifest.xml,在 下添加: +2. 打开文件 `quick_start/android/app/src/main/AndroidManifest.xml`,在 `` 下添加: ```xml @@ -33,7 +33,7 @@ android { ``` -3. 在 quick_start/android/app/proguard-rules.pro 中设置免混淆规则: +3. 在 `quick_start/android/app/proguard-rules.pro` 中设置免混淆规则: ```java -keep class com.hyphenate.** {*;} @@ -42,10 +42,9 @@ android { ### 设置 iOS -iOS 需要 iOS 11.0 以上版本, - -打开文件 quick_start/ios/Runner.xcodeproj,修改:TARGETS -> General -> Deployment info, 设置 iOS 版本为 11.0。 +iOS 需要 iOS 11.0 以上版本。 +打开文件 `quick_start/ios/Runner.xcodeproj`,选择 **TARGETS > General > Deployment info**, 设置 iOS 版本为 11.0。 ### 集成 SDK diff --git a/docs/product/product_message_overview.md b/docs/product/product_message_overview.md index 82bbab3ee..1eda54900 100644 --- a/docs/product/product_message_overview.md +++ b/docs/product/product_message_overview.md @@ -120,11 +120,11 @@ Web 和小程序端无本地消息存储。 默认情况下,消息附件可在服务器存储 **7** 天。若要提升该限制,你需要联系商务。消息附件的大小及存储时间限制与群组共享文件的相同。如果消息附件的其中一个限制进行了上调,群组共享文件的对应限制也会随之自动调整,反之亦然。 -#### 离线消息存储 +### 离线消息存储 对于单聊和群聊,离线消息默认保存 **7** 天。对于每个终端用户,所有的单聊会话可存储 500 条离线消息,所有的群聊会话可存储 200 条离线消息。若超过存储天数和条数的上限,最新的离线消息会挤掉最早的。如需提升上限,可联系商务。 -#### 事件通知存储 +### 事件通知存储 各类事件通知的存储时间与消息的存储一致。