Skip to content

Commit

Permalink
Merge pull request #499 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Change `字节跳动`  to `抖音`
  • Loading branch information
haoxiuwen authored Nov 15, 2023
2 parents 383b408 + 2ccdd8c commit 100014e
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/.vuepress/sidebar/document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ const documentSidebar = [
{ text: '微信小程序', link: 'wechat.html' },
{ text: 'QQ 小程序', link: 'qq.html' },
{ text: '百度小程序', link: 'baidu.html' },
{ text: '字节跳动小程序', link: 'bytedance.html' },
{ text: '抖音小程序', link: 'bytedance.html' },
{ text: '支付宝小程序', link: 'alipay.html' },
{ text: 'Uniapp 全平台', link: 'uniapp.html' },
{ text: '小程序 API 文档', link: 'apidoc.html' },
Expand Down
6 changes: 3 additions & 3 deletions docs/document/android/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -966,9 +966,9 @@ OPPO 推送在 2.1.0 适配了 Android Q,在 Android Q 上接收 OPPO 推送
免打扰时间参数的说明如下表所示:

| 免打扰时间参数 | 类型 |描述 | 应用范围 |
| :------------------- | :--------------------------- | :------------------- |
| SILENT_MODE_INTERVAL | Int |每天定时触发离线推送免打扰的时间段,采用 24 小时制,精确到分钟,格式为 H:M-H:M,例如 8:30-10:0,开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下:<br/> - 该参数仅针对 app 生效,对单聊或群聊不生效。<br/> - 开始时间和结束时间设置后,免打扰模式每天定时触发。例如,若该时间段设置为 `8:0`-`10:0`,免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`,结束时间为 `12:0`,则免打扰模式在当天的 11:00-12:00 生效,以后每天均在 8:00-12:00 生效。<br/> - 若开始时间和结束时间相同,免打扰模式则全天生效。不过,若设置为 `0:0`-`0:0`,则关闭免打扰模式。<br/> - 若结束时间早于开始时间,则免打扰模式在每天的开始时间到次日的结束时间内生效。例如,开始时间为 `10:0`,结束时间为 `8:0`,则免打扰模式的在当天的 10:00 到次日的 8:00 生效。<br/> - 目前仅支持在每天的一个指定时间段内开启免打扰模式,不支持多个免打扰时间段,新的设置会覆盖之前的设置。<br/> - 若不设置该参数,传空字符串。<br/> - 若该参数和 `SILENT_MODE_DURATION` 均设置,免打扰模式当日在这两个时间段均生效,例如,例如,上午 8:00 将 `SILENT_MODE_INTERVAL` 设置为 8:0-10:0,`SILENT_MODE_DURATION` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅用于 app 级别,对单聊或群聊会话不生效。 |
| SILENT_MODE_DURATION | Int |免打扰时长,单位为分钟。免打扰时长的取值范围为 [0,10080]`0` 表示该参数无效,`10080` 表示免打扰模式持续 7 天。<br/> 与免打扰时间段的设置每天生效不同,该参数为一次有效。设置后立即生效,例如,上午 8:00 将 app 层级的 `SILENT_MODE_DURATION` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 处于免打扰模式。<br/> - 若该参数和 `SILENT_MODE_INTERVAL` 均设置,免打扰模式当日在这两个时间段均生效,例如,上午 8:00 将 app 级的 `SILENT_MODE_INTERVAL` 设置为 8:00-10:00,免打扰时长设置为 240 分钟(4 个小时),则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | App 或单聊/群聊会话。 |
| :------------------- | :--------------------------- | :--------------------------- | :------------------- |
| SILENT_MODE_INTERVAL | Int |每天定时触发离线推送免打扰的时间段,采用 24 小时制,精确到分钟,格式为 H:M-H:M,例如 8:30-10:0,开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下:<br/> - 开始时间和结束时间设置后,免打扰模式每天定时触发。例如,若该时间段设置为 `8:0`-`10:0`,免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`,结束时间为 `12:0`,则免打扰模式在当天的 11:00-12:00 生效,以后每天均在 8:00-12:00 生效。<br/> - 若开始时间和结束时间相同,免打扰模式则全天生效。不过,若设置为 `0:0`-`0:0`,则关闭免打扰模式。<br/> - 若结束时间早于开始时间,则免打扰模式在每天的开始时间到次日的结束时间内生效。例如,开始时间为 `10:0`,结束时间为 `8:0`,则免打扰模式的在当天的 10:00 到次日的 8:00 生效。<br/> - 目前仅支持在每天的一个指定时间段内开启免打扰模式,不支持多个免打扰时间段,新的设置会覆盖之前的设置。<br/> - 若不设置该参数,传空字符串。<br/> - 若该参数和 `SILENT_MODE_DURATION` 均设置,免打扰模式当日在这两个时间段均生效,例如,例如,上午 8:00 将 `SILENT_MODE_INTERVAL` 设置为 8:0-10:0,`SILENT_MODE_DURATION` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅针对 app 生效,对单聊或群聊不生效。 |
| SILENT_MODE_DURATION | Int |免打扰时长,单位为分钟。免打扰时长的取值范围为 [0,10080]`0` 表示该参数无效,`10080` 表示免打扰模式持续 7 天。<br/> 与免打扰时间段的设置每天生效不同,该参数为一次有效。设置后立即生效,例如,上午 8:00 将 app 层级的 `SILENT_MODE_DURATION` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 处于免打扰模式。<br/> - 若该参数和 `SILENT_MODE_INTERVAL` 均设置,免打扰模式当日在这两个时间段均生效,例如,上午 8:00 将 app 级的 `SILENT_MODE_INTERVAL` 设置为 8:00-10:00,免打扰时长设置为 240 分钟(4 个小时),则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | App 或单聊/群聊会话。|

:::tip
若在免打扰时段或时长生效期间需要对指定用户推送消息,需设置[强制推送](#强制推送)
Expand Down
8 changes: 4 additions & 4 deletions docs/document/applet/bytedance.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# 字节跳动小程序集成介绍
# 抖音小程序集成介绍

<Toc />

### 注册环信账号

开发者需要在环信管理后台 [注册并创建应用](/product/enable_and_configure_IM.html#创建应用),来获取唯一 appKey,SDK 初始化时需要配置 appKey。

### 搭建字节跳动小程序开发环境
### 搭建抖音小程序开发环境

首先需要下载并安装 [开发者工具](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/developer-instrument/developer-instrument-update-and-download/)然后按照字节跳动小程序的 [接入流程](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/guide/start/kick-off) 一步步创建一个小程序
首先需要下载并安装 [开发者工具](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/developer-instrument/developer-instrument-update-and-download/)然后按照抖音小程序的 [接入流程](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/guide/start/kick-off) 一步步创建一个小程序

### 配置服务器域名

小程序在发布前,需要配置合法域名。

登录字节跳动小程序 [开发者平台](https://microapp.bytedance.com/),选择当前小程序(如果没有需要创建一个小程序),进入 “开发管理>开发设置” 页面配置以下服务器地址。
登录抖音小程序 [开发者平台](https://microapp.bytedance.com/),选择当前小程序(如果没有需要创建一个小程序),进入 “开发管理>开发设置” 页面配置以下服务器地址。

:::tip
request 合法域名:
Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
环信小程序 SDK 为各端小程序开发提供一套完整的技术解决方案,在各端小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。

:::notice
SDK 目前支持微信、QQ、百度小程序、字节跳动、uni-app 编译的原生 Android 以及 iOS。
SDK 目前支持微信、QQ、百度小程序、抖音、uni-app 编译的原生 Android 以及 iOS。
:::

## 体验小程序
Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/serverconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
7. 登陆环信后台获取 socket 域名,进入即时通讯-服务概览页,即可看到如图的域名展示。

:::notice
字节跳动小程序、QQ 小程序、百度小程序、uniapp 全平台等同微信小程序的域名一致,使用微信小程序栏的域名即可。
抖音小程序、QQ 小程序、百度小程序、uniapp 全平台等同微信小程序的域名一致,使用微信小程序栏的域名即可。
:::

![img](@static/images/applet/config6.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/uniapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
环信小程序 SDK 为各端小程序开发提供一套完整的技术解决方案,在各端小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。

:::notice
SDK 目前支持微信、QQ、百度小程序、字节跳动(请使用低于 1.70.0 以下的版本基础库)、uni-app 编译的 原生 Android 以及 iOS。
SDK 目前支持微信、QQ、百度小程序、抖音(请使用低于 1.70.0 以下的版本基础库)、uni-app 编译的 原生 Android 以及 iOS。
:::

## 体验小程序
Expand Down
2 changes: 1 addition & 1 deletion docs/document/ios/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ DeviceToken 注册后,iOS 系统会通过以下方式将 DeviceToken 回调给
免打扰时间参数的说明如下表所示:

| 免打扰时间参数 | 类型 |描述 | 应用范围 |
| :------------------- | :--------------------------- | :------------------- |
| :------------------- | :------------------- | :--------------------------- | :------------------- |
| EMSilentModeParamTypeInterval | Int |每天定时触发离线推送免打扰的时间段,采用 24 小时制,精确到分钟,格式为 H:M-H:M,例如 8:30-10:0,开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下:<br/> - 该参数仅针对 app 生效,对单聊或群聊不生效。<br/> - 开始时间和结束时间设置后,免打扰模式每天定时触发。例如,若该时间段设置为 `8:0`-`10:0`,免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`,结束时间为 `12:0`,则免打扰模式在当天的 11:00-12:00 生效,以后每天均在 8:00-12:00 生效。<br/> - 若开始时间和结束时间相同,免打扰模式则全天生效。不过,若设置为 `0:0`-`0:0`,则关闭免打扰模式。<br/> - 若结束时间早于开始时间,则免打扰模式在每天的开始时间到次日的结束时间内生效。例如,开始时间为 `10:0`,结束时间为 `8:0`,则免打扰模式的在当天的 10:00 到次日的 8:00 生效。<br/> - 目前仅支持在每天的一个指定时间段内开启免打扰模式,不支持多个免打扰时间段,新的设置会覆盖之前的设置。<br/> - 若不设置该参数,传空字符串。<br/> - 若该参数和 `EMSilentModeParamTypeDuration` 均设置,免打扰模式当日在这两个时间段均生效,例如,例如,上午 8:00 将 `EMSilentModeParamTypeInterval` 设置为 8:0-10:0,`EMSilentModeParamTypeDuration` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅用于 app 级别,对单聊或群聊会话不生效。 |
| EMSilentModeParamTypeDuration | Int |免打扰时长,单位为分钟。免打扰时长的取值范围为 [0,10080]`0` 表示该参数无效,`10080` 表示免打扰模式持续 7 天。<br/> 与免打扰时间段的设置每天生效不同,该参数为一次有效。设置后立即生效,例如,上午 8:00 将 app 层级的时长设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 处于免打扰模式。<br/> - 若该参数和 `EMSilentModeParamTypeInterval` 均设置,免打扰模式当日在这两个时间段均生效,例如,上午 8:00 将 app 级的 `EMSilentModeParamTypeInterval` 设置为 8:00-10:00,免打扰时长设置为 240 分钟(4 个小时),则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | App 或单聊/群聊会话。 |

Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
免打扰时间参数的说明如下表所示:

| 免打扰时间参数 | 类型 |描述 | 应用范围 |
| :------------------- | :--------------------------- | :------------------- |
| :------------------- | :------------------- | :--------------------------- | :------------------- |
| startTime & endTime | Int |每天定时触发离线推送免打扰的时间段,采用 24 小时制,精确到分钟,格式为 H:M-H:M,例如 8:30-10:0,开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下:<br/> - 该参数仅针对 app 生效,对单聊或群聊不生效。<br/> - 开始时间和结束时间设置后,免打扰模式每天定时触发。例如,若该时间段设置为 `8:0`-`10:0`,免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`,结束时间为 `12:0`,则免打扰模式在当天的 11:00-12:00 生效,以后每天均在 8:00-12:00 生效。<br/> - 若开始时间和结束时间相同,免打扰模式则全天生效。不过,若设置为 `0:0`-`0:0`,则关闭免打扰模式。<br/> - 若结束时间早于开始时间,则免打扰模式在每天的开始时间到次日的结束时间内生效。例如,开始时间为 `10:0`,结束时间为 `8:0`,则免打扰模式的在当天的 10:00 到次日的 8:00 生效。<br/> - 目前仅支持在每天的一个指定时间段内开启免打扰模式,不支持多个免打扰时间段,新的设置会覆盖之前的设置。<br/> - 若不设置该参数,传空字符串。<br/> - 若该参数和 `duration` 均设置,免打扰模式当日在这两个时间段均生效,例如,例如,上午 8:00 将 `startTime 和 endTime` 设置为 8:0-10:0,`duration` 设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅用于 app 级别,对单聊或群聊会话不生效。 |
| duration | Int |免打扰时长,单位为分钟。免打扰时长的取值范围为 [0,10080]`0` 表示该参数无效,`10080` 表示免打扰模式持续 7 天。<br/> 与免打扰时间段的设置每天生效不同,该参数为一次有效。设置后立即生效,例如,上午 8:00 将 app 层级的时长设置为 240 分钟(4 个小时),则 app 在当天 8:00-12:00 处于免打扰模式。<br/> - 若该参数和 `startTime 和 endTime` 均设置,免打扰模式当日在这两个时间段均生效,例如,上午 8:00 将 app 级的 `startTime 和 endTime` 设置为 8:00-10:00,免打扰时长设置为 240 分钟(4 个小时),则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | App 或单聊/群聊会话。 |

Expand Down
2 changes: 1 addition & 1 deletion docs/private/media/common_clientsdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<td>Web</td><td>环信 WebIM SDK 为 PC /移动 Web 应用,提供完善的即时通信与音视频功能</td><td><a href="https://download-sdk.oss-cn-beijing.aliyuncs.com/mp/downloads/webdemo-3.4.2.7.zip">下载代码</a></td><td><a href="https://zim-rtc.easemob.com:12005">体验Demo</a></td>
</tr>
<tr>
<td>小程序端</td><td>环信小程序 SDK提供全平台小程序解决方案,支持平台包括微信小程序、QQ小程序、百度小程序、字节跳动以及Uniapp编译的原生应用</td><td><a href="https://download-sdk.oss-cn-beijing.aliyuncs.com/mp/downloads/webim-weixin-xcx.zip">下载代码</a></td><td>\</td>
<td>小程序端</td><td>环信小程序 SDK提供全平台小程序解决方案,支持平台包括微信小程序、QQ小程序、百度小程序、抖音以及Uniapp编译的原生应用</td><td><a href="https://download-sdk.oss-cn-beijing.aliyuncs.com/mp/downloads/webim-weixin-xcx.zip">下载代码</a></td><td>\</td>
</tr>
</tbody>
</table>
Expand Down

0 comments on commit 100014e

Please sign in to comment.