diff --git a/docs/sdks/class/message/GetAdvancedHistoryMessageListParams.mdx b/docs/sdks/class/message/GetAdvancedHistoryMessageListParams.mdx index 737c70c39d..ebe77112f3 100644 --- a/docs/sdks/class/message/GetAdvancedHistoryMessageListParams.mdx +++ b/docs/sdks/class/message/GetAdvancedHistoryMessageListParams.mdx @@ -10,29 +10,16 @@ toc_max_heading_level: 2 :::info -获取历史列表参数 +获取历史列表参数，其中lastMinSeq参数从3.8.2+后已经移除 ::: - - - ### GetAdvancedHistoryMessageListParams | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ------------ | -| UserID | string | 用户ID | -|LastMinSeq | long | 第一页消息不用传，获取第二页开始必传 跟[startMsg]一样 | -|GroupID | string | 群组ID | | ConversationID | string | 会话 ID | -|StartClientMsgID | string | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | -|Count| int | 数量 | +| StartClientMsgID | string | 从这条消息开始查询[count]条，获取的列表 index==length-1 为最新消息，所以获取下一页历史记录 startMsg=list.first | +| Count| int | 数量 | - - diff --git a/docs/sdks/class/message/SearchMessagesParams.mdx b/docs/sdks/class/message/SearchMessagesParams.mdx index 64a314d2da..a0e3f44e60 100644 --- a/docs/sdks/class/message/SearchMessagesParams.mdx +++ b/docs/sdks/class/message/SearchMessagesParams.mdx @@ -14,28 +14,18 @@ toc_max_heading_level: 2 ::: - - ### SearchMessagesParams | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ------------ | | ConversationID| string | 会话 ID，如果为空，则为全局搜素 | -| KeywordList | string[] | 搜索关键词列表，目前仅支持一个关键词搜索 | +| KeywordList | `[]`string | 搜索关键词列表，目前仅支持一个关键词搜索 | | KeywordListMatchType | int | 关键词匹配模式，1 代表与，2 代表或，暂时未用 | -| SenderUserIDList | string[] | 指定消息发送的 uid 列表，暂时未用 | -| MessageTypeList| int[] | 消息类型列表 | -| SearchTimePosition | long | 搜索的起始时间点。默认为 0 即代表从现在开始搜索。UTC 时间戳，单位：秒 | -| SearchTimePeriod | long | 从起始时间点开始的过去时间范围，单位秒。默认为 0 即代表不限制时间范围，传 24x60x60 代表过去一天 | +| SenderUserIDList | `[]`string | 指定消息发送的 uid 列表，暂时未用 | +| MessageTypeList| `[]`[MessageContentType](docs/sdks/enum/messageContentType.mdx) | 消息类型列表,目前仅支持指定101（文本消息），105（文件消息）106（@消息） | +| SearchTimePosition | int | 搜索的起始时间点。默认为 0 即代表从现在开始搜索。UTC 时间戳，单位：秒 | +| SearchTimePeriod | int | 从起始时间点开始的过去时间范围，单位秒。默认为 0 即代表不限制时间范围，传 24x60x60 代表过去一天 | | PageIndex | int | 当前页数，起始第一页为 1,conversationID 为空时候，即全局搜素情況下，无效 | | Count | int | 每页数量，conversationID 为空时候，即全局搜素情况下，无效 | - - - diff --git a/docs/sdks/class/message/atInfo.mdx b/docs/sdks/class/message/atInfo.mdx index dcea850450..4b0c366ac0 100644 --- a/docs/sdks/class/message/atInfo.mdx +++ b/docs/sdks/class/message/atInfo.mdx @@ -19,6 +19,6 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ------------- | -------- | -------------------- | -| atUserID | String | at 成员的 ID | -| groupNickname | String | at 成员的昵称/群名片 | +| AtUserID | string | at 成员的 ID | +| GroupNickname | string | at 成员的昵称/群名片 | diff --git a/docs/sdks/class/message/attachedInfoElem.mdx b/docs/sdks/class/message/attachedInfoElem.mdx index ce4075f635..c8e4404879 100644 --- a/docs/sdks/class/message/attachedInfoElem.mdx +++ b/docs/sdks/class/message/attachedInfoElem.mdx @@ -20,8 +20,8 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | ---------------- | ---------------------------------------------------------------- | ---------------------------------- | -| isPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 | -| burnDuration | int | 阅后即焚销毁时间 | -| hasReadTime | int | 已读时间戳 | +| IsPrivateChat | bool | 标识是否为阅后即焚消息，仅支持单聊 | +| BurnDuration | int | 阅后即焚销毁时间 | +| HasReadTime | int | 单聊对方已读时间戳 | | Progress | [UploadProgress](docs/sdks/class/message/uploadProgress.mdx) | 已读时间戳 | diff --git a/docs/sdks/class/message/conversationArgs.mdx b/docs/sdks/class/message/conversationArgs.mdx index e23bf1fe47..862ec47af7 100644 --- a/docs/sdks/class/message/conversationArgs.mdx +++ b/docs/sdks/class/message/conversationArgs.mdx @@ -21,5 +21,5 @@ toc_max_heading_level: 2 | 字段名称 | 字段类型 | 描述 | | -------------- | -------- | ------------ | | ConversationID| string | 会话 ID | -| ClientMsgIDList | []string | 消息 ID 列表 | +| ClientMsgIDList | `[]`string | 消息 ID 列表 | diff --git a/docs/sdks/class/message/fileElem.mdx b/docs/sdks/class/message/fileElem.mdx index 723cd16008..666bc0c4d3 100644 --- a/docs/sdks/class/message/fileElem.mdx +++ b/docs/sdks/class/message/fileElem.mdx @@ -14,117 +14,13 @@ toc_max_heading_level: 2 ::: - - - - -### FileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | String | 唯一 ID | -| filePath | String | 本地资源地址 | -| fileSize | int | 大小 | -| fileName | String | 文件名字 | -| sourceUrl | String | 文件远程地址 | - - - - - -### OIMFileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | --------- | ------------ | -| uuID | NSString | 唯一 ID | -| filePath | NSString | 本地资源地址 | -| fileSize | NSInteger | 大小 | -| fileName | NSString | 文件名字 | -| sourceUrl | CGFloat | 文件远程地址 | - - - - - -### FileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | String | 唯一 ID | -| filePath | String | 本地资源地址 | -| fileSize | int | 大小 | -| fileName | String | 文件名字 | -| sourceUrl | String | 文件远程地址 | - - - - - -### FileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| filePath | string | 本地资源地址 | -| fileSize | number | 大小 | -| fileName | string | 文件名字 | -| sourceUrl | string | 文件远程地址 | - - - - - -### FileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| filePath | string | 本地资源地址 | -| fileSize | number | 大小 | -| fileName | string | 文件名字 | -| sourceUrl | string | 文件远程地址 | - - - - - ### FileElem | 字段名称 | 字段类型 | 描述 | | --------- | -------- | ------------ | | UUID | string | 唯一 ID | -| FilePath | string | 本地资源地址 | -| FileSize | int | 大小 | -| FileName | string | 文件名字 | -| SourceUrl | string | 文件远程地址 | - - - - - - -### FileElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| filePath | string | 本地资源地址 | -| fileSize | number | 大小 | +| FilePath | string | 本地资源路径 | +| FileSize | int | 文件大小 | | fileName | string | 文件名字 | -| sourceUrl | string | 文件远程地址 | - - - - - +| SourceURL | string | 文件远程地址 | +| FileType | string | 文件类型| diff --git a/docs/sdks/class/message/groupHasReadInfo.mdx b/docs/sdks/class/message/groupHasReadInfo.mdx deleted file mode 100644 index 241985a9cd..0000000000 --- a/docs/sdks/class/message/groupHasReadInfo.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -sidebar_position: 2 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -# GroupHasReadInfo - -## 功能介绍 - -:::info - -群消息已读信息。 - -::: - - - - - -### OIMGroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------- | ---------------------- | -| hasReadUserIDList | List | 已读的用户 ID 列表 | -| hasReadCount | int | 已读总数 | -| groupMemberCount | int | 发送此条消息时的群人数 | - - - - - -### OIMGroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | --------------------- | ---------------------- | -| hasReadUserIDList | NSArray | 已读的用户 ID 列表 | -| hasReadCount | NSInteger | 已读总数 | -| groupMemberCount | NSInteger | 发送此条消息时的群人数 | - - - - - -### GroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------- | ---------------------- | -| hasReadUserIDList | List | 已读的用户 ID 列表 | -| hasReadCount | int | 已读总数 | -| groupMemberCount | int | 发送此条消息时的群人数 | - - - - - -### GroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | -------- | ------------------------ | -| hasReadUserIDList | string[] | 已读的用户 ID 列表 | -| hasReadCount | number | 已读总数 | -| groupMemberCount | number | 发送此条消息时的群内人数 | - - - - - -### GroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | -------- | ------------------------ | -| hasReadUserIDList | string[] | 已读的用户 ID 列表 | -| hasReadCount | number | 已读总数 | -| groupMemberCount | number | 发送此条消息时的群内人数 | - - - - - - -### GroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | -------- | ------------------------ | -| hasReadUserIDList | string[] | 已读的用户 ID 列表 | -| hasReadCount | number | 已读总数 | -| groupMemberCount | number | 发送此条消息时的群内人数 | - - - - - -### GroupHasReadInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------- | ---------------------- | -| HasReadUserIDList | string[] | 已读的用户 ID 列表 | -| HasReadCount | int | 已读总数 | -| GroupMemberCount | int | 发送此条消息时的群人数 | - - - diff --git a/docs/sdks/class/message/index.mdx b/docs/sdks/class/message/index.mdx index bb0ea49c88..b40f1ebad4 100644 --- a/docs/sdks/class/message/index.mdx +++ b/docs/sdks/class/message/index.mdx @@ -17,10 +17,9 @@ toc_max_heading_level: 2 | 模块名称 | 模块功能简介 | | ---------------------------------------------------------------------- | -------------------- | | [MessageInfo](docs/sdks/class/message/messageInfo.mdx) | 消息体 | -| [AtTextElem](docs/sdks/class/message/atElem.mdx) | @消息元素 | +| [AtTextElem](docs/sdks/class/message/atTextElem.mdx) | @消息元素 | | [AtInfo](docs/sdks/class/message/atInfo.mdx) | @用户信息 | | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息元素 | -| [GroupHasReadInfo](docs/sdks/class/message/groupHasReadInfo.mdx) | 群聊已读详情 | | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片信息元素 | | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义信息元素 | | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 表情信息元素 | diff --git a/docs/sdks/class/message/locationElem.mdx b/docs/sdks/class/message/locationElem.mdx index fe59685ce5..59d96d9d10 100644 --- a/docs/sdks/class/message/locationElem.mdx +++ b/docs/sdks/class/message/locationElem.mdx @@ -14,100 +14,13 @@ toc_max_heading_level: 2 ::: - - ### LocationElem -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | String | 描述信息 | -| longitude | double | 经度 | -| latitude | double | 纬度 | - - - - - -### OIMLocationElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | NSString | 描述信息 | -| longitude | double | 经度 | -| latitude | double | 纬度 | - - - - - -### LocationElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | String | 描述信息 | -| longitude | double | 经度 | -| latitude | double | 纬度 | - - - - - -### LocationElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | string | 描述信息 | -| longitude | number | 经度 | -| latitude | number | 纬度 | - - - - - -### LocationElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | string | 描述信息 | -| longitude | number | 经度 | -| latitude | number | 纬度 | - - - - -### LocationElem - | 字段名称 | 字段类型 | 描述 | | --------- | -------- | -------- | | Desc | string | 描述信息 | | Longitude | double | 经度 | | Latitude | double | 纬度 | - - - -### LocationElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | -------- | -| desc | string | 描述信息 | -| longitude | number | 经度 | -| latitude | number | 纬度 | - - - - - diff --git a/docs/sdks/class/message/mergeElem.mdx b/docs/sdks/class/message/mergeElem.mdx index a8e2523e13..82286a854c 100644 --- a/docs/sdks/class/message/mergeElem.mdx +++ b/docs/sdks/class/message/mergeElem.mdx @@ -14,102 +14,12 @@ toc_max_heading_level: 2 ::: - - - - -### MergeElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------------- | ---------------------- | -| title | String | 标题 | -| abstractList | List | 摘要 | -| multiMessage | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | 具体选择合并的消息列表 | - - - - - -### OIMMergeElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | --------------------------------------------------------------------------- | ------------------ | -| title | NSString | 标题 | -| abstractList | NSArray | 摘要 | -| multiMessage | NSArray< [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) \* > | 具体选择合并的消息列表 | - - - - - -### MergeElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------------- | ---------------------- | -| title | String | 标题 | -| abstractList | List | 摘要 | -| multiMessage | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | 具体选择合并的消息列表 | - - - - - -### MergeElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------------- | ---------------------- | -| title | string | 标题 | -| abstractList | string[] | 摘要列表 | -| multiMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 具体选择合并的消息列表 | - - - - - -### MergeElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------------- | ---------------------- | -| title | string | 标题 | -| abstractList | string[] | 摘要列表 | -| multiMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 具体选择合并的消息列表 | - - - - ### MergeElem | 字段名称 | 字段类型 | 描述 | | ------------ | -------------------------------------------------------- | ---------------------- | | Title | string | 标题 | -| AbstractList | string[] | 摘要 | -| MultiMessage | [Message](docs/sdks/class/message/messageInfo.mdx)[] | 具体选择合并的消息列表 | - - - - - -### MergeElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------------- | ---------------------- | -| title | string | 标题 | -| abstractList | string[] | 摘要列表 | -| multiMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 具体选择合并的消息列表 | - - - +| AbstractList | `[]`string | 摘要 | +| MultiMessage | `[]`[Message](docs/sdks/class/message/messageInfo.mdx) | 具体选择合并的消息列表 | - diff --git a/docs/sdks/class/message/messageInfo.mdx b/docs/sdks/class/message/messageInfo.mdx index d4a824888a..77ad01c9a8 100644 --- a/docs/sdks/class/message/messageInfo.mdx +++ b/docs/sdks/class/message/messageInfo.mdx @@ -18,309 +18,7 @@ toc_max_heading_level: 2 ::: - - - -### Message - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ------------------------------- | -| clientMsgID | String | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | String | 服务端消息唯一 ID，内部使用 | -| createTime | int | 创建时间 | -| sendTime | int | 发送时间 | -| sessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| sendID | String | 发送者 ID | -| recvID | String | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | int | 内部字段 | -| contentType | [int](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| platformID | int | 平台号 | -| senderNickname | String | 发送者昵称 | -| senderFaceUrl | String | 发送者头像 | -| groupID | String | 群 ID | -| content | String | 内部字段 | -| seq | int | 消息的 seq | -| isRead | bool | 是否已读 | -| status | [int](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| attachedInfo | String | 附加信息 | -| ex | String | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并 | -| atElem | [AtElem](docs/sdks/class/message/atElem.mdx) | @ 信息 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息 | -| hasReadTime | int | 单聊已读时间戳 | -| isReact | bool | 暂未使用 | -| isExternalExtensions | bool | 暂未使用 | -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | - - - - - -### OIMMessageInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ------------------------------- | -| clientMsgID | NSString | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | NSString | 服务端消息唯一 ID，内部使用 | -| createTime | NSInteger | 创建时间 | -| sendTime | NSInteger | 发送时间 | -| sessionType | [OIMConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| sendID | NSString | 发送者 ID | -| recvID | NSString | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | NSInteger | 内部字段 | -| contentType | [OIMMessageContentType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| platformID | NSInteger | 平台号 | -| senderNickname | NSString | 发送者昵称 | -| senderFaceUrl | NSString | 发送者头像 | -| groupID | NSString | 群 ID | -| content | NSString | 内部字段 | -| seq | NSInteger | 消息的 seq | -| isRead | BOOL | 是否已读 | -| status | [OIMMessageStatus](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| attachedInfo | NSString | 附加信息 | -| ex | NSString | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并 | -| atElem | [AtElem](docs/sdks/class/message/atElem.mdx) | @ 信息 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息 | -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | -| hasReadTime | NSInteger | 单聊已读时间戳 | -| isReact | BOOL | 暂未使用 | -| isExternalExtensions | BOOL | 暂未使用 | - - - - - -### Message - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | --- | -| clientMsgID | String | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | String | 服务端消息唯一 ID，内部使用 | -| createTime | int | 创建时间 | -| sendTime | int | 发送时间 | -| sessionType | int | 会话类型 [ConversationType](docs/sdks/enum/conversationType.mdx) | -| sendID | String | 发送者 ID | -| recvID | String | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | int | 内部字段 | -| contentType | int | 消息类型 [MessageType](docs/sdks/enum/messageContentType.mdx) | -| platformID | int | 平台号 | -| senderNickname | String | 发送者昵称 | -| senderFaceUrl | String | 发送者头像 | -| groupID | String | 群 ID | -| content | String | 内部字段 | -| seq | int | 消息的 seq | -| isRead | bool | 是否已读 | -| status | int | 消息发送状态 [MessageStatus](docs/sdks/enum/messageStatus.mdx) | -| attachedInfo | String | 内部字段 | -| ex | String | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并 | -| atElem | [AtElem](docs/sdks/class/message/atElem.mdx) | @ 信息 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息 | | -| hasReadTime | int | 单聊已读时间戳 | -| isReact | boolean | 暂未使用 | -| isExternalExtensions | boolean | 暂未使用 -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | -| ext | String | Android 扩展信息 | - - - - - -### MessageItem - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ------------------------------- | -| clientMsgID | string | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | string | 服务端消息唯一 ID，内部使用 | -| createTime | number | 创建时间 | -| sendTime | number | 发送时间 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| sendID | string | 发送者 ID | -| recvID | string | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | number | 内部字段 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| platformID | [Platform](/docs/sdks/enum/platform.mdx) | 平台号 | -| senderNickname | string | 发送者昵称 | -| senderFaceUrl | string | 发送者头像 | -| groupID | string | 群 ID | -| content | string | 内部字段 | -| seq | number | 消息的 seq | -| isRead | boolean | 是否已读 | -| status | [MessageStatus](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| attachedInfo | string | 内部字段 | -| ex | string | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片消息详情 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音消息详情 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频消息详情 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件消息详情 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并消息详情 | -| atTextElem | [atTextElem](docs/sdks/class/message/atElem.mdx) | @消息详情 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置消息详情 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用消息详情 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义消息详情 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知消息详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情详情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息详情 | -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容详情 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容详情 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | -| hasReadTime | number | 单聊已读时间戳 | -| isReact | boolean | 暂未使用 | -| isExternalExtensions | boolean | 暂未使用 | - - - - - -### MessageItem - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ------------------------------- | -| clientMsgID | string | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | string | 服务端消息唯一 ID，内部使用 | -| createTime | number | 创建时间 | -| sendTime | number | 发送时间 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| sendID | string | 发送者 ID | -| recvID | string | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | number | 内部字段 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| platformID | [Platform](/docs/sdks/enum/platform.mdx) | 平台号 | -| senderNickname | string | 发送者昵称 | -| senderFaceUrl | string | 发送者头像 | -| groupID | string | 群 ID | -| content | string | 内部字段 | -| seq | number | 消息的 seq | -| isRead | boolean | 是否已读 | -| status | [MessageStatus](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| attachedInfo | string | 内部字段 | -| ex | string | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片消息详情 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音消息详情 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频消息详情 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件消息详情 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并消息详情 | -| atTextElem | [atTextElem](docs/sdks/class/message/atElem.mdx) | @消息详情 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置消息详情 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用消息详情 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义消息详情 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知消息详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情详情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息详情 | -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容详情 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容详情 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | -| hasReadTime | number | 单聊已读时间戳 | -| isReact | boolean | 暂未使用 | -| isExternalExtensions | boolean | 暂未使用 | - - - - - -### MessageItem - -| 字段名称 | 字段类型 | 描述 | -| -------------------- | ---------------------------------------------------------------- | ------------------------------- | -| clientMsgID | string | 客户端消息唯一 ID，推荐使用 | -| serverMsgID | string | 服务端消息唯一 ID，内部使用 | -| createTime | number | 创建时间 | -| sendTime | number | 发送时间 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| sendID | string | 发送者 ID | -| recvID | string | 接收者 ID，为群聊会话时无需关注 | -| msgFrom | number | 内部字段 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| platformID | [Platform](/docs/sdks/enum/platform.mdx) | 平台号 | -| senderNickname | string | 发送者昵称 | -| senderFaceUrl | string | 发送者头像 | -| groupID | string | 群 ID | -| content | string | 内部字段 | -| seq | number | 消息的 seq | -| isRead | boolean | 是否已读 | -| status | [MessageStatus](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| attachedInfo | string | 内部字段 | -| ex | string | 扩展信息 | -| offlinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | -| pictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片消息详情 | -| soundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音消息详情 | -| videoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频消息详情 | -| fileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件消息详情 | -| mergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并消息详情 | -| atTextElem | [atTextElem](docs/sdks/class/message/atElem.mdx) | @消息详情 | -| locationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置消息详情 | -| quoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用消息详情 | -| customElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义消息详情 | -| notificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知消息详情 | -| faceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情详情 | -| attachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息详情 | -| textElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容详情 | -| cardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容详情 | -| advancedTextElem | - | 暂未使用 | -| typingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | -| hasReadTime | number | 单聊已读时间戳 | -| isReact | boolean | 暂未使用 | -| isExternalExtensions | boolean | 暂未使用 | - - - - ### Message @@ -330,42 +28,34 @@ values={[ | ServerMsgID | string | 服务端消息唯一 ID，内部使用 | | CreateTime | int | 创建时间 | | SendTime | int | 发送时间 | -| SessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | +| SessionType | [ConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | | SendID | string | 发送者 ID | | RecvID | string | 接收者 ID，为群聊会话时无需关注 | -| MsgFrom | int | 内部字段 | -| ContentType | [int](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| PlatformID | int | 平台号 | +| MsgFrom | [MessageFrom](docs/sdks/enum/messageFrom.mdx) | 消息来源 | +| ContentType | [MessageContentType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | +| PlatformID | [IMPlatformID](/docs/sdks/enum/platform.mdx) | 平台号 | | SenderNickname | string | 发送者昵称 | | SenderFaceUrl | string | 发送者头像 | | GroupID | string | 群 ID | -| Content | string | 内部字段 | -| Seq | int | 消息的 seq | +| Seq | int | 消息的会话递增序列化 | | IsRead | bool | 是否已读 | -| Status | [int](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | -| AttachedInfo | string | 附加信息 | -| Ex | string | 扩展信息 | +| Status | [MessageStatus](docs/sdks/enum/messageStatus.mdx) | 消息发送状态 | +| Ex | string | 远程扩展信息，卸载重装后还可获取到 | +| LocalEx | string |本地扩展消息，卸载重装后不能获取到 | | OfflinePush | [OfflinePushInfo](docs/sdks/class/message/offlinePushInfo.mdx) | 离线推送详情 | +| TextElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容 | +| CardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容 | | PictureElem | [PictureElem](docs/sdks/class/message/pictureElem.mdx) | 图片 | | SoundElem | [SoundElem](docs/sdks/class/message/soundElem.mdx) | 语音 | | VideoElem | [VideoElem](docs/sdks/class/message/videoElem.mdx) | 视频 | | FileElem | [FileElem](docs/sdks/class/message/fileElem.mdx) | 文件 | | MergeElem | [MergeElem](docs/sdks/class/message/mergeElem.mdx) | 合并 | -| AtElem | [AtElem](docs/sdks/class/message/atElem.mdx) | @ 信息 | +| AtTextElem | [AtTextElem](docs/sdks/class/message/atTextElem.mdx) | @ 信息 | +| FaceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情 | | LocationElem | [LocationElem](docs/sdks/class/message/locationElem.mdx) | 位置 | -| QuoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用 | | CustomElem | [CustomElem](docs/sdks/class/message/customElem.mdx) | 自定义 | +| QuoteElem | [QuoteElem](docs/sdks/class/message/quoteElem.mdx) | 引用 | | NotificationElem | [NotificationElem](docs/sdks/class/message/notificationElem.mdx) | 通知详情 | -| FaceElem | [FaceElem](docs/sdks/class/message/faceElem.mdx) | 自定义表情 | | AttachedInfoElem | [AttachedInfoElem](docs/sdks/class/message/attachedInfoElem.mdx) | 附加信息 | -| HasReadTime | int | 单聊已读时间戳 | -| IsReact | bool | 暂未使用 | -| IsExternalExtensions | bool | 暂未使用 | -| TextElem | [TextElem](docs/sdks/class/message/textElem.mdx) | 文本内容 | -| CardElem | [CardElem](docs/sdks/class/message/cardElem.mdx) | 名片内容 | -| AdvancedTextElem | - | 暂未使用 | | TypingElem | [TypingElem](docs/sdks/class/message/typingElem.mdx) | 正在输入详情 | - - - diff --git a/docs/sdks/class/message/notificationElem.mdx b/docs/sdks/class/message/notificationElem.mdx index 3dec3cd6e4..9855212c64 100644 --- a/docs/sdks/class/message/notificationElem.mdx +++ b/docs/sdks/class/message/notificationElem.mdx @@ -10,83 +10,12 @@ toc_max_heading_level: 2 :::info -通知信息。 - +通知信息，例如成为好友、有人加入群、有人退出群等。 ::: - - - - -### NotificationElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| detail | String | 通知详情JSON | - - - - - -### OIMNotificationElem +:::caution 注： +其中detail为一个json字符串，需要根据json内容自行反序列化需要的内容，可以参考demo -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------------- | -| detail | NSString | 通知详情JSON | - - - - - -### NotificationElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| detail | String | 通知详情json | - - - - - -### NotificationElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| detail | string | 通知详情json | - - - - - -### NotificationElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- | -| detail | string | 通知详情json | - - - - -### NotificationElem - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | ---- |====== -| detail | string | 通知详情json | - - - - ### NotificationElem @@ -94,6 +23,3 @@ values={[ | -------- | -------- | ---- | | Detail | string | 通知详情JSON | - - - diff --git a/docs/sdks/class/message/offlinePushInfo.mdx b/docs/sdks/class/message/offlinePushInfo.mdx index ca8df582e8..40dba7b199 100644 --- a/docs/sdks/class/message/offlinePushInfo.mdx +++ b/docs/sdks/class/message/offlinePushInfo.mdx @@ -14,111 +14,6 @@ toc_max_heading_level: 2 ::: - - - - -### OfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------------ | -| title | String | 推送标题 | -| desc | String | 推送描述 | -| iOSPushSound | String | 推送声音文件的名称 | -| iOSBadgeCount | bool | 展示角标 | -| operatorUserID | String | | -| ex | String | 扩展内容 | - - - - - -### OIMOfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------------ | -| title | NSString | 推送标题 | -| desc | NSString | 推送描述 | -| iOSPushSound | NSString | 推送声音文件的名称 | -| iOSBadgeCount | BOOL | 展示角标 | -| operatorUserID | NSString | | -| ex | NSString | 扩展内容 | - - - - - -### OfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ------------------ | -| title | String | 推送标题 | -| desc | String | 推送描述 | -| iOSPushSound | String | 推送声音文件的名称 | -| iOSBadgeCount | boolean | 展示角标 | -| operatorUserID | String | | -| ex | String | 扩展内容 | - - - - - -### OfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ---------------------- | -| title | string | 推送标题 | -| desc | string | 推送描述 | -| iOSPushSound | string | ios 推送声音文件的名称 | -| iOSBadgeCount | boolean | ios 是否展示角标 | -| operatorUserID | string | | -| ex | string | 扩展内容 | - - - - - -### OfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ---------------------- | -| title | string | 推送标题 | -| desc | string | 推送描述 | -| iOSPushSound | string | ios 推送声音文件的名称 | -| iOSBadgeCount | boolean | ios 是否展示角标 | -| operatorUserID | string | | -| ex | string | 扩展内容 | - - - - - - -### OfflinePushInfo - -| 字段名称 | 字段类型 | 描述 | -| -------------- | -------- | ---------------------- | -| title | string | 推送标题 | -| desc | string | 推送描述 | -| iOSPushSound | string | ios 推送声音文件的名称 | -| iOSBadgeCount | boolean | ios 是否展示角标 | -| operatorUserID | string | | -| ex | string | 扩展内容 | - - - - ### OfflinePushInfo @@ -126,10 +21,7 @@ values={[ | -------------- | -------- | ------------------ | | Title | string | 推送标题 | | Desc | string | 推送描述 | -| IOSPushSound | string | 推送声音文件的名称 | -| IOSBadgeCount | bool | 展示角标 | -| OperatorUserID | string | | -| Ex | string | 扩展内容 | +| iOSPushSound | string | 指定ios推送声音文件的名称 | +| iOSBadgeCount | bool | 是否算入角标数量 | +| ex | string | 扩展内容 | - - diff --git a/docs/sdks/class/message/pictureElem.mdx b/docs/sdks/class/message/pictureElem.mdx index e6de6dc06e..581892ea1b 100644 --- a/docs/sdks/class/message/pictureElem.mdx +++ b/docs/sdks/class/message/pictureElem.mdx @@ -14,108 +14,14 @@ toc_max_heading_level: 2 ::: - - ### PictureElem | 字段名称 | 字段类型 | 描述 | | --------------- | ------------------------------------------------------ | ------------ | -| sourcePath | String | 本地资源地址 | -| sourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - - -### OIMPictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | --------------------------------------------------------- | ------------ | -| sourcePath | NSString | 本地资源地址 | -| sourcePicture | [OIMPictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [OIMPictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [OIMPictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - - -### PictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | ------------------------------------------------------ | ------------ | -| sourcePath | String | 本地资源地址 | -| sourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - - -### PictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | ------------------------------------------------------ | ------------ | -| sourcePath | string | 本地资源地址 | -| sourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - - -### PictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | ------------------------------------------------------ | ------------ | -| sourcePath | string | 本地资源地址 | -| sourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - -### PictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | ------------------------------------------------------ | ------------ | -| sourcePath | string | 本地资源地址 | -| sourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | -| bigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | -| snapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - -### PictureElem - -| 字段名称 | 字段类型 | 描述 | -| --------------- | ------------------------------------------------------ | ------------ | -| SourcePath | string | 本地资源地址 | +| SourcePath | String | 本地资源路径 | | SourcePicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 原图片详情 | | BigPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 大图片详情 | | SnapshotPicture | [PictureInfo](docs/sdks/class/message/pictureInfo.mdx) | 缩略图片详情 | - - - - - diff --git a/docs/sdks/class/message/pictureInfo.mdx b/docs/sdks/class/message/pictureInfo.mdx index c365c2290b..c0828ba0e0 100644 --- a/docs/sdks/class/message/pictureInfo.mdx +++ b/docs/sdks/class/message/pictureInfo.mdx @@ -14,123 +14,16 @@ toc_max_heading_level: 2 ::: - - ### PictureInfo | 字段名称 | 字段类型 | 描述 | | -------- | -------- | -------- | -| uuID | String | 唯一 ID | -| type | String | 类型 | -| size | int | 大小 | -| width | int | 宽度 | -| height | int | 高度 | -| url | String | 图片地址 | - - - - - -### OIMPictureInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | --------- | -------- | -| uuID | NSString | 唯一 ID | -| type | NSString | 类型 | -| size | NSInteger | 大小 | -| width | CGFloat | 宽度 | -| height | CGFloat | 高度 | -| url | CGFloat | 图片地址 | - - - - - -### PictureInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| uuID | String | 唯一 ID | -| type | String | 类型 | -| size | int | 大小 | -| width | int | 宽度 | -| height | int | 高度 | -| url | String | 图片地址 | - - - - - -### PictureInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| uuID | string | 唯一 ID | -| type | string | 类型 | -| size | number | 大小 | -| width | number | 宽度 | -| height | number | 高度 | -| url | string | 图片地址 | - - - - - -### PictureInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| uuID | string | 唯一 ID | -| type | string | 类型 | -| size | number | 大小 | -| width | number | 宽度 | -| height | number | 高度 | -| url | string | 图片地址 | - - - - - - - -### PictureInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| uuID | string | 唯一 ID | -| type | string | 类型 | -| size | number | 大小 | -| width | number | 宽度 | -| height | number | 高度 | -| url | string | 图片地址 | - - - - - -### PictureBaseInfo - -| 字段名称 | 字段类型 | 描述 | -| -------- | -------- | -------- | -| UUID | String | 唯一 ID | -| Type | String | 类型 | +| UUID | string | 唯一 ID | +| Type | string | 图片类型 | | Size | int | 大小 | | Width | int | 宽度 | | Height | int | 高度 | -| Url | String | 图片地址 | +| Url | string | 图片地址 | - - diff --git a/docs/sdks/class/message/quoteElem.mdx b/docs/sdks/class/message/quoteElem.mdx index 95bacbe087..f3d40ec571 100644 --- a/docs/sdks/class/message/quoteElem.mdx +++ b/docs/sdks/class/message/quoteElem.mdx @@ -14,90 +14,7 @@ toc_max_heading_level: 2 ::: - - - -### QuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------- | -------------- | -| text | String | 回复的消息内容 | -| quoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | - - - - - -### OIMQuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | --------------------------------------------------------------------------- | -------------- | -| text | NSString | 回复的消息内容 | -| quoteMessage | [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | -| messageEntityList | - | |暂未使用 - - - - - -### QuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ------------ | -------------------------------------------------- | -------------- | -| text | String | 回复的消息内容 | -| quoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | - - - - - -### QuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------------------------------------------------------ | -------------- | -| text | string | 回复的消息内容 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | -| messageEntityList | - | 暂未使用 | - - - - - -### QuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------------------------------------------------------ | -------------- | -| text | string | 回复的消息内容 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | -| messageEntityList | - | 暂未使用 | - - - - - -### QuoteElem - -| 字段名称 | 字段类型 | 描述 | -| ----------------- | ------------------------------------------------------------ | -------------- | -| text | string | 回复的消息内容 | -| quoteMessage | [MessageItem](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | -| messageEntityList | - | 暂未使用 | - - - - ### QuoteElem @@ -106,5 +23,3 @@ values={[ | Text | string | 回复的消息内容 | | QuoteMessage | [Message](docs/sdks/class/message/messageInfo.mdx) | 被引用的消息 | - - diff --git a/docs/sdks/class/message/receiptInfo.mdx b/docs/sdks/class/message/receiptInfo.mdx index b258f643ec..46d5c24bb0 100644 --- a/docs/sdks/class/message/receiptInfo.mdx +++ b/docs/sdks/class/message/receiptInfo.mdx @@ -14,128 +14,13 @@ toc_max_heading_level: 2 ::: - - - ### ReadReceiptInfo | 字段名称 | 字段类型 | 描述 | | ----------- | ------------- | ----------- | -| userID | String | 单聊有效 | -| groupID | String | 群聊有效 | -| msgIDList | List | 已读消息 ID | -| readTime | int | 阅读时间 | -| msgFrom | int | 消息来源 | -| contentType | [int](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| sessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### OIMReceiptInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | -------------------------------------------------------------- | ----------- | -| userID | NSString | 单聊有效 | -| groupID | NSString | 群聊有效 | -| msgIDList | NSArray | 已读消息 ID | -| readTime | NSInteger | 阅读时间 | -| msgFrom | NSInteger | 消息来源 | -| contentType | [OIMMessageContentType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| sessionType | [OIMConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### ReadReceiptInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ------------- | ----------- | -| userID | String | 单聊有效 | -| groupID | String | 群聊有效 | -| msgIDList | List | 已读消息 ID | -| readTime | int | 阅读时间 | -| msgFrom | int | 消息来源 | -| contentType | int | 消息类型 | -| sessionType | int | 会话类型 | - - - - - -### ReceiptInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ---------------------------------------------------- | --------------------- | -| userID | string | 已读用户 ID，单聊有效 | -| groupID | string | 已读群ID，群聊有效 | -| msgIDList | string[] | 已读消息 ID 列表 | -| readTime | number | 阅读时间 | -| msgFrom | number | 消息来源 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### ReceiptInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ---------------------------------------------------- | --------------------- | -| userID | string | 已读用户 ID，单聊有效 | -| groupID | string | 已读群ID，群聊有效 | -| msgIDList | string[] | 已读消息 ID 列表 | -| readTime | number | 阅读时间 | -| msgFrom | number | 消息来源 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### ReceiptInfo - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ---------------------------------------------------- | --------------------- | -| userID | string | 已读用户 ID，单聊有效 | -| groupID | string | 已读群ID，群聊有效 | -| msgIDList | string[] | 已读消息 ID 列表 | -| readTime | number | 阅读时间 | -| msgFrom | number | 消息来源 | -| contentType | [MessageType](docs/sdks/enum/messageContentType.mdx) | 消息类型 | -| sessionType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### MessageReceipt - -| 字段名称 | 字段类型 | 描述 | -| ----------- | ------------- | ----------- | -| UserID | string | 单聊有效 | -| GroupID | string | 群聊有效 | -| MsgIDList | string[] | 已读消息 ID | -| ReadTime | int | 阅读时间 | -| MsgFrom | int | 消息来源 | -| ContentType | [int](docs/sdks/enum/messageContentType.mdx) | 消息类型 | +| userID | string | 已读用户id | +| MsgIDList | `[]`string | 已读消息 ID列表 | +| ReadTime | int | 阅读时间（毫秒） | | SessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - diff --git a/docs/sdks/class/message/revokedInfo.mdx b/docs/sdks/class/message/revokedInfo.mdx index 0cb85b27ac..ebe3042fdf 100644 --- a/docs/sdks/class/message/revokedInfo.mdx +++ b/docs/sdks/class/message/revokedInfo.mdx @@ -14,142 +14,21 @@ toc_max_heading_level: 2 ::: - - - - -### RevokedInfo - -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | -------- | -------------- | -| revokerID | String | 撤回者 ID | -| revokerNickname | String | 撤回者昵称 | -| revokerRole | [int](docs/sdks/enum/roleLevel.mdx) | 撤回者群角色 | -| clientMsgID | String | 消息 ID | -| revokeTime | int | 撤回时间 | -| sourceMessageSendTime | int | 消息发送时间 | -| sourceMessageSendID | String | 消息发送者 | -| sourceMessageSenderNickname | String | 消息发送者昵称 | -| sessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### OIMMessageRevokedInfo - -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | ---------------------------------------------------------- | -------------- | -| revokerID | NSString | 撤回者 ID | -| revokerNickname | NSString | 撤回者昵称 | -| revokerRole | [OIMGroupMemberRole](docs/sdks/enum/roleLevel.mdx) | 撤回者群角色 | -| clientMsgID | NSTimeInterval | 消息 ID | -| revokeTime | NSInteger | 撤回时间 | -| sourceMessageSendTime | NSTimeInterval | 消息发送时间 | -| sourceMessageSendID | NSString | 消息发送者 | -| sourceMessageSenderNickname | NSString | 消息发送者昵称 | -| sessionType | [OIMConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | - - - - - -### RevokedInfo - -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | -------- | -------------- | -| revokerID | String | 撤回者 ID | -| revokerNickname | String | 撤回者昵称 | -| revokerRole | int | [RevokerRole](docs/sdks/enum/roleLevel.mdx) 撤回者群角色 | -| clientMsgID | String | 消息 ID | -| revokeTime | int | 撤回时间 | -| sourceMessageSendTime | int | 消息发送时间 | -| sourceMessageSendID | String | 消息发送者 | -| sourceMessageSenderNickname | String | 消息发送者昵称 | -| sessionType | int | [ConversationType](docs/sdks/enum/conversationType.mdx) 会话类型 | - - - - - -### RevokedInfo - -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | -------- | -------------- | -| revokerID | string | 撤回者 ID | -| revokerNickname | string | 撤回者昵称 | -| revokerRole | number | 撤回者群角色 | -| clientMsgID | string | 消息 ID | -| revokeTime | number | 撤回时间 | -| sourceMessageSendTime | number | 消息发送时间 | -| sourceMessageSendID | string | 消息发送者 | -| sourceMessageSenderNickname | string | 消息发送者昵称 | -| sessionType | number | 会话类型 | - - - - - -### RevokedInfo - -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | -------- | -------------- | -| revokerID | string | 撤回者 ID | -| revokerNickname | string | 撤回者昵称 | -| revokerRole | number | 撤回者群角色 | -| clientMsgID | string | 消息 ID | -| revokeTime | number | 撤回时间 | -| sourceMessageSendTime | number | 消息发送时间 | -| sourceMessageSendID | string | 消息发送者 | -| sourceMessageSenderNickname | string | 消息发送者昵称 | -| sessionType | number | 会话类型 | - - - - ### RevokedInfo -| 字段名称 | 字段类型 | 描述 | -| --------------------------- | -------- | -------------- | -| revokerID | string | 撤回者 ID | -| revokerNickname | string | 撤回者昵称 | -| revokerRole | number | 撤回者群角色 | -| clientMsgID | string | 消息 ID | -| revokeTime | number | 撤回时间 | -| sourceMessageSendTime | number | 消息发送时间 | -| sourceMessageSendID | string | 消息发送者 | -| sourceMessageSenderNickname | string | 消息发送者昵称 | -| sessionType | number | 会话类型 | - - - - - -### MessageRevoked - | 字段名称 | 字段类型 | 描述 | | --------------------------- | -------- | -------------- | | RevokerID | string | 撤回者 ID | -| RevokerNickname | string | 撤回者昵称 | -| RevokerRole | [int](docs/sdks/enum/roleLevel.mdx) | 撤回者群角色 | -| ClientMsgID | string | 消息 ID | -| RevokeTime | int | 撤回时间 | -| SourceMessageSendTime | int | 消息发送时间 | -| SourceMessageSendID | string | 消息发送者 | -| SourceMessageSenderNickname | string | 消息发送者昵称 | -| SessionType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | +| RevokerNickname | String | 撤回者昵称 | +| RevokerRole | [RoleLevel](docs/sdks/enum/roleLevel.mdx) | 撤回者群角色，会话类型为群聊时有效 | +| ClientMsgID | string | 被撤回消息 ID | +| RevokeTime | int | 撤回时间（秒） | +| SourceMessageSendTime | int | 被撤回消息的发送时间（毫秒） | +| SourceMessageSendID | string | 被撤回消息发送者 | +| SourceMessageSenderNickname | string | 被撤回消息发送者昵称 | +| Ex | string | 被撤回消息的远程扩展信息 | +| SessionType | [ConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | +| IsAdminRevoke | bool | 是否由app管理员撤回 | + - - diff --git a/docs/sdks/class/message/searchResultItem.mdx b/docs/sdks/class/message/searchResultItem.mdx index 384b492087..a868456532 100644 --- a/docs/sdks/class/message/searchResultItem.mdx +++ b/docs/sdks/class/message/searchResultItem.mdx @@ -14,120 +14,15 @@ toc_max_heading_level: 2 ::: - - - - -### SearchResultItems - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | -------------------------------------------------------- | ---------------------------------------------------------------- | -| conversationID | String | 会话 ID | -| messageCount | int | 会话下的消息数量 | -| conversationType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| showName | String | 会话名称 | -| faceURL | String | 会话头像 | -| messageList | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | 会话下的消息列表 | - - - - - -### OIMSearchResultItemInfo - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | ------------------------------------------------------------------------ | -------------------- | -| conversationID | NSString | 会话 ID | -| messageCount | NSInteger | 这个会话下的消息数量 | -| conversationType | [OIMConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| showName | NSString | 会话名称 | -| faceURL | NSString | 会话头像 | -| messageList | NSArray < [OIMMessageInfo](docs/sdks/class/message/messageInfo.mdx) \* > | 会话下的消息列表 | - - - - - ### SearchResultItems -| 字段名称 | 字段类型 | 描述 | -| ---------------- | -------------------------------------------------------- | ---------------------------------------------------------------- | -| conversationID | String | 会话 ID | -| messageCount | int | 这个会话下的消息数量 | -| showName | String | 显示名 | -| faceURL | String | 头像 | -| messageList | List<[Message](docs/sdks/class/message/messageInfo.mdx)> | - - - - - -### SearchMessageResultItem - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | -------------------------------------------------------- | ---------------- | -| conversationID | string | 会话 ID | -| messageCount | number | 会话下的消息数量 | -| conversationType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| showName | string | 会话名称 | -| faceURL | string | 会话头像 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 会话下的消息列表 | - - - - - -### SearchMessageResultItem - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | -------------------------------------------------------- | ---------------- | -| conversationID | string | 会话 ID | -| messageCount | number | 会话下的消息数量 | -| conversationType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| showName | string | 会话名称 | -| faceURL | string | 会话头像 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 会话下的消息列表 | - - - - - -### SearchMessageResultItem - -| 字段名称 | 字段类型 | 描述 | -| ---------------- | -------------------------------------------------------- | ---------------- | -| conversationID | string | 会话 ID | -| messageCount | number | 会话下的消息数量 | -| conversationType | [SessionType](docs/sdks/enum/conversationType.mdx) | 会话类型 | -| showName | string | 会话名称 | -| faceURL | string | 会话头像 | -| messageList | [MessageItem](docs/sdks/class/message/messageInfo.mdx)[] | 会话下的消息列表 | - - - - - -### SearchResultItem - | 字段名称 | 字段类型 | 描述 | | ---------------- | -------------------------------------------------------- | ---------------------------------------------------------------- | | ConversationID | string | 会话 ID | -| MessageCount | int | 会话下的消息数量 | -| ConversationType | [int](docs/sdks/enum/conversationType.mdx) | 会话类型 | +| MessageCount | int | 该会话下的消息数量 | +| ConversationType | [ConversationType](docs/sdks/enum/conversationType.mdx) | 会话类型 | | ShowName | string | 会话名称 | | FaceURL | string | 会话头像 | -| MessageList | [Message](docs/sdks/class/message/messageInfo.mdx)[] | 会话下的消息列表 | +| LatestMsgSendTime| int | 会话最新一条消息的发送时间 | +| messageList | `[]`[Message](docs/sdks/class/message/messageInfo.mdx) | 会话下的消息列表 | - - diff --git a/docs/sdks/class/message/soundElem.mdx b/docs/sdks/class/message/soundElem.mdx index c250427932..950275eef6 100644 --- a/docs/sdks/class/message/soundElem.mdx +++ b/docs/sdks/class/message/soundElem.mdx @@ -14,115 +14,14 @@ toc_max_heading_level: 2 ::: - - - - -### SoundElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | String | 唯一 ID | -| soundPath | String | 本地资源地址 | -| dataSize | int | 大小 | -| duration | int | 时长 | -| sourceUrl | String | 语音远程地址 | - - - - - -### OIMSoundElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | --------- | ------------ | -| uuID | NSString | 唯一 ID | -| soundPath | NSString | 本地资源地址 | -| dataSize | NSInteger | 大小 | -| duration | NSInteger | 时长 | -| sourceUrl | CGFloat | 语音远程地址 | - - - - - -### SoundElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | String | 唯一 ID | -| soundPath | String | 本地资源地址 | -| dataSize | int | 大小 | -| duration | int | 时长 | -| sourceUrl | String | 语音远程地址 | - - - - - ### SoundElem -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| soundPath | string | 本地资源地址 | -| dataSize | number | 大小 | -| duration | number | 时长 | -| sourceUrl | string | 语音远程地址 | - - - - - -### SoundElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| soundPath | string | 本地资源地址 | -| dataSize | number | 大小 | -| duration | number | 时长 | -| sourceUrl | string | 语音远程地址 | - - - - - -### SoundElem - -| 字段名称 | 字段类型 | 描述 | -| --------- | -------- | ------------ | -| uuID | string | 唯一 ID | -| soundPath | string | 本地资源地址 | -| dataSize | number | 大小 | -| duration | number | 时长 | -| sourceUrl | string | 语音远程地址 | - - - - - -### SoundBaseInfo - | 字段名称 | 字段类型 | 描述 | | --------- | -------- | ------------ | | UUID | string | 唯一 ID | | SoundPath | string | 本地资源地址 | | DataSize | int | 大小 | | Duration | int | 时长 | -| SourceUrl | string | 语音远程地址 | -| SourceType | string | 语音类型| +| SourceURL | string | 语音远程地址 | +| SoundType | string | 音频类型 | - - diff --git a/docs/sdks/class/message/videoElem.mdx b/docs/sdks/class/message/videoElem.mdx index c748b41f16..51ec763e28 100644 --- a/docs/sdks/class/message/videoElem.mdx +++ b/docs/sdks/class/message/videoElem.mdx @@ -24,7 +24,7 @@ toc_max_heading_level: 2 | VideoType | string | 视频类型 | | VideoSize | int | 大小 | | Duration | int | 时长 | -| VideoUrl | string | 视频远程地址 | +| VideoURL | string | 视频远程地址 | | SnapshotUUID | string | 缩略图唯一 ID | | SnapshotPath | string | 缩略图本地路径 | | SnapshotSize | int | 大小 | diff --git a/docs/sdks/enum/logLevel.mdx b/docs/sdks/enum/logLevel.mdx index b8e7513483..f36073d96e 100644 --- a/docs/sdks/enum/logLevel.mdx +++ b/docs/sdks/enum/logLevel.mdx @@ -2,7 +2,7 @@ :::info -设置 SDK 日志打印级别。 +设置 SDK 日志打印级别,设置n即打印n-0对应级别的日志。 ::: diff --git a/docs/sdks/enum/messageFrom.mdx b/docs/sdks/enum/messageFrom.mdx new file mode 100644 index 0000000000..33a28c7d52 --- /dev/null +++ b/docs/sdks/enum/messageFrom.mdx @@ -0,0 +1,20 @@ +--- +sidebar_position: 2 +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +# MessageFrom + +:::info + +消息发送来源。 + +::: + +## 消息状态 + +| 枚举值名称 | 枚举值 | 描述 | +| ---------- | ------------- | --------------------- | +|UserMsgType| 100 | 消息由用户发送 | +|SysMsgType| 200 | 消息由系统发送 | \ No newline at end of file