Skip to content

Commit 260849a

Browse files
committed
fix: relationship chain callback
1 parent a973737 commit 260849a

16 files changed

+31
-31
lines changed

docs/restapi/commonFields.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ title: 常用结构体说明
55

66
## 通用字段说明
77

8-
| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 |
9-
| ----------- | ------ | ------------------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
10-
| secret | string | 32 | OpenIM 秘钥,登录注册 IM 用户的时候需要用到,服务端配置文件 config.yaml 的 secret 字段 | 字符串 |
11-
| platformID | int | | 用户登录时的终端类型 | iOS 1, Android 2, Windows 3, OSX 4, WEB 5, 小程序 6,linux 7, AndroidPad 8, IPad 9, Admin 10 |
12-
| userID | string | 64 | 用户 ID,保证 IM 内唯一 | 字符串即可 |
13-
| nickname | string | 255 | 昵称 | 字符串即可 |
14-
| faceURL | string | 255 | 头像链接 | |
15-
| ex | string | 1024 | 扩展字段,可自行扩展,建议封装成 JSON 字符串 | |
16-
| operationID | string | | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 | |
17-
| expiredTime | int | | 过期时间,单位(秒) | |
8+
| 字段名 | 类型 | 最大字符串长度限制 | 说明 | 取值范围 |
9+
| ----------- | ------ | ------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
10+
| secret | string | 32 | OpenIM 秘钥,登录注册 IM 用户的时候需要用到,服务端配置文件 config.yaml 的 secret 字段 | 字符串 |
11+
| platformID | int | | 用户登录时的终端类型 | 1:iOS、2:Android、3:Windows、4:OSX、5:WEB、6:小程序、7:linux、8:Android Pad、9:IPad、10:Admin |
12+
| userID | string | 64 | 用户 ID,保证 IM 内唯一 | 字符串即可 |
13+
| nickname | string | 255 | 昵称 | 字符串即可 |
14+
| faceURL | string | 255 | 头像链接 | |
15+
| ex | string | 1024 | 扩展字段,可自行扩展,建议封装成 JSON 字符串 | |
16+
| operationID | string | | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 | |
17+
| expiredTime | int | | 过期时间,单位(秒) | |
1818

1919
## PublicUserInfo
2020

@@ -66,7 +66,7 @@ title: 常用结构体说明
6666
| blackUserInfo | [PublicUserInfo](#publicuserinfo) | | 被拉黑用户信息 | |
6767
| addSource | int | | 拉黑来源 | |
6868
| operatorUserID | string | | 操作者 ID | |
69-
| ex | string | | 扩展字段 | |
69+
| ex | string | | 扩展字段 | |
7070

7171
## GroupInfo
7272

docs/sdks/api/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ toc_max_heading_level: 2
1616

1717
| 模块名称 | 模块功能简介 |
1818
| -------------------------------------------------------- | ---------------------- |
19-
| [初始化及登录](docs/sdks/api/initialization/index.mdx) | 初始化等基础相关的 API |
20-
| [用户](docs/sdks/api/user/index.mdx) | 用户相关的 API |
21-
| [关系链](docs/sdks/api/friend/index.mdx) | 关系链相关的 API |
22-
| [群组](docs/sdks/api/group/index.mdx) | 群组相关的 API |
23-
| [会话](docs/sdks/api/conversation/index.mdx) | 会话相关的 API |
24-
| [消息](docs/sdks/api/msg/index.mdx) | 消息相关的 API |
19+
| [初始化及登录](docs/sdks/api/initialization/index.mdx) | 初始化等基础相关 |
20+
| [用户](docs/sdks/api/user/index.mdx) | 用户相关 |
21+
| [关系链](docs/sdks/api/friend/index.mdx) | 关系链相关 |
22+
| [群组](docs/sdks/api/group/index.mdx) | 群组相关 |
23+
| [会话](docs/sdks/api/conversation/index.mdx) | 会话相关 |
24+
| [消息](docs/sdks/api/msg/index.mdx) | 消息相关 |

docs/sdks/callback/onBlackAdded.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
黑名单新增通知
13+
客户端调用[addBlack](docs/sdks/api/friend/addBlack.mdx)将某个用户添加到黑名单后自己会收到该回调,回调内容为新增的黑名单用户信息。
1414

1515
:::
1616

docs/sdks/callback/onBlackDeleted.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
黑名单新增通知
13+
客户端调用[removeBlack](docs/sdks/api/friend/removeBlack.mdx)将某个用户移出黑名单后自己会收到该回调,回调内容为被移除的黑名单用户信息。
1414

1515
:::
1616

docs/sdks/callback/onConnectFailed.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc_max_heading_level: 2
99

1010
:::info
1111

12-
黑名单新增通知
12+
IM连接失败回调,
1313

1414
:::
1515

docs/sdks/callback/onConnectSuccess.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc_max_heading_level: 2
99

1010
:::info
1111

12-
黑名单新增通知
12+
IM连接成功回调。
1313

1414
:::
1515

docs/sdks/callback/onConnecting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc_max_heading_level: 2
99

1010
:::info
1111

12-
黑名单新增通知
12+
IM连接中回调。
1313

1414
:::
1515

docs/sdks/callback/onConversationChanged.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
某些会话的关键信息发生变化
13+
某些会话的关键信息发生变化时,会触发该回调,例如会话的未读数发生变化,会话的最后一条消息发生变化等。
1414

1515
:::
1616

docs/sdks/callback/onFriendAdded.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
好友新增通知
13+
两个用户成功建立好友关系后双方都会收到该回调,回调内容为新增的好友信息。
1414

1515
:::
1616

docs/sdks/callback/onFriendApplicationAccepted.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
好友申请被接受
13+
好友申请被同意时,申请发起方和接收方都会收到该回调,回调内容为被同意后的好友申请。
1414

1515
:::
1616

0 commit comments

Comments
 (0)