Skip to content

Commit 052dc71

Browse files
BloominggBloomingg
committed
fix: update
1 parent ea3475a commit 052dc71

File tree

90 files changed

+943
-1604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+943
-1604
lines changed

‎docs/restapi/apis/userManagement/userRegister.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ hide_title: true
4747
|users|必填|array|用户列表|
4848
|users.userID|必填|string|用户ID|
4949
|users.nickname|必填|string|用户昵称|
50-
|users.faceURL|必填|string|用户头像链接|
50+
|users.faceURL|必填|string|用户头像|
5151
### 成功返回示例
5252

5353

‎docs/sdks/api/conversation/getOneConversation.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ values={[
4141
| 参数名称 | 参数类型 | 是否必填 | 描述 |
4242
| ----------- | -------- | -------- | --------------------------------------------------------------- |
4343
| sessionType | [int](docs/sdks/enum/conversationType.mdx) | 是 | 会话类型 |
44-
| sourceID | String | 是 | 单聊为用户 ID，群聊为群聊 ID |
44+
| sourceID | String | 是 | 单聊为用户 ID，群聊为群ID |
4545

4646
### 返回结果
4747

@@ -76,7 +76,7 @@ values={[
7676
| 参数名称 | 参数类型 | 是否必填 | 描述 |
7777
| ----------- | ---------------------------------------------------------- | -------- | -------------------------- |
7878
| sessionType | [OIMConversationType](docs/sdks/enum/conversationType.mdx) | 是 | 会话类型 |
79-
| sourceID | NSString | 是 | 单聊为用户 ID，群聊为群聊 ID |
79+
| sourceID | NSString | 是 | 单聊为用户 ID，群聊为群ID |
8080

8181
### 返回结果
8282

@@ -115,7 +115,7 @@ public void getOneConversation(OnBase<ConversationInfo> base, String sourceId, i
115115
| ----------- | -------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------- |
116116
| base | [OnBase](docs/sdks/callback/onBase.mdx)<List<[ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx)>> | 是 | 回调接口 |
117117
| sessionType | int | 是 | 会话类型[ConversationType](docs/sdks/enum/conversationType.mdx) |
118-
| sourceID | String | 是 | 单聊为用户 ID，群聊为群聊 ID |
118+
| sourceID | String | 是 | 单聊为用户 ID，群聊为群ID |
119119

120120
### 代码示例
121121

‎docs/sdks/api/friend/checkFriend.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ values={[
5757
### 代码示例
5858

5959
```dart showLineNumbers
60-
final list = await OpenIM.iMManager.friendshipManager.checkFriend(userIDList: ['id']);
60+
final list = await OpenIM.iMManager.friendshipManager.checkFriend(userIDList: ['ID']);
6161
```
6262

6363
</TabItem>

‎docs/sdks/api/friend/searchFriends.mdx‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,13 @@ OpenIMClient.getInstance().friendshipManager.searchFriends(new OnBase<List<Frien
157157

158158
### 函数原型
159159

160-
> [`Relationship`](docs/sdks/enum/relationship.mdx)、[`FriendUserItem`](docs/sdks/class/friend/friendInfo.mdx)
160+
> [`FriendUserItem`](docs/sdks/class/friend/friendInfo.mdx)
161161
162162
```ts showLineNumbers
163+
enum Relationship {
164+
Black,
165+
Friend
166+
}
163167
type SearchedFriendsInfo = FriendUserItem & {
164168
relationship: Relationship;
165169
};
@@ -213,9 +217,13 @@ IMSDK.searchFriends({
213217

214218
### 函数原型
215219

216-
> [`Relationship`](docs/sdks/enum/relationship.mdx)、[`FriendUserItem`](docs/sdks/class/friend/friendInfo.mdx)
220+
> [`FriendUserItem`](docs/sdks/class/friend/friendInfo.mdx)
217221
218222
```ts showLineNumbers
223+
enum Relationship {
224+
Black,
225+
Friend
226+
}
219227
type SearchedFriendsInfo = FriendUserItem & {
220228
relationship: Relationship;
221229
};

‎docs/sdks/api/group/acceptGroupApplication.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ values={[
5252

5353
| 参数名称 | 参数类型 | 是否必填 | 描述 |
5454
| --------- | -------- | -------- | --------------- |
55-
| groupID | String | 是 | 群聊 ID |
55+
| groupID | String | 是 | 群ID |
5656
| userID | Sting | 是 | 申请发起者用户 ID |
5757
| handleMsg | Sting | 否 | 备注 |
5858

@@ -93,7 +93,7 @@ values={[
9393

9494
| 参数名称 | 参数类型 | 是否必填 | 描述 |
9595
| ---------- | -------- | -------- | ------- |
96-
| groupID | NSString | 是 | 群聊 ID |
96+
| groupID | NSString | 是 | 群ID |
9797
| fromUserID | NSSting | 是 | 申请发起者用户 ID |
9898
| handleMsg | NSSting | 否 | 信息 |
9999

@@ -134,7 +134,7 @@ public void acceptGroupApplication(OnBase<String> callBack, String gid, String u
134134
| 参数名称 | 参数类型 | 是否必填 | 描述 |
135135
| --------- | --------------------------------------- | -------- | -------- |
136136
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
137-
| gid | String | 是 | 群聊 ID |
137+
| gid | String | 是 | 群ID |
138138
| uid | String | 是 | 用户 ID |
139139
| handleMsg | String | 否 | 信息 |
140140

@@ -175,7 +175,7 @@ IMSDK.acceptGroupApplication({
175175

176176
| 参数名称 | 参数类型 | 是否必填 | 描述 |
177177
| ---------- | -------- | -------- | ----------------- |
178-
| groupID | string | 是 | 群聊 ID |
178+
| groupID | string | 是 | 群ID |
179179
| fromUserID | string | 是 | 申请发起者用户 ID |
180180
| handleMsg | string | 是 | 操作信息 |
181181

@@ -224,7 +224,7 @@ IMSDK.asyncApi('acceptGroupApplication', operationID: string, {
224224
| 参数名称 | 参数类型 | 是否必填 | 描述 |
225225
| ----------- | -------- | -------- | ------------------------------------------------------- |
226226
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
227-
| groupID | string | 是 | 群聊 ID |
227+
| groupID | string | 是 | 群ID |
228228
| fromUserID | string | 是 | 申请发起者用户 ID |
229229
| handleMsg | string | 是 | 操作信息 |
230230

‎docs/sdks/api/group/changeGroupMemberMute.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Future<dynamic> changeGroupMemberMute({
5353

5454
| 参数名称 | 参数类型 | 是否必填 | 描述 |
5555
| -------- | -------- | -------- | ----------------------- |
56-
| groupID | String | 是 | 群聊 ID |
56+
| groupID | String | 是 | 群ID |
5757
| userID | String | 是 | 被禁言的用户 ID |
5858
| seconds | int | 是 | 要禁言的时长，单位秒。为 0 时取消禁言 |
5959

@@ -94,7 +94,7 @@ Future<dynamic> changeGroupMemberMute({
9494

9595
| 参数名称 | 参数类型 | 是否必填 | 描述 |
9696
| ------------ | --------- | -------- | ----------------------- |
97-
| groupID | NSString | 是 | 群聊 ID |
97+
| groupID | NSString | 是 | 群ID |
9898
| userID | NSString | 是 | 被禁言的用户 ID |
9999
| mutedSeconds | NSInteger | 是 | 要禁言的时长，单位秒。为 0 时取消禁言 |
100100

@@ -135,7 +135,7 @@ Future<dynamic> changeGroupMemberMute({
135135
| 参数名称 | 参数类型 | 是否必填 | 描述 |
136136
| -------- | --------------------------------------- | -------- | ----------------------- |
137137
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
138-
| gid | String | 是 | 群聊 ID |
138+
| gid | String | 是 | 群ID |
139139
| uid | String | 是 | 用户 ID |
140140
| seconds | Long | 是 | 禁言时长， 0 时取消禁言 |
141141

@@ -176,7 +176,7 @@ IMSDK.changeGroupMemberMute({
176176

177177
| 参数名称 | 参数类型 | 是否必填 | 描述 |
178178
| ------------ | -------- | -------- | ------------------------------------- |
179-
| groupID | string | 是 | 群聊 ID |
179+
| groupID | string | 是 | 群ID |
180180
| userID | string | 是 | 要操作的群成员用户 ID |
181181
| mutedSeconds | number | 是 | 要禁言的时长，单位秒。为 0 时取消禁言 |
182182

@@ -225,7 +225,7 @@ IMSDK.asyncApi('changeGroupMemberMute', operationID: string, {
225225
| 参数名称 | 参数类型 | 是否必填 | 描述 |
226226
| ------------ | -------- | -------- | ------------------------------------------------------- |
227227
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
228-
| groupID | string | 是 | 群聊 ID |
228+
| groupID | string | 是 | 群ID |
229229
| userID | string | 是 | 要操作的群成员用户 ID |
230230
| mutedSeconds | number | 是 | 要禁言的时长，单位秒。为 0 时取消禁言 |
231231

‎docs/sdks/api/group/changeGroupMute.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ values={[
5050

5151
| 参数名称 | 参数类型 | 是否必填 | 描述 |
5252
| -------- | -------- | -------- | ---------------- |
53-
| groupID | String | 是 | 群聊 ID |
53+
| groupID | String | 是 | 群ID |
5454
| mute | bool | 是 | true：开启群禁言 |
5555

5656
### 返回结果
@@ -88,7 +88,7 @@ values={[
8888

8989
| 参数名称 | 参数类型 | 是否必填 | 描述 |
9090
| -------- | -------- | -------- | ----- |
91-
| groupID | NSString | 是 | 群聊 ID |
91+
| groupID | NSString | 是 | 群ID |
9292
| isMute | BOOL | 是 | 是否禁言 |
9393

9494
### 返回结果
@@ -127,7 +127,7 @@ values={[
127127
| 参数名称 | 参数类型 | 是否必填 | 描述 |
128128
| -------- | --------------------------------------- | -------- | ------------------------ |
129129
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
130-
| gid | String | 是 | 群聊 ID |
130+
| gid | String | 是 | 群ID |
131131
| mute | Boolean | 是 | true 禁言 false 取消禁言 |
132132

133133
### 返回结果
@@ -166,7 +166,7 @@ IMSDK.changeGroupMute({
166166

167167
| 参数名称 | 参数类型 | 是否必填 | 描述 |
168168
| -------- | -------- | -------- | -------- |
169-
| groupID | string | 是 | 群聊 ID |
169+
| groupID | string | 是 | 群ID |
170170
| isMute | boolean | 是 | 是否禁言 |
171171

172172
### 返回结果
@@ -212,7 +212,7 @@ IMSDK.asyncApi('changeGroupMute', operationID: string, {
212212
| 参数名称 | 参数类型 | 是否必填 | 描述 |
213213
| ----------- | -------- | -------- | ------------------------------------------------------- |
214214
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
215-
| groupID | string | 是 | 群聊 ID |
215+
| groupID | string | 是 | 群ID |
216216
| isMute | boolean | 是 | 是否禁言 |
217217

218218
### 返回结果

‎docs/sdks/api/group/createGroup.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ OpenIMClient.getInstance().groupManager.createGroup(memberUserIDs, adminUserIDs
176176

177177
```ts showLineNumbers
178178
IMSDK.createGroup({
179-
groupInfo:GroupInitInfo,
179+
groupInfo:Partial<GroupItem>,
180180
memberUserIDs: string[],
181181
adminUserIDs?: string[],
182182
ownerUserID?: string
@@ -187,7 +187,7 @@ IMSDK.createGroup({
187187

188188
| 参数名称 | 参数类型 | 是否必填 | 描述 |
189189
| ------------- | ---------------------------------------------------- | -------- | -------------------------- |
190-
| groupInfo | [GroupInitInfo](docs/sdks/class/group/groupInfo.mdx) | 是 | 群聊基础信息 |
190+
| groupInfo | Partial<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 是 | 群聊基础信息 |
191191
| memberUserIDs | string[] | 是 | 邀请进入的群成员列表 |
192192
| adminUserIDs | string[] | 否 | 邀请进入并设为管理员的列表 |
193193
| ownerUserID | string | 否 | 群主 ID |
@@ -228,7 +228,7 @@ IMSDK.createGroup({
228228

229229
```ts showLineNumbers
230230
IMSDK.asyncApi('createGroup', operationID: string, {
231-
groupInfo: GroupInitInfo,
231+
groupInfo: Partial<GroupItem>,
232232
memberUserIDs: string[],
233233
adminUserIDs?: string[],
234234
ownerUserID?: string
@@ -240,7 +240,7 @@ IMSDK.asyncApi('createGroup', operationID: string, {
240240
| 参数名称 | 参数类型 | 是否必填 | 描述 |
241241
| ------------- | ---------------------------------------------------- | -------- | ------------------------------------------------------- |
242242
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
243-
| groupInfo | [GroupInitInfo](docs/sdks/class/group/groupInfo.mdx) | 是 | 群聊基础信息 |
243+
| groupInfo | Partial<[GroupItem](docs/sdks/class/group/groupInfo.mdx)> | 是 | 群聊基础信息 |
244244
| memberUserIDs | string[] | 是 | 邀请进入的群成员列表 |
245245
| adminUserIDs | string[] | 否 | 邀请进入并设为管理员的列表 |
246246
| ownerUserID | string | 否 | 群主 ID |

‎docs/sdks/api/group/dismissGroup.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Future<dynamic> dismissGroup({
5151

5252
| 参数名称 | 参数类型 | 是否必填 | 描述 |
5353
| -------- | -------- | -------- | ----- |
54-
| groupID | String | 是 | 群聊 ID |
54+
| groupID | String | 是 | 群ID |
5555

5656
### 返回结果
5757

@@ -86,7 +86,7 @@ Future<dynamic> dismissGroup({
8686

8787
| 参数名称 | 参数类型 | 是否必填 | 描述 |
8888
| -------- | -------- | -------- | ----- |
89-
| groupID | NSString | 是 | 群聊 ID |
89+
| groupID | NSString | 是 | 群ID |
9090

9191
### 返回结果
9292

@@ -123,7 +123,7 @@ Future<dynamic> dismissGroup({
123123
| 参数名称 | 参数类型 | 是否必填 | 描述 |
124124
| -------- | --------------------------------------- | -------- | -------- |
125125
| callBack | [OnBase](docs/sdks/callback/onBase.mdx) | 是 | 回调接口 |
126-
| gid | String | 是 | 群聊 ID |
126+
| gid | String | 是 | 群ID |
127127

128128
### 返回结果
129129

@@ -159,7 +159,7 @@ IMSDK.dismissGroup(groupID: string, operationID?: string): Promise<WsResponse>
159159

160160
| 参数名称 | 参数类型 | 是否必填 | 描述 |
161161
| -------- | -------- | -------- | ------- |
162-
| groupID | string | 是 | 群聊 ID |
162+
| groupID | string | 是 | 群ID |
163163

164164
### 返回结果
165165

@@ -198,7 +198,7 @@ IMSDK.asyncApi('dismissGroup', operationID: string, groupID: string): Promise<vo
198198
| 参数名称 | 参数类型 | 是否必填 | 描述 |
199199
| ----------- | -------- | -------- | ------------------------------------------------------- |
200200
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
201-
| groupID | string | 是 | 群聊 ID |
201+
| groupID | string | 是 | 群ID |
202202

203203
### 返回结果
204204

0 commit comments

Comments
 (0)