Skip to content

Commit 9ae734e

Browse files
haoxiuwenhaoxiuwen
authored
Merge pull request #1013 from haoxiuwen/doc-v2
Modify IM Docs
2 parents 023e7f4 + 02ac89c commit 9ae734e

File tree

12 files changed

+17
-17
lines changed

12 files changed

+17
-17
lines changed

‎docs/document/android/userprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ EMClient.getInstance().userInfoManager().updateOwnInfoByAttribute(EMUserInfoType
7373
});
7474
```
7575

76-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
76+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
7777

7878
| 字段 | 类型 | 描述 |
7979
| :---------- | :----- | :------------------------------------------------------------------------------------------------ |

‎docs/document/flutter/userprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ try {
4545
}
4646
```
4747

48-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
48+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
4949

5050
| 字段 | 类型 | 描述 |
5151
| :---------- | :----- | :----------------------------------------------------------- |

‎docs/document/harmonyos/userprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ ChatClient.getInstance().userInfoManager()?.updateUserInfo(userInfo).then(result
6666
});
6767
```
6868

69-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
69+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
7070

7171
| 字段 | 类型 | 描述 |
7272
| :---------- | :----- | :------- |

‎docs/document/ios/userprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ NSString *url = @"https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/IMD
6868
}];
6969
```
7070

71-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
71+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
7272

7373
| 字段 | 类型 | 描述 |
7474
| ----------- | ------ | ------------------------------------------------------------------------------------------------- |

‎docs/document/react-native/userprofile.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ ChatClient.getInstance()
6060
});
6161
```
6262

63-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
63+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
6464

6565
| 字段 | 类型 | 描述 |
6666
| :---------- | :----- | :----------------------------------------------------------- |
6767
| `nickname` | String | 用户昵称。长度在 64 字符内。 |
6868
| `avatarurl` | String | 用户头像 URL 地址。长度在 256 字符内。 |
6969
| `phone` | String | 用户联系方式。长度在 32 字符内。 |
7070
| `mail` | String | 用户邮箱。长度在 64 字符内。 |
71-
| `gender` | Int | 用户性别：<br/> - `1`：男；<br/> - `2`：女；<br/> - （默认）`0`：未知；<br/> - 设置为其他值无效。 |
71+
| `gender` | Int | 用户性别：<br/> - `1`：男；<br/> - `2`：女；<br/> - （默认）`0`：未知；<br/> - 设置为其他值无效。 |
7272
| `sign` | String | 用户签名。长度在 256 字符内。 |
7373
| `birth` | String | 用户生日。长度在 64 字符内。 |
7474
| `ext` | String | 扩展字段。 |

‎docs/document/server-side/chatroom_manage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ POST https://{host}/{org_name}/{app_name}/chatrooms
381381
| `maxusers` | Int | 否 | 聊天室最大成员数（包括聊天室所有者）。取值范围为 [1,10,000]，默认值为 `1000`。如需调整请联系商务。 |
382382
| `owner` | String | 是 | 聊天室所有者。 |
383383
| `members` | Array | 否 | 聊天室普通成员和管理员的用户 ID 数组，不包含聊天室所有者的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。若传该参数，确保至少设置一个数组元素。 |
384-
| `custom` | String | 否 | 聊天室扩展信息，例如可以给聊天室添加业务相关的标记，不要超过 1,024 个字符。 |
384+
| `custom` | String | 否 | 聊天室扩展信息，例如，可以给聊天室添加业务相关的标记，不能超过 8 KB。 |
385385

386386
#### HTTP 响应
387387

‎docs/document/server-side/group_manage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ PUT https://{host}/{org_name}/{app_name}/chatgroups/{group_id}
346346
| `membersonly` | Bool | 否 | 加入群组是否需要群主或者群管理员审批：<br/> - `true`：是；<br/> - `false`：否。 |
347347
| `allowinvites` | Bool | 否 | 是否允许群成员邀请别人加入此群：<br/> - `true`：允许群成员邀请人加入此群；<br/> - `false`：只有群主或群管理员才可以邀请用户入群。 |
348348
| `invite_need_confirm` | Bool | 否 | 受邀人加入群组前是否需接受入群邀请：<br/> - `true`：需受邀人确认入群邀请；<br/> - `false`：受邀人直接加入群组，无需确认入群邀请。 |
349-
| `custom` | String | 否 | 群组扩展信息，例如可以给群组添加业务相关的标记，不要超过 1,024 字符。 |
349+
| `custom` | String | 否 | 群组扩展信息，例如可以给群组添加业务相关的标记，不要超过 8 KB。 |
350350
| `public` | Bool | 否 | 是否是公开群。<br/> - `true`：公开群；<br/> - `false`：私有群。 |
351351

352352
#### HTTP 响应
@@ -771,7 +771,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}
771771
| - `disabled` | Bool | 群组是否为禁用状态：<br/> - `true`：群组被禁用；<br/> - `false`：群组为启用状态。 |
772772
| - `mute` | Bool | 是否处于全员禁言状态。<br/> - `true`：是； <br/> - （默认）`false`：否。 |
773773
| - `public` | Bool | 是否是公开群：<br/> - `true`：公开群；<br/> - `false`：私有群。 |
774-
| - `custom` | String | 群组扩展信息，例如，可以给群组添加业务相关的标记，不要超过 1,024 字符。 |
774+
| - `custom` | String | 群组扩展信息，例如，可以给群组添加业务相关的标记，不要超过 8 KB。 |
775775

776776
其他字段及描述详见 [公共参数](#公共参数)。
777777

‎docs/document/unity/userprofile.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ SDKClient.Instance.UserInfoManager.UpdateOwnInfo(userInfo, new CallBack(
5656
));
5757
```
5858

59-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
59+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
6060

6161
| 字段 | 类型 | 描述 |
6262
| :---------- | :----- | :------------------------------------------------------------------------------------------------ |
@@ -100,7 +100,7 @@ SDKClient.Instance.UserInfoManager.FetchUserInfoByUserId(idList, type, startId,
100100
1. 开通第三方文件存储服务。详情可以参考文件储存服务商的文档。
101101
2. 将头像文件上传至上述第三方文件存储，并获取存储 URL 地址。
102102
3. 将该 URL 地址传入用户属性的头像字段（`AvatarUrl`）。
103-
4. 调用 `fetchUserInfoById` 获取头像字段，并在本地 UI 中渲染用户头像。
103+
4. 调用 `FetchUserInfoByUserId` 获取头像字段，并在本地 UI 中渲染用户头像。
104104

105105
### 使用用户属性创建和发送名片
106106

‎docs/document/web/group_manage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
| `allowinvites` | Bool | 是否允许普通群成员邀请人入群：<br/> - `true`：允许；<br/> - `false`：不允许。只有群主和管理员才可以向群组添加用户。<br/>该参数仅对私有群有效，即 `public` 设置为 `false` 时， 因为公开群（public：`true`）仅支持群主和群管理员邀请人入群，不支持普通群成员邀请人入群。 |
4646
| `inviteNeedConfirm` | Bool | 邀请加群时是否需要受邀用户确认：<br/> - `true`：受邀用户需同意才会加入群组；<br/> - `false`：受邀用户直接加入群组，无需确认。 |
4747
| `maxusers` | Int | 群组最大成员数，默认为 `200`。不同套餐支持的人数上限不同，详见 [产品价格](/product/pricing.html#套餐包功能详情)。 |
48-
| `ext` | String | 群组扩展信息，例如可以给群组添加业务相关的标记，不要超过 1,024 字符。 |
48+
| `ext` | String | 群组扩展信息，例如可以给群组添加业务相关的标记，不要超过 8 KB。 |
4949

5050
创建群组的示例代码如下：
5151

‎docs/document/web/userprofile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ conn.updateUserInfo("nickname", "Your nickname").then((res) => {
6868
});
6969
```
7070

71-
若[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，请求中必须传以下字段各客户端才能获取到。
71+
关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
7272

7373
| 字段 | 类型 | 备注 |
7474
| :---------- | :----- | :------------------------------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)