Skip to content

Commit 0ddd21d

Browse files
FGadvancerFGadvancer
authored
docs: update class specification of messages. (#276)
* 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. * docs: update class of messages. * docs: update class of messages.
1 parent f73a7c2 commit 0ddd21d

23 files changed

+86
-1705
lines changed

‎docs/sdks/class/message/GetAdvancedHistoryMessageListParams.mdx‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,16 @@ toc_max_heading_level: 2
1010

1111
:::info
1212

13-
获取历史列表参数
13+
获取历史列表参数，其中lastMinSeq参数从3.8.2+后已经移除
1414

1515
:::
1616

17-
<Tabs
18-
groupId="sdks-language"
19-
values={[
20-
{ label: 'Unity', value: 'Unity', },
21-
]
22-
}>
23-
24-
<TabItem value="Unity">
2517

2618
### GetAdvancedHistoryMessageListParams
2719

2820
| 字段名称 | 字段类型 | 描述 |
2921
| -------------- | -------- | ------------ |
30-
| UserID | string | 用户ID |
31-
|LastMinSeq | long | 第一页消息不用传，获取第二页开始必传 跟[startMsg]一样 |
32-
|GroupID | string | 群组ID |
3322
| ConversationID | string | 会话 ID |
34-
|StartClientMsgID | string | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
35-
|Count| int | 数量 |
23+
| StartClientMsgID | string | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first |
24+
| Count| int | 数量 |
3625

37-
</TabItem>
38-
</Tabs>

‎docs/sdks/class/message/SearchMessagesParams.mdx‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,18 @@ toc_max_heading_level: 2
1414

1515
:::
1616

17-
<Tabs
18-
groupId="sdks-language"
19-
values={[
20-
{ label: 'Unity', value: 'Unity', },
21-
]
22-
}>
2317

24-
<TabItem value="Unity">
2518

2619
### SearchMessagesParams
2720

2821
| 字段名称 | 字段类型 | 描述 |
2922
| -------------- | -------- | ------------ |
3023
| ConversationID| string | 会话 ID，如果为空，则为全局搜素 |
31-
| KeywordList | string[] | 搜索关键词列表，目前仅支持一个关键词搜索 |
24+
| KeywordList | `[]`string | 搜索关键词列表，目前仅支持一个关键词搜索 |
3225
| KeywordListMatchType | int | 关键词匹配模式，1 代表与，2 代表或，暂时未用 |
33-
| SenderUserIDList | string[] | 指定消息发送的 uid 列表，暂时未用 |
34-
| MessageTypeList| int[] | 消息类型列表 |
35-
| SearchTimePosition | long | 搜索的起始时间点。默认为 0 即代表从现在开始搜索。UTC 时间戳，单位：秒 |
36-
| SearchTimePeriod | long | 从起始时间点开始的过去时间范围，单位秒。默认为 0 即代表不限制时间范围，传 24x60x60 代表过去一天 |
26+
| SenderUserIDList | `[]`string | 指定消息发送的 uid 列表，暂时未用 |
27+
| MessageTypeList| `[]`[MessageContentType](docs/sdks/enum/messageContentType.mdx) | 消息类型列表,目前仅支持指定101（文本消息），105（文件消息）106（@消息） |
28+
| SearchTimePosition | int | 搜索的起始时间点。默认为 0 即代表从现在开始搜索。UTC 时间戳，单位：秒 |
29+
| SearchTimePeriod | int | 从起始时间点开始的过去时间范围，单位秒。默认为 0 即代表不限制时间范围，传 24x60x60 代表过去一天 |
3730
| PageIndex | int | 当前页数，起始第一页为 1,conversationID 为空时候，即全局搜素情況下，无效 |
3831
| Count | int | 每页数量，conversationID 为空时候，即全局搜素情况下，无效 |
39-
40-
</TabItem>
41-
</Tabs>

‎docs/sdks/class/message/atInfo.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ toc_max_heading_level: 2
1919

2020
| 字段名称 | 字段类型 | 描述 |
2121
| ------------- | -------- | -------------------- |
22-
| atUserID | String | at 成员的 ID |
23-
| groupNickname | String | at 成员的昵称/群名片 |
22+
| AtUserID | string | at 成员的 ID |
23+
| GroupNickname | string | at 成员的昵称/群名片 |
2424

‎docs/sdks/class/message/attachedInfoElem.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ toc_max_heading_level: 2
2020

2121
| 字段名称 | 字段类型 | 描述 |
2222
| ---------------- | ---------------------------------------------------------------- | ---------------------------------- |
23-
| isPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 |
24-
| burnDuration | int | 阅后即焚销毁时间 |
25-
| hasReadTime | int | 已读时间戳 |
23+
| IsPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 |
24+
| BurnDuration | int | 阅后即焚销毁时间 |
25+
| HasReadTime | int | 单聊对方已读时间戳 |
2626
| Progress | [UploadProgress](docs/sdks/class/message/uploadProgress.mdx) | 已读时间戳 |
2727

‎docs/sdks/class/message/conversationArgs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ toc_max_heading_level: 2
2121
| 字段名称 | 字段类型 | 描述 |
2222
| -------------- | -------- | ------------ |
2323
| ConversationID| string | 会话 ID |
24-
| ClientMsgIDList | []string | 消息 ID 列表 |
24+
| ClientMsgIDList | `[]`string | 消息 ID 列表 |
2525

‎docs/sdks/class/message/fileElem.mdx‎

Lines changed: 4 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -14,117 +14,13 @@ 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: 'React-Native', value: 'React-Native', },
26-
{ label: 'Unity', value: 'Unity', },
27-
]
28-
}>
29-
30-
<TabItem value="Flutter">
31-
32-
### FileElem
33-
34-
| 字段名称 | 字段类型 | 描述 |
35-
| --------- | -------- | ------------ |
36-
| uuID | String | 唯一 ID |
37-
| filePath | String | 本地资源地址 |
38-
| fileSize | int | 大小 |
39-
| fileName | String | 文件名字 |
40-
| sourceUrl | String | 文件远程地址 |
41-
42-
</TabItem>
43-
44-
<TabItem value="iOS">
45-
46-
### OIMFileElem
47-
48-
| 字段名称 | 字段类型 | 描述 |
49-
| --------- | --------- | ------------ |
50-
| uuID | NSString | 唯一 ID |
51-
| filePath | NSString | 本地资源地址 |
52-
| fileSize | NSInteger | 大小 |
53-
| fileName | NSString | 文件名字 |
54-
| sourceUrl | CGFloat | 文件远程地址 |
55-
56-
</TabItem>
57-
58-
<TabItem value="Android">
59-
60-
### FileElem
61-
62-
| 字段名称 | 字段类型 | 描述 |
63-
| --------- | -------- | ------------ |
64-
| uuID | String | 唯一 ID |
65-
| filePath | String | 本地资源地址 |
66-
| fileSize | int | 大小 |
67-
| fileName | String | 文件名字 |
68-
| sourceUrl | String | 文件远程地址 |
69-
70-
</TabItem>
71-
72-
<TabItem value="Web">
73-
74-
### FileElem
75-
76-
| 字段名称 | 字段类型 | 描述 |
77-
| --------- | -------- | ------------ |
78-
| uuID | string | 唯一 ID |
79-
| filePath | string | 本地资源地址 |
80-
| fileSize | number | 大小 |
81-
| fileName | string | 文件名字 |
82-
| sourceUrl | string | 文件远程地址 |
83-
84-
</TabItem>
85-
86-
<TabItem value="uni-app">
87-
88-
### FileElem
89-
90-
| 字段名称 | 字段类型 | 描述 |
91-
| --------- | -------- | ------------ |
92-
| uuID | string | 唯一 ID |
93-
| filePath | string | 本地资源地址 |
94-
| fileSize | number | 大小 |
95-
| fileName | string | 文件名字 |
96-
| sourceUrl | string | 文件远程地址 |
97-
98-
</TabItem>
99-
100-
<TabItem value="React-Native">
101-
10217
### FileElem
10318

10419
| 字段名称 | 字段类型 | 描述 |
10520
| --------- | -------- | ------------ |
10621
| UUID | string | 唯一 ID |
107-
| FilePath | string | 本地资源地址 |
108-
| FileSize | int | 大小 |
109-
| FileName | string | 文件名字 |
110-
| SourceUrl | string | 文件远程地址 |
111-
112-
</TabItem>
113-
114-
115-
<TabItem value="Unity">
116-
117-
### FileElem
118-
119-
| 字段名称 | 字段类型 | 描述 |
120-
| --------- | -------- | ------------ |
121-
| uuID | string | 唯一 ID |
122-
| filePath | string | 本地资源地址 |
123-
| fileSize | number | 大小 |
22+
| FilePath | string | 本地资源路径 |
23+
| FileSize | int | 文件大小 |
12424
| fileName | string | 文件名字 |
125-
| sourceUrl | string | 文件远程地址 |
126-
127-
</TabItem>
128-
129-
130-
</Tabs>
25+
| SourceURL | string | 文件远程地址 |
26+
| FileType | string | 文件类型|

‎docs/sdks/class/message/groupHasReadInfo.mdx‎

Lines changed: 0 additions & 114 deletions
This file was deleted.

‎docs/sdks/class/message/index.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@ toc_max_heading_level: 2
1717
| 模块名称 | 模块功能简介 |
1818
| ---------------------------------------------------------------------- | -------------------- |
1919
| [MessageInfo](docs/sdks/class/message/messageInfo.mdx) | 消息体 |
20-
| [AtTextElem](docs/sdks/class/message/atElem.mdx) | @消息元素 |
20+
| [AtTextElem](docs/sdks/class/message/atTextElem.mdx) | @消息元素 |
2121
| [AtInfo](docs/sdks/class/message/atInfo.mdx) | @用户信息 |
2222
| [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息元素 |
23-
| [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群聊已读详情 |
2423
| [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片信息元素 |
2524
| [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义信息元素 |
2625
| [FaceElem](docs/sdks/class/message/faceElem.mdx) | 表情信息元素 |

0 commit comments

Comments
 (0)