Skip to content

Commit 144dda6

Browse files
committed
fix(docs): render commercial badges in tables
1 parent 8e944d7 commit 144dda6

20 files changed

Lines changed: 71 additions & 42 deletions

content/docs/chat/sdk/uniapp/group/overview-group.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The group domain uses `groupID` as its stable primary key and includes group pro
2222
| `OpenIMGroupMemberItem` | Member profile, role, join source, and mute-end time. |
2323
| `OpenIMGroupApplicationItem` | Join application, applicant, and processing state. |
2424

25-
Common `OpenIMGroupItem` fields include `groupID`, `groupName`, `notification`, `introduction`, `faceURL`, `ownerUserID`, `memberCount`, `status`, `groupType`, `needVerification`, `lookMemberInfo`, `applyMemberFriend`, and `ex`. `attachedInfo` is a <span className="enterprise-field-badge">Commercial field</span>; parse it only according to a confirmed contract.
25+
Common `OpenIMGroupItem` fields include `groupID`, `groupName`, `notification`, `introduction`, `faceURL`, `ownerUserID`, `memberCount`, `status`, `groupType`, `needVerification`, `lookMemberInfo`, `applyMemberFriend`, and `ex`. `attachedInfo` is an <span className="enterprise-field-badge">Enterprise</span> field; parse it only according to a confirmed contract.
2626

2727
Use `groupID:userID` as the stable merge key for a member. A member's in-group `nickname` and `faceURL` are member snapshots and must not overwrite account-level profile data.
2828

content/docs/chat/sdk/uniapp/group/retrieving-groups/get-joined-group-list-page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The Promise resolves directly to `OpenIMGroupListResult` or `null`; `groups` con
4444
| `lookMemberInfo`, `applyMemberFriend` | Member-profile and friend-application policy. |
4545
| `notificationUpdateTime`, `notificationUserID` | Latest announcement update metadata. |
4646
| `ex` | Application extension string. |
47-
| `attachedInfo` <span className="enterprise-field-badge">Commercial field</span> | Commercial attachment data; parse only a confirmed contract. |
47+
| `attachedInfo` <span className="enterprise-field-badge">Enterprise</span> | Commercial attachment data; parse only a confirmed contract. |
4848

4949
Member count and permission fields are snapshots and do not replace member pagination or server authorization. See [Group overview](/sdk/uniapp/group/overview-group) for events and the model.
5050

content/docs/chat/sdk/uniapp/group/update-group-profile.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ Do not mix announcement, join-verification, or member-permission fields into the
3939

4040
Promise success means that OpenIMServer completed the request. Merge `onGroupInfoChanged` by `groupID` or call `getSpecifiedGroupsInfo()` for immediate reconciliation. Do not overwrite fields that were not submitted.
4141

42-
`displayIsRead` is a <span className="enterprise-field-badge">Commercial field</span>. Do not send it when the public server or installed edition does not expose the capability.
42+
`displayIsRead` is an <span className="enterprise-field-badge">Enterprise</span> field. Do not send it when the public server or installed edition does not expose the capability.

content/docs/chat/sdk/uniapp/user/profile/get-self-user-info.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ The Promise resolves directly to `OpenIMUserInfo` or `null`, without a `{ data }
3535
| `nickname` | `string` | Account-level nickname. |
3636
| `faceURL` | `string` | Account-level avatar URL. |
3737
| `createTime` | `number` or `null` (optional) | Time when the user record was created. |
38-
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Commercial field</span> | `number` or `null` (optional) | Account-level message reception option. See [Set global message reception](/sdk/uniapp/user/profile/set-global-message-reception). |
39-
| `attachedInfo` <span className="enterprise-field-badge">Commercial field</span> | `string` or `null` (optional) | SDK attachment data. Parse it only according to a confirmed application contract. |
38+
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Enterprise</span> | `number` or `null` (optional) | Account-level message reception option. See [Set global message reception](/sdk/uniapp/user/profile/set-global-message-reception). |
39+
| `attachedInfo` <span className="enterprise-field-badge">Enterprise</span> | `string` or `null` (optional) | SDK attachment data. Parse it only according to a confirmed application contract. |
4040
| `ex` | `string` | Account-level extension string defined by the application. |
4141

4242
Verify that the returned `userID` matches the current application account. Do not fabricate an empty user object when the result is `null`; use login state and redacted diagnostics to determine why a snapshot is unavailable.

content/docs/chat/sdk/uniapp/user/profile/get-users-info.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Common fields are:
4545
| `faceURL` | `string` | Account-level public avatar URL. |
4646
| `createTime` | `number` or `null` (optional) | Time when the user record was created. |
4747
| `ex` | `string` | Account-level extension string whose format is defined by the application. |
48-
| `attachedInfo` <span className="enterprise-field-badge">Commercial field</span> | `string` or `null` (optional) | Parse only according to a confirmed commercial business contract. |
49-
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Commercial field</span> | `number` or `null` (optional) | Account-level message reception option. A stranger profile card normally does not need to display it. |
48+
| `attachedInfo` <span className="enterprise-field-badge">Enterprise</span> | `string` or `null` (optional) | Parse only according to a confirmed commercial business contract. |
49+
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Enterprise</span> | `number` or `null` (optional) | Account-level message reception option. A stranger profile card normally does not need to display it. |
5050

5151
Neither `ex` nor `attachedInfo` is a trusted identity, authorization, or authentication credential. This query is also read-only for other accounts. Update only the signed-in user's profile with `setSelfInfo()`.
5252

content/docs/chat/sdk/uniapp/user/profile/set-global-message-reception.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ platform: 'uniapp'
1111
sourcePath: '/sdk/uniapp/user/profile/set-global-message-reception'
1212
---
1313

14-
`globalRecvMsgOpt` is a <span className="enterprise-field-badge">Commercial field</span> that defines the account's default message-reception and notification policy. It is not an ordinary nickname, avatar, or display-profile field.
14+
`globalRecvMsgOpt` is an <span className="enterprise-field-badge">Enterprise</span> field that defines the account's default message-reception and notification policy. It is not an ordinary nickname, avatar, or display-profile field.
1515

1616
```uts
1717
import {

content/docs/chat/sdk/uniapp/user/profile/set-self-info.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ sourcePath: '/sdk/uniapp/user/profile/set-self-info'
2020
| `nickname` | `string` or `null` | No | New nickname. |
2121
| `faceURL` | `string` or `null` | No | New avatar URL. |
2222
| `ex` | `string` or `null` | No | New extension string. It completely replaces the previous value. |
23-
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Commercial field</span> | `OpenIMSetSelfInfoRecvMsgOpt` or `null` | No | Account-level message reception option; update it through the corresponding settings flow. |
23+
| `globalRecvMsgOpt` <span className="enterprise-field-badge">Enterprise</span> | `OpenIMSetSelfInfoRecvMsgOpt` or `null` | No | Account-level message reception option; update it through the corresponding settings flow. |
2424

2525
Pass at least one field that actually needs to change.
2626

content/zh/docs/chat/sdk/uniapp/group/overview-group.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ sourcePath: '/sdk/uniapp/group/overview-group'
1515
| `OpenIMGroupMemberItem` | 群成员资料、角色、入群来源和禁言结束时间。 |
1616
| `OpenIMGroupApplicationItem` | 入群申请及其申请人与处理状态。 |
1717

18-
`OpenIMGroupItem` 常用字段包括 `groupID``groupName``notification``introduction``faceURL``ownerUserID``memberCount``status``groupType``needVerification``lookMemberInfo``applyMemberFriend``ex``attachedInfo` 是<span className="enterprise-field-badge">商业版字段</span>,只按已确认协议解析。
18+
`OpenIMGroupItem` 常用字段包括 `groupID``groupName``notification``introduction``faceURL``ownerUserID``memberCount``status``groupType``needVerification``lookMemberInfo``applyMemberFriend``ex``attachedInfo` 是<span className="enterprise-field-badge">商业版</span>字段,只按已确认协议解析。
1919

2020
成员对象使用 `groupID:userID` 作为稳定合并标识。群内 `nickname``faceURL` 属于成员快照,不应被写回为用户账号级资料。
2121

content/zh/docs/chat/sdk/uniapp/group/retrieving-groups/get-joined-group-list-page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Promise 成功直接返回 `OpenIMGroupListResult | null`,从 `groups` 读取
4545
| `notificationUpdateTime` | `number` | 群公告更新时间。 |
4646
| `notificationUserID` | `string` | 最近更新群公告的用户 ID。 |
4747
| `ex` | `string` | 群扩展字符串。 |
48-
| `attachedInfo` <span className="enterprise-field-badge">商业版字段</span> | `string` | 商业附加信息,只按已确认协议解析。 |
48+
| `attachedInfo` <span className="enterprise-field-badge">商业版</span> | `string` | 商业附加信息,只按已确认协议解析。 |
4949

5050
`memberCount` 和权限字段都是查询时快照,不能替代成员分页或服务端权限校验。完整模型与事件见[群组概览](/sdk/uniapp/group/overview-group)
5151

content/zh/docs/chat/sdk/uniapp/user/overview-user.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ SDK 会根据使用场景返回不同的用户对象:
2323

2424
同一个 `userID` 可能同时出现在公开资料、好友资料、黑名单和群成员资料中。联系人页优先使用 `OpenIMFriendUserItem`;陌生人资料卡使用 `OpenIMPublicUserItem`;群成员列表使用 `OpenIMGroupMemberItem`。会话列表和聊天页标题属于会话数据,应使用 `OpenIMConversationItem.showName`
2525

26-
`OpenIMUserInfo` 的公共字段包括 `userID``nickname``faceURL``ex` 和可选 `createTime``attachedInfo``globalRecvMsgOpt` 是<span className="enterprise-field-badge">商业版字段</span>,读取前应判空,不要假定公共服务端一定返回。
26+
`OpenIMUserInfo` 的公共字段包括 `userID``nickname``faceURL``ex` 和可选 `createTime``attachedInfo``globalRecvMsgOpt` 是<span className="enterprise-field-badge">商业版</span>字段,读取前应判空,不要假定公共服务端一定返回。
2727

2828
## 功能入口
2929

0 commit comments

Comments
 (0)