Skip to content

Commit e55fc3a

Browse files
BloominggBloomingg
committed
fix: remove extraneous table column separators from SDK documentation.
1 parent a9cdc3a commit e55fc3a

16 files changed

Lines changed: 80 additions & 58 deletions

File tree

‎docs/sdks/api/conversation/getAllConversationList.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ values={[
110110
### 输入参数
111111

112112
| 名称 | 类型 | 描述 |
113-
| -------- | -------------------------------------------------------------------------------------------------------------------- | ---- | -------- |
114-
| callBack | [OnBase](/callback/onBase.md)<List<[ConversationInfo](/class/conversation/conversationInfo.md)>> | 是 | 回调接口 |
113+
| -------- | -------------------------------------------------------------------------------------------------------------------- | ---- |
114+
| callBack | [OnBase](/callback/onBase.md)<List<[ConversationInfo](/class/conversation/conversationInfo.md)>> | 是 |
115115

116116
### 代码示例
117117

@@ -263,8 +263,8 @@ public static void GetAllConversationList(OnBase<List<Conversation>> cb)
263263
### 输入参数
264264

265265
| 名称 | 类型 | 描述 |
266-
| -------- | -------------------------------------------------------------------------------------------------------------------- | ---- | -------- |
267-
| cb | [OnBase](/callback/onBase.md)<List<[Conversation](/class/conversation/conversationInfo.md)>> | 是 | 回调函数 |
266+
| -------- | -------------------------------------------------------------------------------------------------------------------- | ---- |
267+
| cb | [OnBase](/callback/onBase.md)<List<[Conversation](/class/conversation/conversationInfo.md)>> | 是 |
268268

269269
### 代码示例
270270

‎docs/sdks/api/group/searchGroupMembers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Future<List<GroupMembersInfo>> searchGroupMembers({
9999
### 输入参数
100100

101101
| 字段名称 | 字段类型 | 是否必填 |描述 |
102-
| ---------------------- | --------------------- | -----------------------| - |----------------------- |
102+
| ---------------------- | --------------------- | -----------------------| - |
103103
| SearchGroupMembersParam.groupID | NSString | 是 |群ID |
104104
| SearchGroupMembersParam.keywordList | NSArray< NSString \*> | 是 |搜索关键词，目前仅支持一个关键词搜索，不能为空 |
105105
| SearchGroupMembersParam.isSearchUserID | BOOL | 否 |是否以关键词搜索 UserID |

‎docs/sdks/api/initialization/login.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ values={[
6666
### 输入参数
6767

6868
| 参数名称 | 参数类型 | 是否必填 | 描述 |
69-
| ----------- | -------- | -------- | ------------------------------------------------------------------- | --- |
69+
| ----------- | -------- | -------- | ------------------------------------------------------------------- |
7070
| operationID | String? | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
7171
| userID | String | 是 | IM 用户 userID |
72-
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | |
72+
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 |
7373

7474
### 返回结果
7575

@@ -99,10 +99,10 @@ values={[
9999
### 输入参数
100100

101101
| 参数名称 | 参数类型 | 是否必填 | 描述 |
102-
| ----------- | -------- | -------- | ------------------------------------------------------------------- | --- |
102+
| ----------- | -------- | -------- | ------------------------------------------------------------------- |
103103
| operationID | NSString | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
104104
| userID | NSString | 是 | IM 用户 userID |
105-
| token | NSString | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | |
105+
| token | NSString | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 |
106106

107107
### 返回结果
108108

@@ -136,10 +136,10 @@ values={[
136136
### 参数详解
137137

138138
| 参数名称 | 参数类型 | 是否必填 | 描述 |
139-
| -------- | --------------------------------------- | -------- | ------------------------------------------------------------------- | --- |
139+
| -------- | --------------------------------------- | -------- | ------------------------------------------------------------------- |
140140
| callBack | [OnBase](/callback/onBase.md) | 是 | 回调接口 |
141141
| userID | String | 是 | IM 用户 userID |
142-
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | |
142+
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 |
143143

144144
### 代码示例
145145

@@ -257,10 +257,10 @@ IMSDK.asyncApi('login', operationID: string, {
257257
### 输入参数
258258

259259
| 参数名称 | 参数类型 | 是否必填 | 描述 |
260-
| ----------- | -------- | -------- | -------------------------------------------------------------------------- | --- |
260+
| ----------- | -------- | -------- | -------------------------------------------------------------------------- |
261261
| operationID | string | 是 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
262262
| userID | string | 是 | IM 用户 userID |
263-
| token | string | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 `auth/user_token` 来获取 | |
263+
| token | string | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 `auth/user_token` 来获取 |
264264

265265
### 返回结果
266266

@@ -304,9 +304,9 @@ OpenIMSDK.login({
304304
### 输入参数
305305

306306
| 参数名称 | 参数类型 | 是否必填 | 描述 |
307-
| ----------- | -------- | -------- | ------------------------------------------------------------------- | --- |
307+
| ----------- | -------- | -------- | ------------------------------------------------------------------- |
308308
| userID | String | 是 | IM 用户 userID |
309-
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | |
309+
| token | String | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 |
310310
| operationID | String | 否 | 操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数 |
311311

312312
### 返回结果
@@ -347,10 +347,10 @@ public static void Login(OnBase<bool> cb, string uid, string token)
347347
### 输入参数
348348

349349
| 参数名称 | 参数类型 | 是否必填 | 描述 |
350-
| ----------- | -------- | -------- | ------------------------------------------------------------------- | --- |
351-
| cb | [OnBase](/callback/onBase.md)| 是 | 登录成功或失败回调 | |
350+
| ----------- | -------- | -------- | ------------------------------------------------------------------- |
351+
| cb | [OnBase](/callback/onBase.md)| 是 | 登录成功或失败回调 |
352352
| uid | string | 是 | IM 用户 userID |
353-
| token | string | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 | |
353+
| token | string | 是 | OpenIM 用户令牌，业务后台验证用户账号密码后，通过 user_token 来获取 |
354354

355355
### 代码示例
356356

‎docs/sdks/api/message/createSoundMessageByURL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ OpenIMSDK.createSoundMessageByURL({
270270
### 输入参数
271271

272272
| 参数名称 | 参数类型 | 是否必填 | 描述 |
273-
| ----------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | |
273+
| ----------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
274274
| soundPath | string | 是 | 文件路径，传空字符串即可 |
275275
| duration | number | 是 | 录音时长 |
276276
| uuid | string | 是 | 文件唯一 ID |

‎docs/sdks/api/message/createVideoMessageByFile.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ IMSDK.createVideoMessageByFile({
5454
### 输入参数
5555

5656
| 参数名称 | 参数类型 | 是否必填 | 描述 |
57-
| -------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
57+
| -------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
5858
| videoPath | string | 是 | 文件绝对路径，如果没有传空字符即可 |
5959
| duration | number | 是 | 视频时长 |
6060
| videoType | string | 是 | 文件类型，一般为后缀名 |
61-
| snapshotPath | string | 是 | | 视频封面图路径，传空字符串即可 |
61+
| snapshotPath | string | 是 | |
6262
| videoUUID | string | 是 | 视频文件唯一 ID |
6363
| videoUrl | string | 是 | 视频下载地址，自行上传并通过[sendMessageNotOss](/api/message/sendMessageNotOss.md) 发送时，需要传入远程 url，否则为空字符串 |
6464
| videoSize | number | 是 | 文件大小 |
@@ -67,7 +67,7 @@ IMSDK.createVideoMessageByFile({
6767
| snapshotUrl | string | 是 | 视频封面图下载地址，自行上传并通过[sendMessageNotOss](/api/message/sendMessageNotOss.md) 发送时，需要传入远程 url，否则为空字符串 |
6868
| snapshotWidth | number | 是 | 视频缩略图宽度 |
6969
| snapshotHeight | number | 是 | 视频缩略图高度 |
70-
| snapShotType | string | 是 | 视频缩略图类型，一般为后缀名 | |
70+
| snapShotType | string | 是 | 视频缩略图类型，一般为后缀名 |
7171
| videoFile | File | 是 | 视频文件对象 |
7272
| snapshotFile | File | 是 | 视频封面图文件对象 |
7373

0 commit comments

Comments
 (0)