Skip to content

Commit

Permalink
Merge pull request #72 from haoxiuwen/doc-shengwang
Browse files Browse the repository at this point in the history
Modify IM Docs
  • Loading branch information
haoxiuwen authored Jan 23, 2025
2 parents c85165b + ef8194b commit 649b703
Show file tree
Hide file tree
Showing 21 changed files with 67 additions and 55 deletions.
56 changes: 28 additions & 28 deletions docs/.vuepress/data/download.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,31 @@ export const clientSDKDownloadInfo = [
language: "Java",
platform: "Android",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "io.agora.chat",
md5: "daa18926a2a5f3136d00877f106d79a2",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/android/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
"https://download.agora.io/sdk/release/Shengwang_CHAT_SDK_for_Android_v1_3_2.zip"
},
{
language: "Objective-C",
platform: "iOS",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "AgoraChat",
md5: "61b777ede51849a3fc361cc6603e073d",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/ios/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
"https://download.shengwang.cn/sdk/release/Shengwang_Chat_OC_SDK_v1.3.2.zip"
},
{
language: "JavaScript",
platform: "Web",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "shengwang-chat",
md5: "23929bfdfdd4f5121b9c7055bff492a2",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/web/releasenote.html",
downloadLink:
"https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip"
Expand All @@ -36,9 +36,9 @@ export const clientSDKDownloadInfo = [
language: "TypeScript",
platform: "HarmonyOS",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "@shengwang/chatsdk",
md5: "8625014328cbb1c07f92688ac824518a",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/harmonyos/releasenote.html",
downloadLink:
"https://download.shengwang.cn/sdk/release/chatsdk-1.3.2.har"
Expand All @@ -49,7 +49,7 @@ export const clientSDKDownloadInfo = [
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/windows/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
Expand All @@ -58,20 +58,20 @@ export const clientSDKDownloadInfo = [
language: "JavaScript",
platform: "小程序",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "shengwang-chat",
md5: "23929bfdfdd4f5121b9c7055bff492a2",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/applet/releasenote.html",
downloadLink:
"https://download.shenawang.cn/sdk/release/shengwang-chat-web-1.3.2.zip"
"https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip"
},
{
language: "Dart",
platform: "Flutter",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "-",
md5: "-",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/flutter/releasenote.html",
downloadLink:
"https://pub.dev/packages/shengwang_chat_sdk"
Expand All @@ -80,20 +80,20 @@ export const clientSDKDownloadInfo = [
language: "TypeScript",
platform: "React Native",
version: "1.3.2",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
package: "-",
md5: "-",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/react-native/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
"https://www.npmjs.com/package/react-native-shengwang-chat"
},
{
language: "C-Sharp",
platform: "Unity",
version: "2.1.7",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
updateTime: "2025-01-24",
releaseNote: "docs/sdk/unity/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
Expand All @@ -107,7 +107,7 @@ export const serverSDKDownloadInfo = [
version: "2.1.7",
package: "agora-im",
md5: "9aa4b2a542f3197ac9f905e20c5b7889",
updateTime: "2025-01-26",
updateTime: "2025-01-24",
releaseNote: "document/android/releasenote.html",
downloadLink:
"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/WEB_SDK/4.9.1/websdk.zip"
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/sidebar/document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ const documentSidebar = [
collapsible: true,
children: [
{ text: 'Uniapp 生成原生 Android、iOS 应用', link: 'uniappnativeapp.html' },
{ text: '小程序模板使用指南', link: 'uniappuikit.html' },
// { text: '小程序模板使用指南', link: 'uniappuikit.html' },
{ text: '如何配置服务器域名', link: 'serverconfig.html' },
],
only: ['applet']
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/sdk/android/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

在方法调用过程中,SDK 可能会返回错误码。详见 `Error` 错误码。

如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/android/)

## 聊天客户端

`ChatClient` 类提供各种方法实现即时通讯应用程序的登录和退出登录以及管理 SDK 和 IM 服务器之间的连接。
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/sdk/android/data_center.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,24 @@

## 集成说明

移动端 SDK 连接国内数据中心**中国**
1. 移动端 SDK 连接国内数据中心**中国**

Web 端和小程序端 SDK 集成需要根据数据中心,填写配置对应的 webSocket 地址。
2. Web 端和小程序端 SDK 集成需要根据数据中心,填写配置对应的 webSocket 地址。

| 数据中心名称 | socket 3.0 地址 | socket 2.0(老版本)地址 |
| :--------- | :----- | :----- |
| 中国 | im-api-c1.chat.rtnsvc.com | https://im-api.easemob.comhttps://im-api.easecdn.com |
| 数据中心名称 | Socket 地址 |
| :--------- | :----- |
| 中国 | wss://im-api-c1.chat.rtnsvc.com 或 wss://im-api-c1.chat.realtimemesh.com |

RESTful 接口请求地址如下:
3. RESTful 接口请求地址如下:

| 数据中心名称 | RESTful API 请求地址 |
| :--------- | :----- |
| 中国 | c1.chat.rtnsvc.com |
| 中国 | https://c1.chat.rtnsvc.com https://c1.chat.realtimemesh.com |

微信小程序、支付宝小程序的具体地址如下:
4. 微信小程序、支付宝小程序的具体地址如下:

| 数据中心名称 | 微信小程序 | 支付宝小程序 |
| :--------- | :----- | :----- |
| 中国 | im-api-wechat-c1.chat.rtnsvc.com | im-api-alipay-c1.chat.rtnsvc.com |
| 中国 | im-api-wechat-c1.chat.rtnsvc.com 或 im-api-wechat-c1.chat.realtimemesh.com | im-api-alipay-c1.chat.rtnsvc.com 或 im-api-alipay-c1.chat.realtimemesh.com |


2 changes: 1 addition & 1 deletion docs/docs/sdk/android/releasenote.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

5. [离线推送](/docs/sdk/android/push/push_overview.html)

- **集成第三方推送**:包括谷歌 FCM、APNs、华为、荣耀、鸿蒙、OPPO、vivo、小米、魅族推送等。
- **支持集成第三方推送**:包括谷歌 FCM、APNs、华为、荣耀、OPPO、vivo、小米、魅族推送等。
- **配置离线推送通知**:包括通过 API、推送模板和消息扩展字段实现推送通知的推送标题和内容的配置。
- **配置推送通知方式和免打扰**:推送通知方式即用户接收推送通知的方式,即接收所有通知、只接收提及某些用户的通知以及不接收任何推送通知。免打扰支持你设置 app 或会话级别在特定时间段内不接收离线推送通知。
- **推送模板**:推送模板主要用于服务器提供的默认配置不满足你的需求时,可使你设置全局范围的推送标题和推送内容。
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sdk/applet/alipay.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ uploadFile, downloadFile 合法域名:
可以通过以下两种方式获取 SDK:

- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)
- 通过 npm 下载 'shengwang-chat'
- 通过 npm 下载 `shengwang-chat`

sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
sdk 文件为 miniProgram 文件夹下的 `Shengwang-chat.js`

#### 引入 SDK

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sdk/applet/baidu.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ uploadFile, downloadFile 合法域名:
可以通过以下两种方式获取 SDK:

- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)
- 通过 npm 下载 'shengwang-chat'
- 通过 npm 下载 `shengwang-chat`

sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
sdk 文件为 miniProgram 文件夹下的 `Shengwang-chat.js`

#### 引入 SDK

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sdk/applet/bytedance.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ uploadFile, downloadFile 合法域名:
可以通过以下两种方式获取 SDK:

- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)
- 通过 npm 下载 'shengwang-chat'
- 通过 npm 下载 `shengwang-chat`

sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
sdk 文件为 miniProgram 文件夹下的 `Shengwang-chat.js`

#### 引入 SDK

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sdk/applet/qq.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ QQ、微信小程序: 1.7.0 及以上版本,最多可以同时存在 5 个 W
可以通过以下两种方式获取 SDK:

- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)
- 通过 npm 下载 'shengwang-chat'
- 通过 npm 下载 `shengwang-chat`

sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sdk/applet/wechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ uploadFile, downloadFile 合法域名:
可以通过以下两种方式获取 SDK:

- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)
- 通过 npm 下载 'shengwang-chat'
- 通过 npm 下载 `shengwang-chat`

sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js

Expand Down
2 changes: 2 additions & 0 deletions docs/docs/sdk/flutter/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
- `ChatPushManager` 类提供了配置离线推送服务的方法。
- `ChatUserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。

如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/flutter/)

## 连接与初始化

**ChatClient** 类提供登录和登出即时通讯 IM 的方法和事件,并管理 SDK 与聊天服务器之间的连接。
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sdk/flutter/push/push_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@

## 前提条件

1. 已开启即时通讯 IM ,详见[开启和配置即时通讯服务](/docs/sdk/flutter/enable_im.html)
2. 了解即时通讯 IM 的使用限制,详见[使用限制](/docs/sdk/flutter/limitation.html)
1. 已开启即时通讯 IM ,详见[开启和配置即时通讯服务](enable_im.html)
2. 了解即时通讯 IM 的使用限制,详见[使用限制](limitation.html)
3. 各推送使用的条件:
- APNs:在苹果设备上可用;
- Google FCM:设备启用了 Google Play 服务且可连接至 Google 服务器;
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sdk/flutter/releasenote.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

5. [离线推送](/docs/sdk/flutter/push/push_overview.html)

- **集成第三方推送**:包括苹果 APNs、谷歌 FCM、APNs、华为、荣耀、鸿蒙、OPPO、vivo、小米、魅族推送等。
- **支持集成第三方推送**:包括苹果 APNs、谷歌 FCM、APNs、华为、荣耀、OPPO、vivo、小米、魅族推送等。
- **配置离线推送通知**:包括通过 API、推送模板和消息扩展字段实现推送通知的推送标题和内容的配置。
- **配置推送通知方式和免打扰**:推送通知方式即用户接收推送通知的方式,即接收所有通知、只接收提及某些用户的通知以及不接收任何推送通知。免打扰支持你设置 app 或会话级别在特定时间段内不接收离线推送通知。
- **推送模板**:推送模板主要用于服务器提供的默认配置不满足你的需求时,可使你设置全局范围的推送标题和推送内容。
2 changes: 2 additions & 0 deletions docs/docs/sdk/harmonyos/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

在方法调用过程中,SDK 可能会返回错误码。详见 `ChatError` 错误码。

如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/harmonyOS/)

## 聊天客户端

`ChatClient` 类是即时通讯 IM SDK 的入口,提供各种方法实现即时通讯应用程序的登录和退出登录以及管理 SDK 和 IM 服务器之间的连接。
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/sdk/ios/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
- `PushManager` 类提供了配置离线推送服务的方法。
- `UserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。

如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/ios/)

## 连接与初始化

`ChatClient` 类提供登录和登出即时通讯 IM 的方法和事件,并管理 SDK 与聊天服务器之间的连接。
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/sdk/ios/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@

### 方法二:手动复制 SDK 文件

打开 SDK 下载页面,获取最新版的即时通讯 IM SDK,然后解压。
[下载 SDK](https://im.shengwang.cn/),获取最新版的即时通讯 IM SDK,然后解压。

将 SDK 包内的 `AgoraChat.xcframework` 拖入到你的工程中。
将 SDK 包内的 `AgoraChat.xcframework` 以及 `aosl.xcframework` 拖入到你的工程中。编译并运行
2 changes: 1 addition & 1 deletion docs/docs/sdk/ios/releasenote.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

5. [离线推送](/docs/sdk/ios/push/push_overview.html)

- **集成第三方推送**集成苹果 APNs 推送。
- **支持集成第三方推送**苹果 APNs 推送。
- **配置离线推送通知**:包括通过 API、推送模板和消息扩展字段实现推送通知的推送标题和内容的配置。
- **配置推送通知方式和免打扰**:推送通知方式即用户接收推送通知的方式,即接收所有通知、只接收提及某些用户的通知以及不接收任何推送通知。免打扰支持你设置 app 或会话级别在特定时间段内不接收离线推送通知。
- **推送模板**:推送模板主要用于服务器提供的默认配置不满足你的需求时,可使你设置全局范围的推送标题和推送内容。
2 changes: 1 addition & 1 deletion docs/docs/sdk/react-native/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
- `ChatPushManager` 类提供了允许你管理离线推送服务的方法。
- `ChatUserInfoManager` 类提供用户属性管理方法,包括获取和更新用户属性。

如欲了解各类中方法的详情,请点击[这里]()
如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/ios/)

## 连接与初始化

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sdk/react-native/releasenote.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

5. [离线推送](/docs/sdk/react-native/push/push_overview.html)

- **集成第三方推送**:包括苹果 APNs、谷歌 FCM、APNs、华为、荣耀、鸿蒙、OPPO、vivo、小米、魅族推送等。
- **支持集成第三方推送**:包括苹果 APNs、谷歌 FCM、APNs、华为、荣耀、OPPO、vivo、小米、魅族推送等。
- **配置离线推送通知**:包括通过 API、推送模板和消息扩展字段实现推送通知的推送标题和内容的配置。
- **配置推送通知方式和免打扰**:推送通知方式即用户接收推送通知的方式,即接收所有通知、只接收提及某些用户的通知以及不接收任何推送通知。免打扰支持你设置 app 或会话级别在特定时间段内不接收离线推送通知。
- **推送模板**:推送模板主要用于服务器提供的默认配置不满足你的需求时,可使你设置全局范围的推送标题和推送内容。
2 changes: 2 additions & 0 deletions docs/docs/sdk/unity/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
- `ChatThreadManager` 类提供了管理子区的方法,包括创建、解散子区以及成员管理。
- `UserInfoManager` 类提供了管理用户属性的方法,包括获取和更新用户属性。

如欲了解各类中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/unity/)

## 连接与初始化

`SDKClient` 类提供登录和登出即时通讯 IM 的方法和事件,并管理 SDK 与聊天服务器之间的连接。
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/sdk/web/api_reference_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
- `chatClient` 是聊天 SDK Connection 类的实例,提供登录和登出即时通讯 IM 的方法,并管理 SDK 与聊天服务器之间的连接,同时也提供管理联系人,群组,聊天室等的方法 。
- `Message` 类提供创建消息的方法。

如欲了解各模块中的方法和参数详情,请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/unity/)

## 连接与初始化

`chatClient` 提供登录和登出即时通讯 IM 的方法和事件,并管理 SDK 与聊天服务器之间的连接。
Expand Down

0 comments on commit 649b703

Please sign in to comment.