Skip to content

Commit 297d49d

Browse files
FGadvancerFGadvancer
authored
docs: update conversation and users. (#274)
* docs: update conversation and users. * docs: update conversation and users. * docs: update conversation and users. * docs: update conversation and users. * docs: update conversation and users. * feat: callback enum and listener update. * docs: update conversation and users.
1 parent 016ea6f commit 297d49d

File tree

101 files changed

+510
-6234
lines changed

Some content is hidden

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

101 files changed

+510
-6234
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ values={[
4848
String? operationID,
4949
})
5050
```
51+
string bool int
5152

5253
### 输入参数
5354

‎docs/sdks/callback/index.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,12 @@ toc_max_heading_level: 2
3838
| [onGroupDismissed](docs/sdks/callback/onGroupDismissed.mdx) | 群被解散后回调 |
3939
| [onRecvNewMessage](docs/sdks/callback/onRecvNewMessage.mdx) | 收到新消息 |
4040
| [onRecvC2CReadReceipt](docs/sdks/callback/onRecvC2CReadReceipt.mdx) | 单聊消息已读回执 |
41-
| [onRecvGroupReadReceipt](docs/sdks/callback/onRecvGroupReadReceipt.mdx) | 群聊消息已读回执 |
41+
| [onRecvOnlineOnlyMessage](docs/sdks/callback/onRecvOnlineOnlyMessage.mdx) | 在线消息的回调 |
4242
| [onNewRecvMessageRevoked](docs/sdks/callback/onNewRecvMessageRevoked.mdx) | 撤回消息回调 |
43-
| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器会话开始 |
44-
| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器会话完成 |
45-
| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器会话失败 |
43+
| [onSyncServerStart](docs/sdks/callback/onSyncServerStart.mdx) | 同步服务器数据开始 |
44+
| [onSyncServerProgress](docs/sdks/callback/onSyncServerProgress.mdx) | 同步服务器数据进度 |
45+
| [onSyncServerFinish](docs/sdks/callback/onSyncServerFinish.mdx) | 同步服务器数据完成 |
46+
| [onSyncServerFailed](docs/sdks/callback/onSyncServerFailed.mdx) | 同步服务器数据失败 |
4647
| [onNewConversation](docs/sdks/callback/onNewConversation.mdx) | 有新的会话 |
4748
| [onConversationChanged](docs/sdks/callback/onConversationChanged.mdx) | 某些会话的关键信息发生变化 |
4849
| [onTotalUnreadMessageCountChanged](docs/sdks/callback/onTotalUnreadMessageCountChanged.mdx) | 会话未读总数变更通知 |

‎docs/sdks/callback/onBase.mdx‎

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -14,59 +14,10 @@ sdk 会回调此接口，成功会调用 onSuccess 方法并返回特定的数
1414

1515
:::
1616

17-
<Tabs
18-
groupId="sdks-language"
19-
values={[
20-
{ label: 'Android', value: 'Android', },
21-
{ label: 'Unity', value: 'Unity', },
22-
]
23-
}>
24-
25-
<TabItem value="Android">
26-
27-
### 函数原型
28-
29-
```java showLineNumbers
30-
31-
public interface OnBase<T> {
32-
/**
33-
* 失败
34-
*/
35-
void onError(int code, String error);
36-
37-
/**
38-
* 成功
39-
*/
40-
void onSuccess(T data);
41-
}
42-
43-
```
4417

4518
### 返回结果
4619

4720
| 名称 | 描述 |
4821
| --------- | -------------------------------------- |
4922
| onError | 错误代码与错误信息 |
5023
| onSuccess | 泛型类型（根据调用函数的签名指定类型） |
51-
52-
</TabItem>
53-
54-
<TabItem value="Unity">
55-
56-
### 委托
57-
58-
```C# showLineNumbers
59-
public delegate void OnBase<T>(T data, int errCode, string errMsg);
60-
```
61-
62-
### 参数
63-
64-
| 参数名称 | 类型 | 描述 |
65-
| -------- | --------| -------- |
66-
| data | T | 返回数据 |
67-
| errCode | int | 错误码 |
68-
| errMsg | string |错误信息 |
69-
70-
</TabItem>
71-
72-
</Tabs>

‎docs/sdks/callback/onConnectFailed.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ toc_max_heading_level: 2
1717

1818
| 名称 | 类型 | 描述 |
1919
| ----- | ------ | -------- |
20-
| code | long | 错误码 |
21-
| error | String | 错误信息 |
20+
| code | int | 错误码 |
21+
| error | string | 错误信息 |

‎docs/sdks/callback/onConnectSuccess.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,4 @@ toc_max_heading_level: 2
1515

1616
### 返回结果
1717

18-
| 名称 | 类型 | 描述 |
19-
| ---- | --------------------------------------- | ---- |
20-
| data | [WSEvent](docs/sdks/class/response.mdx) | - |
18+
无

‎docs/sdks/callback/onConnecting.mdx‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,4 @@ toc_max_heading_level: 2
1515

1616
### 返回结果
1717

18-
| 名称 | 类型 | 描述 |
19-
| ---- | --------------------------------------- | ---- |
20-
| data | [WSEvent](docs/sdks/class/response.mdx) | - |
18+
无

‎docs/sdks/callback/onConversationChanged.mdx‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ toc_max_heading_level: 2
1414

1515
:::
1616

17-
### 返回数据
1817

19-
| 名称 | 类型 | 描述 |
20-
| ---- | --------------------------------------------------------------------------- | -------- |
21-
| list | [][Conversation](docs/sdks/class/conversation/conversationInfo.mdx) | 会话信息 |
18+
19+
### 返回结果
20+
21+
| 字段名称 | 类型 | 描述 |
22+
| ---- | ------------------------------------------------------ | -------- |
23+
| conversationList | `[]`[ConversationInfo](docs/sdks/class/conversation/conversationInfo.mdx) | 改变的会话信息列表 |
24+

‎docs/sdks/callback/onFriendApplicationDeleted.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/onFriendDeleted.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/onGroupApplicationAccepted.mdx‎

Lines changed: 0 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -14,142 +14,9 @@ toc_max_heading_level: 2
1414

1515
:::
1616

17-
<Tabs
18-
groupId="sdks-language"
19-
values={[
20-
{ label: 'iOS', value: 'iOS', },
21-
{ label: 'Android', value: 'Android', },
22-
{ label: 'Flutter', value: 'Flutter', },
23-
{ label: 'uni-app', value: 'uni-app', },
24-
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
25-
{ label: 'Unity', value: 'Unity', },
26-
]
27-
}>
28-
29-
<TabItem value="Flutter">
30-
31-
### 返回原型
32-
33-
```dart showLineNumbers
34-
Function(GroupApplicationInfo info)? onGroupApplicationAccepted;
35-
```
36-
3717
### 返回结果
3818

3919
| 名称 | 类型 | 描述 |
4020
| ---- | ---------------------------------------------------------------------- | ------------ |
4121
| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 |
4222

43-
</TabItem>
44-
45-
<TabItem value="iOS">
46-
47-
### 返回原型
48-
49-
```swift showLineNumbers
50-
51-
- (void)onGroupApplicationAccepted:(OIMGroupApplicationInfo *)groupApplication;
52-
53-
```
54-
55-
### 返回结果
56-
57-
| 名称 | 类型 | 描述 |
58-
| ----------- | ------------------------------------------------------------------------- | ------------ |
59-
| application | [OIMGroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 |
60-
61-
</TabItem>
62-
63-
<TabItem value="Android">
64-
65-
### 返回原型
66-
67-
```java showLineNumbers
68-
void onGroupApplicationAccepted(GroupApplicationInfo info)
69-
```
70-
71-
### 返回结果
72-
73-
| 名称 | 类型 | 描述 |
74-
| ---- | ---------------------------------------------------------------------- | ------------ |
75-
| info | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 好友拒绝信息 |
76-
77-
78-
</TabItem>
79-
80-
<TabItem value="Web">
81-
82-
### 返回原型
83-
84-
```ts showLineNumbers
85-
86-
onGroupApplicationAccepted(data: WSEvent<GroupApplicationItem>): void;
87-
88-
```
89-
90-
### 返回结果
91-
92-
| 名称 | 类型 | 描述 |
93-
| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- |
94-
| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 |
95-
96-
### 调用示例
97-
98-
```js showLineNumbers
99-
import { getSDK, CbEvents } from '@openim/wasm-client-sdk';
100-
// or
101-
// import { getSDK, CbEvents } from '@openim/client-sdk';
102-
// const IMSDK = getSDK();
103-
const IMSDK = getSDK();
104-
105-
IMSDK.on(CbEvents.OnGroupApplicationAccepted, ({ data }) => {
106-
// data 入群申请
107-
});
108-
```
109-
110-
</TabItem>
111-
112-
<TabItem value="uni-app">
113-
114-
### 返回原型
115-
116-
```ts showLineNumbers
117-
118-
onGroupApplicationAccepted(data: WSEvent<GroupApplicationItem>): void;
119-
120-
```
121-
122-
### 返回结果
123-
124-
| 名称 | 类型 | 描述 |
125-
| ---- | --------------------------------------------------------------------------------------------------------------- | ---------- |
126-
| data | [WSEvent](docs/sdks/class/response.mdx)<[GroupApplicationItem](docs/sdks/class/group/groupApplicationInfo.mdx)> | 群申请信息 |
127-
128-
### 调用示例
129-
130-
```js showLineNumbers
131-
import IMSDK from 'openim-uniapp-polyfill';
132-
133-
IMSDK.subscribe(IMSDK.IMEvents.OnGroupApplicationAccepted, ({ data }) => {
134-
// data 入群申请
135-
});
136-
```
137-
138-
</TabItem>
139-
140-
<TabItem value="Unity">
141-
142-
### 返回原型
143-
144-
```c# showLineNumbers
145-
void OnGroupApplicationAccepted(GroupApplicationInfo application);
146-
```
147-
148-
### 返回结果
149-
150-
| 名称 | 类型 | 描述 |
151-
| ---- | ---------------------------------------------------------------------- | ------------ |
152-
| application | [GroupApplicationInfo](docs/sdks/class/group/groupApplicationInfo.mdx) | 群申请信息 |
153-
154-
</TabItem>
155-
</Tabs>

0 commit comments

Comments
 (0)