Skip to content

Commit 66802a9

Browse files
withchaowithchao
authored
Merge pull request #264 from mo3et/sdk-docs
docs: refactor sdk docs by init and third
2 parents c6afa46 + 5c837f4 commit 66802a9

File tree

11 files changed

+55
-937
lines changed

11 files changed

+55
-937
lines changed

‎docs/sdks/api/initialization/getLoginStatus.mdx‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ values={[
7373

7474
### 返回结果
7575

76-
| 参数名称 | 参数类型 | 描述 |
77-
| --------- | -------- | --------------------------------------- |
78-
| status | [OIMLoginStatus](docs/sdks/enum/loginStatus.mdx) | 登录状态，1：未登录 2：登录中 3：已登录 |
76+
| 参数名称 | 参数类型 | 描述 |
77+
| -------- | ------------------------------------------------ | --------------------------------------- |
78+
| status | [OIMLoginStatus](docs/sdks/enum/loginStatus.mdx) | 登录状态，1：未登录 2：登录中 3：已登录 |
7979

8080
### 代码示例
8181

@@ -198,9 +198,9 @@ OpenIMSDKRN.getLoginStatus(operationID: string): Promise<LoginStatus>
198198

199199
### 输入参数
200200

201-
| 参数名称 | 参数类型 | 描述 |
202-
| -------- | -------- | --------------------------------------- |
203-
| operationID | string | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
201+
| 参数名称 | 参数类型 | 描述 |
202+
| ----------- | -------- | ------------------------------------------------------- |
203+
| operationID | string | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
204204

205205
### 返回结果
206206

@@ -209,7 +209,6 @@ OpenIMSDKRN.getLoginStatus(operationID: string): Promise<LoginStatus>
209209
| Promise.then() | Promise<[LoginStatus](docs/sdks/enum/loginStatus.mdx)\> | 当前用户登录状态 |
210210
| Promise.catch() | Promise<[CatchResponse](docs/sdks/class/response.mdx)\> | 调用失败回调 |
211211

212-
213212
### 代码示例
214213

215214
```js showLineNumbers
@@ -223,6 +222,7 @@ OpenIMSDKRN.getLoginStatus("operationID");
223222
// 调用失败
224223
});
225224
```
225+
226226
</TabItem>
227227

228228
<TabItem value="Unity">
@@ -234,11 +234,12 @@ OpenIMSDKRN.getLoginStatus("operationID");
234234
public static LoginStatus GetLoginStatus()
235235

236236
```
237+
237238
### 返回结果
238-
| 类型 | 描述 |
239-
| ------| ---------------- |
240-
| enum | Empty(0),Logout(1),Logging(2),Logged(3) |
241239

240+
| 参数名称 | 参数类型 | 描述 |
241+
| -------- | -------- | -------------------------------------------------------------------------------------- |
242+
| status | enum | [LoginStatus](docs/sdks/enum/loginStatus.mdx)，Empty(0),Logout(1),Logging(2),Logged(3) |
242243

243244
### 代码示例
244245

@@ -252,5 +253,6 @@ if(status == LoginStatus.Logout){
252253

253254
}
254255
```
256+
255257
</TabItem>
256258
</Tabs>

‎docs/sdks/api/initialization/getLoginUserID.mdx‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ NSString *userID = [OIMManager.manager getLoginUserID];
100100

101101
| 参数名称 | 参数类型 | 描述 |
102102
| -------- | -------- | ------- |
103-
| String | userID | 用户 ID |
103+
| userID | String | 用户 ID |
104104

105105
### 代码示例
106106

@@ -213,7 +213,6 @@ OpenIMSDKRN.getLoginUserID("operationID");
213213
});
214214
```
215215

216-
217216
</TabItem>
218217

219218
<TabItem value="Unity">
@@ -226,9 +225,9 @@ public static string GetLoginUserId()
226225

227226
### 返回结果
228227

229-
| 参数类型 | 描述 |
230-
| -----------| --------------- |
231-
| string | 当前登录用户 ID |
228+
| 参数类型 | 描述 |
229+
| -------- | --------------- |
230+
| string | 当前登录用户 ID |
232231

233232
### 代码示例
234233

‎docs/sdks/api/initialization/initSDK.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,6 @@ var config = new IMConfig()
389389
LogLevel = 5,
390390
IsLogStandardOutput = true,
391391
LogFilePath = logDir,
392-
IsExternalExtensions = true,
393392
};
394393
var connListener = new IConnListener();
395394
var res = IMSDK.InitSDK(config, connListener);

‎docs/sdks/callback/onConnectFailed.mdx‎

Lines changed: 5 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -9,126 +9,13 @@ toc_max_heading_level: 2
99

1010
:::info
1111

12-
建立WebSocket连接失败返回后，触发此回调
12+
建立 WebSocket 连接失败返回后，触发此回调
1313

1414
:::
1515

16-
<Tabs
17-
groupId="sdks-language"
18-
values={[
19-
{ label: 'iOS', value: 'iOS', },
20-
{ label: 'Android', value: 'Android', },
21-
{ label: 'Flutter', value: 'Flutter', },
22-
{ label: 'uni-app', value: 'uni-app', },
23-
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
24-
{ label: 'Unity', value: 'Unity', },
25-
]
26-
}>
27-
28-
<TabItem value="Flutter">
29-
30-
### 返回原型
31-
32-
```dart showLineNumbers
33-
34-
Function()? onConnectFailed;
35-
36-
```
37-
38-
</TabItem>
39-
40-
<TabItem value="iOS">
41-
42-
### 返回原型
43-
44-
```swift showLineNumbers
45-
46-
- (void)onConnectFailed:(NSInteger)code err:(NSString *)err;
47-
48-
```
49-
50-
</TabItem>
51-
52-
<TabItem value="Android">
53-
54-
```java showLineNumbers
55-
56-
void onConnectFailed(long code, String error);
57-
58-
```
59-
### 返回结果
60-
61-
| 名称 | 类型 | 描述 |
62-
| ---- | --------------------------------------- | ---------------- |
63-
| code | long | 错误码 |
64-
| error | String | 错误信息 |
65-
66-
67-
</TabItem>
68-
69-
<TabItem value="Web">
70-
71-
### 返回原型
72-
73-
```ts showLineNumbers
74-
75-
onConnectFailed(data: WSEvent): void;
76-
77-
```
78-
79-
### 调用示例
80-
81-
```js showLineNumbers
82-
import { getSDK, CbEvents } from '@openim/wasm-client-sdk';
83-
// or
84-
// import { getSDK, CbEvents } from '@openim/client-sdk';
85-
// const IMSDK = getSDK();
86-
const IMSDK = getSDK();
87-
88-
IMSDK.on(CbEvents.OnConnectFailed, ({ errCode, errMsg }) => {});
89-
```
90-
9116
### 返回结果
9217

93-
| 名称 | 类型 | 描述 |
94-
| ---- | --------------------------------------- | ---------------- |
95-
| data | [WSEvent](docs/sdks/class/response.mdx) | 连接失败错误信息 |
96-
97-
</TabItem>
98-
99-
<TabItem value="uni-app">
100-
101-
### 返回原型
102-
103-
```ts showLineNumbers
104-
105-
onConnectFailed(data: WSEvent): void;
106-
107-
```
108-
109-
### 返回结果
110-
111-
| 名称 | 类型 | 描述 |
112-
| ---- | --------------------------------------- | ---------------- |
113-
| data | [WSEvent](docs/sdks/class/response.mdx) | 连接失败错误信息 |
114-
115-
### 调用示例
116-
117-
```js showLineNumbers
118-
import IMSDK from 'openim-uniapp-polyfill';
119-
120-
IMSDK.subscribe(IMSDK.IMEvents.OnConnectFailed, ({ errCode, errMsg }) => {});
121-
```
122-
123-
</TabItem>
124-
125-
<TabItem value="Unity">
126-
127-
### 返回原型
128-
129-
```C# showLineNumbers
130-
void OnConnectFailed(int errCode, string errMsg);
131-
```
132-
133-
</TabItem>
134-
</Tabs>
18+
| 名称 | 类型 | 描述 |
19+
| ----- | ------ | -------- |
20+
| code | long | 错误码 |
21+
| error | String | 错误信息 |

‎docs/sdks/callback/onConnectSuccess.mdx‎

Lines changed: 1 addition & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -9,123 +9,12 @@ toc_max_heading_level: 2
99

1010
:::info
1111

12-
建立WebSocket连接成功返回后，触发此回调
12+
建立 WebSocket 连接成功返回后，触发此回调
1313

1414
:::
1515

16-
<Tabs
17-
groupId="sdks-language"
18-
values={[
19-
{ label: 'iOS', value: 'iOS', },
20-
{ label: 'Android', value: 'Android', },
21-
{ label: 'Flutter', value: 'Flutter', },
22-
{ label: 'uni-app', value: 'uni-app', },
23-
{ label: 'Browser/Electron/MiniProgram', value: 'Web', },
24-
{ label: 'Unity', value: 'Unity', },
25-
]
26-
}>
27-
28-
<TabItem value="Flutter">
29-
30-
### 返回原型
31-
32-
```dart showLineNumbers
33-
34-
Function()? onConnectSuccess;
35-
36-
```
37-
38-
</TabItem>
39-
40-
<TabItem value="iOS">
41-
42-
### 返回原型
43-
44-
```swift showLineNumbers
45-
46-
- (void)onConnectSuccess;
47-
48-
```
49-
50-
</TabItem>
51-
52-
<TabItem value="Android">
53-
54-
### 原型
55-
56-
```java showLineNumbers
57-
58-
void onConnectSuccess();
59-
60-
```
61-
### 返回原型
62-
无
63-
64-
</TabItem>
65-
66-
<TabItem value="Web">
67-
68-
### 返回原型
69-
70-
```ts showLineNumbers
71-
72-
onConnectSuccess(data: WSEvent): void;
73-
74-
```
75-
76-
### 调用示例
77-
78-
```js showLineNumbers
79-
import { getSDK, CbEvents } from '@openim/wasm-client-sdk';
80-
// or
81-
// import { getSDK, CbEvents } from '@openim/client-sdk';
82-
// const IMSDK = getSDK();
83-
const IMSDK = getSDK();
84-
85-
IMSDK.on(CbEvents.OnConnectSuccess, () => {});
86-
```
87-
8816
### 返回结果
8917

9018
| 名称 | 类型 | 描述 |
9119
| ---- | --------------------------------------- | ---- |
9220
| data | [WSEvent](docs/sdks/class/response.mdx) | - |
93-
94-
</TabItem>
95-
96-
<TabItem value="uni-app">
97-
98-
### 返回原型
99-
100-
```ts showLineNumbers
101-
102-
onConnectSuccess(data: WSEvent): void;
103-
104-
```
105-
106-
### 返回结果
107-
108-
| 名称 | 类型 | 描述 |
109-
| ---- | --------------------------------------- | ---- |
110-
| data | [WSEvent](docs/sdks/class/response.mdx) | - |
111-
112-
### 调用示例
113-
114-
```js showLineNumbers
115-
import IMSDK from 'openim-uniapp-polyfill';
116-
117-
IMSDK.subscribe(IMSDK.IMEvents.OnConnectSuccess, () => {});
118-
```
119-
120-
</TabItem>
121-
122-
<TabItem value="Unity">
123-
124-
### 返回原型
125-
126-
```C# showLineNumbers
127-
void OnConnectSuccess();
128-
```
129-
130-
</TabItem>
131-
</Tabs>

0 commit comments

Comments
 (0)