@rongcloud/imlib-next 5.8.6-alpha.2 → 5.9.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +339 -25
- package/index.esm.js +1 -1
- package/index.js +1 -1
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -1,7 +1,54 @@
|
|
|
1
|
-
import { LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, SentStatus, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedInfoBody, IMessageReaderResponse, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag,
|
|
2
|
-
export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IInsertMessage, IMessageDeliver, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OperateStatus, RCConnectionStatus, ReceivedStatus, SentStatus, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { FileType, APIContext, LogLevel, EnableLogL, IRuntime, AreaCode, ConversationType, MessageDirection, ReceivedStatus, SentStatus, IReadReceiptInfo, IPushConfig, UltraGroupChannelType, RCConnectionStatus, IPluginGenerator, IAsyncRes, NotificationStatus, NotificationLevel, IUltraUnreadMsg, IUserProfile, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IMessageDeliver, IGroupMessageDeliverStatus, IReadReceiptData, ISyncReadStatusData, IBaseConversationInfo, IConversationState as IConversationState$1, IGetUltraGroupListOption, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraGroupUnreadInfo, IChatroomJoinResponse, IChatroomInfo, IChatRoomEntry, IChatroomEntries, IRemoveChatRoomEntry, IRemoveChatRoomEntries, IRTCRoomBindOption, MentionedInfoBody, ICombineV2MessageContent, IMessageReadReceiptV4Response, IGroupReadReceiptData, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, IReceivedMessage, IReceivedConversation, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IInsertMessage, IGroupMessageDeliverInfo, IProxy, IPromiseResult, IResponse } from '@rongcloud/engine';
|
|
2
|
+
export { AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationType, EnableLogL, ErrorCode, FileType, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombinedMessage, IConversationIdentifier, IConversationOption, IConversationTag, IDeletedExpansion, IDeliveredUser, IDownloadAuth, IEventListener, IExpansionListenerData, IFirstUnreadMessageInfo, IGetUltraGroupListOption, IGooglePushConfig, IGroupMessageDeliverInfo, IGroupMessageDeliverStatus, IGroupMessageDeliveredStatusInfo, IGroupReadReceiptData, IInsertMessage, IMessageDeliver, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPrivateReadReceiptData, IPromiseResult, IProxy, IPushConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, ISyncReadStatusData, ITagInfo, ITagParam, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IiOSPushConfig, LogL, LogLevel, MentionedInfoBody, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, NotificationLevel, NotificationStatus, OperateStatus, PushImportanceHonor, RCConnectionStatus, ReceivedStatus, SentStatus, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod } from '@rongcloud/engine';
|
|
3
|
+
|
|
4
|
+
interface IThumbnailConfig$1 {
|
|
5
|
+
maxHeight?: number;
|
|
6
|
+
maxWidth?: number;
|
|
7
|
+
quality?: number;
|
|
8
|
+
scale?: number;
|
|
9
|
+
}
|
|
10
|
+
interface IUploadConfig {
|
|
11
|
+
getFileToken: TGetFileToken;
|
|
12
|
+
getFileUrl: TGetFileUrl;
|
|
13
|
+
customDomain: string;
|
|
14
|
+
serverType?: number;
|
|
15
|
+
ossConfig?: string;
|
|
16
|
+
uploadServer?: string;
|
|
17
|
+
bosAddr?: string;
|
|
18
|
+
}
|
|
19
|
+
interface IUploadInfo {
|
|
20
|
+
file: File;
|
|
21
|
+
onProgress?: (loaded: number, total: number) => void;
|
|
22
|
+
fileType: FileType;
|
|
23
|
+
contentDisposition?: 'inline' | 'attachment';
|
|
24
|
+
thumbnailConfig?: IThumbnailConfig$1;
|
|
25
|
+
}
|
|
26
|
+
interface IUploadResult {
|
|
27
|
+
name: string;
|
|
28
|
+
downloadUrl: string;
|
|
29
|
+
uniqueName: string;
|
|
30
|
+
size: number;
|
|
31
|
+
type: string;
|
|
32
|
+
/**
|
|
33
|
+
* 音频时长，单位秒
|
|
34
|
+
*/
|
|
35
|
+
duration?: number;
|
|
36
|
+
length?: number;
|
|
37
|
+
/**
|
|
38
|
+
* 图片缩略图
|
|
39
|
+
*/
|
|
40
|
+
thumbnail?: string;
|
|
41
|
+
/**
|
|
42
|
+
* 图片宽度
|
|
43
|
+
*/
|
|
44
|
+
width?: number;
|
|
45
|
+
/**
|
|
46
|
+
* 图片高度
|
|
47
|
+
*/
|
|
48
|
+
height?: number;
|
|
49
|
+
}
|
|
50
|
+
declare type TGetFileToken = typeof APIContext.prototype.getFileToken;
|
|
51
|
+
declare type TGetFileUrl = typeof APIContext.prototype.getFileUrl;
|
|
5
52
|
|
|
6
53
|
declare type IInitOption = {
|
|
7
54
|
/**
|
|
@@ -84,10 +131,6 @@ declare type IInitOption = {
|
|
|
84
131
|
* @since 5.7.7
|
|
85
132
|
*/
|
|
86
133
|
logServerUrl?: string;
|
|
87
|
-
/**
|
|
88
|
-
* 私有云环境配置
|
|
89
|
-
*/
|
|
90
|
-
environment?: string;
|
|
91
134
|
};
|
|
92
135
|
/**
|
|
93
136
|
* 用户收到的消息结构
|
|
@@ -337,6 +380,16 @@ declare enum Events {
|
|
|
337
380
|
* 收到已读回执响应（群聊）
|
|
338
381
|
*/
|
|
339
382
|
MESSAGE_RECEIPT_RESPONSE = "MESSAGE_RECEIPT_RESPONSE",
|
|
383
|
+
/**
|
|
384
|
+
* 收到已读回执（V4 版本）
|
|
385
|
+
* @since 5.9.0
|
|
386
|
+
*/
|
|
387
|
+
MESSAGE_READ_RECEIPT_V4 = "MESSAGE_READ_RECEIPT_V4",
|
|
388
|
+
/**
|
|
389
|
+
* 收到会话已读时间同步（需开通服务 sesDriven），收到此通知时 SDK 内会处理清除会话未读数
|
|
390
|
+
* @since 5.9.0
|
|
391
|
+
*/
|
|
392
|
+
SYNC_READ_STATUS = "SYNC_READ_STATUS",
|
|
340
393
|
/**
|
|
341
394
|
* 收到会话变更通知
|
|
342
395
|
*/
|
|
@@ -553,6 +606,10 @@ interface IAReceivedConversation {
|
|
|
553
606
|
* @since 5.8.4
|
|
554
607
|
*/
|
|
555
608
|
operationTime?: number;
|
|
609
|
+
/**
|
|
610
|
+
* 会话草稿
|
|
611
|
+
*/
|
|
612
|
+
draft?: string;
|
|
556
613
|
}
|
|
557
614
|
/**
|
|
558
615
|
* @category Interface
|
|
@@ -901,6 +958,11 @@ declare type EventListeners = {
|
|
|
901
958
|
* @hidden
|
|
902
959
|
*/
|
|
903
960
|
[Events.GROUP_MESSAGE_DELIVERED]: (list: IGroupMessageDeliverStatus[]) => void;
|
|
961
|
+
[Events.MESSAGE_READ_RECEIPT_V4]: (data: IReadReceiptData) => void;
|
|
962
|
+
/**
|
|
963
|
+
* @hidden
|
|
964
|
+
*/
|
|
965
|
+
[Events.SYNC_READ_STATUS]: (list: ISyncReadStatusData) => void;
|
|
904
966
|
};
|
|
905
967
|
|
|
906
968
|
/**
|
|
@@ -968,6 +1030,32 @@ declare function getConversation(options: IConversationOption): Promise<IAsyncRe
|
|
|
968
1030
|
* @category 会话
|
|
969
1031
|
*/
|
|
970
1032
|
declare function removeConversation(options: IConversationOption): Promise<IAsyncRes<void>>;
|
|
1033
|
+
/**
|
|
1034
|
+
* 批量删除会话
|
|
1035
|
+
* @param conversations 会话列表，最大数量为 20
|
|
1036
|
+
* @category 会话
|
|
1037
|
+
* @since 5.9.0
|
|
1038
|
+
* @description 此方法不删除会话内的消息。如果此会话中有新的消息，该会话将重新在会话列表中显示，并显示最近的历史消息。
|
|
1039
|
+
*
|
|
1040
|
+
* 支持的会话类型：单聊, 群聊, 系统消息
|
|
1041
|
+
* @example
|
|
1042
|
+
* ```js
|
|
1043
|
+
* batchRemoveConversation([
|
|
1044
|
+
* {
|
|
1045
|
+
* conversationType: ConversationType.PRIVATE,
|
|
1046
|
+
* targetId: 'targetId',
|
|
1047
|
+
* channelId: 'channelId',
|
|
1048
|
+
* }],
|
|
1049
|
+
* ).then(res => {
|
|
1050
|
+
* if (res.code === ErrorCode.SUCCESS) {
|
|
1051
|
+
* console.log('删除成功')
|
|
1052
|
+
* } else {
|
|
1053
|
+
* console.log('删除失败', res.code)
|
|
1054
|
+
* }
|
|
1055
|
+
* })
|
|
1056
|
+
* ```
|
|
1057
|
+
*/
|
|
1058
|
+
declare function batchRemoveConversation(conversations: IConversationOption[]): Promise<IAsyncRes<void>>;
|
|
971
1059
|
/**
|
|
972
1060
|
* 获取会话文本草稿
|
|
973
1061
|
* @category 草稿
|
|
@@ -1048,6 +1136,32 @@ declare function clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>;
|
|
|
1048
1136
|
* @category 会话
|
|
1049
1137
|
*/
|
|
1050
1138
|
declare function setConversationNotificationLevel(options: IConversationOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
|
|
1139
|
+
/**
|
|
1140
|
+
* 批量设置会话免打扰级别
|
|
1141
|
+
* @param conversations 会话列表, 最大数量为 20
|
|
1142
|
+
* @param notificationLevel 免打扰级别
|
|
1143
|
+
* @category 会话
|
|
1144
|
+
* @since 5.9.0
|
|
1145
|
+
* @description 支持 单聊、群聊、系统会话
|
|
1146
|
+
* @example
|
|
1147
|
+
* ```js
|
|
1148
|
+
* batchSetConversationNotificationLevel([
|
|
1149
|
+
* {
|
|
1150
|
+
* conversationType: ConversationType.PRIVATE,
|
|
1151
|
+
* targetId: 'targetId',
|
|
1152
|
+
* channelId: 'channelId',
|
|
1153
|
+
* }],
|
|
1154
|
+
* 2
|
|
1155
|
+
* ).then(res => {
|
|
1156
|
+
* if (res.code === ErrorCode.SUCCESS) {
|
|
1157
|
+
* console.log('设置成功')
|
|
1158
|
+
* } else {
|
|
1159
|
+
* console.log('设置失败', res.code)
|
|
1160
|
+
* }
|
|
1161
|
+
* })
|
|
1162
|
+
* ```
|
|
1163
|
+
*/
|
|
1164
|
+
declare function batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>;
|
|
1051
1165
|
/**
|
|
1052
1166
|
* 设置会话免打扰
|
|
1053
1167
|
* @deprecated 已废弃，请使用 setConversationNotificationLevel
|
|
@@ -1082,6 +1196,34 @@ declare function getBlockedConversationList(): Promise<IAsyncRes<IBaseConversati
|
|
|
1082
1196
|
* @category 会话
|
|
1083
1197
|
*/
|
|
1084
1198
|
declare function setConversationToTop(options: IConversationOption, isTop?: boolean): Promise<IAsyncRes<void>>;
|
|
1199
|
+
/**
|
|
1200
|
+
* 批量设置会话置顶
|
|
1201
|
+
* @param conversations 会话数组, 最大数量为 20
|
|
1202
|
+
* @param isTop 是否置顶
|
|
1203
|
+
* @param isCreateConversation 是否创建会话，仅 Electron 平台支持
|
|
1204
|
+
* @category 会话
|
|
1205
|
+
* @since 5.9.0
|
|
1206
|
+
* @description 支持 单聊、群聊、系统会话
|
|
1207
|
+
* @example
|
|
1208
|
+
* ```js
|
|
1209
|
+
* batchSetConversationToTop([
|
|
1210
|
+
* {
|
|
1211
|
+
* conversationType: ConversationType.PRIVATE,
|
|
1212
|
+
* targetId: 'targetId',
|
|
1213
|
+
* channelId: 'channelId',
|
|
1214
|
+
* }],
|
|
1215
|
+
* true,
|
|
1216
|
+
* false,
|
|
1217
|
+
* ).then(res => {
|
|
1218
|
+
* if (res.code === ErrorCode.SUCCESS) {
|
|
1219
|
+
* console.log('设置成功')
|
|
1220
|
+
* } else {
|
|
1221
|
+
* console.log('设置失败', res.code)
|
|
1222
|
+
* }
|
|
1223
|
+
* })
|
|
1224
|
+
* ```
|
|
1225
|
+
*/
|
|
1226
|
+
declare function batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<IAsyncRes<void>>;
|
|
1085
1227
|
/**
|
|
1086
1228
|
* 获取置顶会话
|
|
1087
1229
|
* @category 会话
|
|
@@ -1382,7 +1524,7 @@ interface IImageMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
|
|
|
1382
1524
|
*/
|
|
1383
1525
|
imageUri: string;
|
|
1384
1526
|
}
|
|
1385
|
-
declare const _default$
|
|
1527
|
+
declare const _default$e: MessageConstructor<IImageMessageBody>;
|
|
1386
1528
|
|
|
1387
1529
|
/**
|
|
1388
1530
|
* 图片消息
|
|
@@ -1402,7 +1544,7 @@ interface IHQVoiceMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
|
|
|
1402
1544
|
*/
|
|
1403
1545
|
duration: number;
|
|
1404
1546
|
}
|
|
1405
|
-
declare const _default$
|
|
1547
|
+
declare const _default$d: MessageConstructor<IHQVoiceMessageBody>;
|
|
1406
1548
|
|
|
1407
1549
|
/**
|
|
1408
1550
|
* 短视频消息
|
|
@@ -1431,7 +1573,7 @@ interface ISightMessageBody extends IExtraData, IMentionedInfo, IUserInfo {
|
|
|
1431
1573
|
*/
|
|
1432
1574
|
name: string;
|
|
1433
1575
|
}
|
|
1434
|
-
declare const _default$
|
|
1576
|
+
declare const _default$c: MessageConstructor<ISightMessageBody>;
|
|
1435
1577
|
|
|
1436
1578
|
/**
|
|
1437
1579
|
* 文本消息
|
|
@@ -1443,7 +1585,7 @@ interface ITextMessageBody extends IUserInfo, IExtraData, IMentionedInfo {
|
|
|
1443
1585
|
*/
|
|
1444
1586
|
content: string;
|
|
1445
1587
|
}
|
|
1446
|
-
declare const _default$
|
|
1588
|
+
declare const _default$b: MessageConstructor<ITextMessageBody>;
|
|
1447
1589
|
|
|
1448
1590
|
/**
|
|
1449
1591
|
* 富文本消息
|
|
@@ -1467,7 +1609,10 @@ interface ICombineMessageBody extends IExtraData, IUserInfo, IMentionedInfo {
|
|
|
1467
1609
|
*/
|
|
1468
1610
|
conversationType: ConversationType;
|
|
1469
1611
|
}
|
|
1470
|
-
declare const _default$
|
|
1612
|
+
declare const _default$a: MessageConstructor<ICombineMessageBody>;
|
|
1613
|
+
|
|
1614
|
+
declare type CombineV2MessageContent = ICombineV2MessageContent & IExtraData & IUserInfo & IMentionedInfo;
|
|
1615
|
+
declare const _default$9: MessageConstructor<CombineV2MessageContent>;
|
|
1471
1616
|
|
|
1472
1617
|
/**
|
|
1473
1618
|
* 文件消息
|
|
@@ -1730,17 +1875,96 @@ declare function sendReadReceiptResponseV2(targetId: string, messageList: {
|
|
|
1730
1875
|
}, channelId?: string): Promise<IAsyncRes<void>>;
|
|
1731
1876
|
/**
|
|
1732
1877
|
* 多端同步阅读状态
|
|
1733
|
-
* @
|
|
1734
|
-
* @param
|
|
1735
|
-
* @
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1878
|
+
* @param conversation 会话信息
|
|
1879
|
+
* @param timestamp 时间戳
|
|
1880
|
+
* @example
|
|
1881
|
+
* ```js
|
|
1882
|
+
* const con = {
|
|
1883
|
+
* conversationType: ConversationType.Group,
|
|
1884
|
+
* targetId: 'targetId'
|
|
1885
|
+
* }
|
|
1886
|
+
* sendSyncReadStatusMessage(con, Date.now()).then(res => {
|
|
1887
|
+
* if (res.code === ErrorCode.success) {
|
|
1888
|
+
* console.log('send success', res.data)
|
|
1889
|
+
* } else {
|
|
1890
|
+
* console.log('send error', res.msg)
|
|
1891
|
+
* }
|
|
1892
|
+
* })
|
|
1893
|
+
* ```
|
|
1894
|
+
*/
|
|
1895
|
+
declare function sendSyncReadStatusMessage(conversation: IConversationOption, lastMessageSendTime: number): Promise<IAsyncRes<unknown>>;
|
|
1896
|
+
/**
|
|
1897
|
+
* 发送已读回执（V4 版本）
|
|
1898
|
+
*
|
|
1899
|
+
* 调用此接口后，消息的发送者会收到 EVENTS.MESSAGE_READ_RECEIPT_V4 事件通知
|
|
1900
|
+
*
|
|
1901
|
+
* 调用此接口需在开发者后台开通服务
|
|
1902
|
+
* @since 5.9.0
|
|
1903
|
+
* @param conversation 会话信息，支持单聊、群聊
|
|
1904
|
+
* @param endMsgUId 结束消息 UId
|
|
1905
|
+
* @param startMsgUId 开始消息UId, 仅群聊时有效
|
|
1906
|
+
* @example
|
|
1907
|
+
* ```js
|
|
1908
|
+
* const con = {
|
|
1909
|
+
* conversationType: ConversationType.Group,
|
|
1910
|
+
* targetId: 'targetId'
|
|
1911
|
+
* }
|
|
1912
|
+
* sendReadReceiptMessageV4(con, 'endMsgUId', 'startMsgUId').then(res => {
|
|
1913
|
+
* if (res.code === ErrorCode.success) {
|
|
1914
|
+
* console.log('send success')
|
|
1915
|
+
* } else {
|
|
1916
|
+
* console.log('send error', res.msg)
|
|
1917
|
+
* }
|
|
1918
|
+
* })
|
|
1919
|
+
* ```
|
|
1920
|
+
*/
|
|
1921
|
+
declare function sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<IAsyncRes<unknown>>;
|
|
1922
|
+
/**
|
|
1923
|
+
* 获取消息的已读回执列表
|
|
1924
|
+
*
|
|
1925
|
+
* 调用此接口需在开发者后台开通服务
|
|
1926
|
+
* @since 5.9.0
|
|
1927
|
+
* @param conversation 会话信息, 仅支持群聊
|
|
1928
|
+
* @param messageUid 消息 UId
|
|
1929
|
+
* @example
|
|
1930
|
+
* ```js
|
|
1931
|
+
* const con = {
|
|
1932
|
+
* conversationType: ConversationType.Group,
|
|
1933
|
+
* targetId: 'targetId'
|
|
1934
|
+
* }
|
|
1935
|
+
* getMessageReadReceiptV4(con, 'MsgUId').then(res => {
|
|
1936
|
+
* if (res.code === ErrorCode.success) {
|
|
1937
|
+
* console.log('send success', res.data)
|
|
1938
|
+
* } else {
|
|
1939
|
+
* console.log('send error', res.msg)
|
|
1940
|
+
* }
|
|
1941
|
+
* })
|
|
1942
|
+
* ```
|
|
1943
|
+
*/
|
|
1944
|
+
declare function getMessageReadReceiptV4(conversation: IConversationOption, messageUid: string): Promise<IAsyncRes<IMessageReadReceiptV4Response>>;
|
|
1945
|
+
/**
|
|
1946
|
+
* 获取消息的已读回执列表
|
|
1947
|
+
*
|
|
1948
|
+
* 调用此接口需在开发者后台开通服务
|
|
1949
|
+
* @since 5.9.0
|
|
1950
|
+
* @param conversation 会话信息, 仅支持群聊
|
|
1951
|
+
* @param messageUIds 消息 UId 列表
|
|
1952
|
+
* @example
|
|
1953
|
+
* ```js
|
|
1954
|
+
* const con = {
|
|
1955
|
+
* conversationType: ConversationType.Group,
|
|
1956
|
+
* targetId: 'targetId'
|
|
1957
|
+
* }
|
|
1958
|
+
* batchGetMessageReadReceiptInfoV4(con, ['MsgUId']).then(res => {
|
|
1959
|
+
* if (res.code === ErrorCode.success) {
|
|
1960
|
+
* console.log('send success', res.data)
|
|
1961
|
+
* } else {
|
|
1962
|
+
* console.log('send error', res.msg)
|
|
1963
|
+
* }
|
|
1964
|
+
* })
|
|
1965
|
+
* ```
|
|
1966
|
+
*/
|
|
1967
|
+
declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): Promise<IAsyncRes<IGroupReadReceiptData[]>>;
|
|
1744
1968
|
/**
|
|
1745
1969
|
* 撤回消息
|
|
1746
1970
|
* @category 消息
|
|
@@ -1774,6 +1998,29 @@ declare function deleteMessages$1(conversation: IConversationOption, messages: {
|
|
|
1774
1998
|
* @param timestamp 清除时间点, 该时间之前的消息将被清除
|
|
1775
1999
|
*/
|
|
1776
2000
|
declare function clearHistoryMessages(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
|
|
2001
|
+
/**
|
|
2002
|
+
* 批量删除多个会话的远端消息
|
|
2003
|
+
* @param conversations 会话列表，最大数量为 20
|
|
2004
|
+
* @param isDeleteLocal 是否删除本地消息, 仅 Electron 平台支持，默认为 false
|
|
2005
|
+
* @category 消息
|
|
2006
|
+
* @since 5.9.0
|
|
2007
|
+
* @description 批量删除服务端多个会话早于（含）发送时间的所有远端消息（Electron 平台可以删除对应的本地消息）,
|
|
2008
|
+
* 时间戳，传 0 清除所有消息
|
|
2009
|
+
* 支持的会话类型：单聊, 群聊, 聊天室, 系统消息
|
|
2010
|
+
* @example
|
|
2011
|
+
* ```js
|
|
2012
|
+
* batchClearHistoryMessages([
|
|
2013
|
+
* {
|
|
2014
|
+
* conversationType: ConversationType.PRIVATE,
|
|
2015
|
+
* targetId: 'targetId',
|
|
2016
|
+
* timestamp: 0,
|
|
2017
|
+
* channelId: '',
|
|
2018
|
+
* }, true]).then(res => {
|
|
2019
|
+
* console.log(res);
|
|
2020
|
+
* });
|
|
2021
|
+
* ```
|
|
2022
|
+
*/
|
|
2023
|
+
declare function batchClearRemoteHistoryMessages(options: IClearMessageOption[], isDeleteLocal?: boolean): Promise<IAsyncRes<void>>;
|
|
1777
2024
|
/**
|
|
1778
2025
|
* 更新（添加、替换）消息扩展属性
|
|
1779
2026
|
* @category 消息
|
|
@@ -1820,6 +2067,15 @@ declare function registerMessageType<T>(messageType: string, isPersited: boolean
|
|
|
1820
2067
|
* @param conversation
|
|
1821
2068
|
*/
|
|
1822
2069
|
declare function getFirstUnreadMessage(conversation: IConversationOption): Promise<IAsyncRes<IAReceivedMessage | null>>;
|
|
2070
|
+
/**
|
|
2071
|
+
* 获取第一条未读消息信息
|
|
2072
|
+
* @category 消息
|
|
2073
|
+
* @since 5.9.0
|
|
2074
|
+
* @param conversation
|
|
2075
|
+
* 当没有未读消息时，返回的 data 为 null
|
|
2076
|
+
* 当第一条未读消息被撤回时，此信息不会更新
|
|
2077
|
+
*/
|
|
2078
|
+
declare function getFirstUnreadMessageInfo(conversation: IConversationOption): Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>;
|
|
1823
2079
|
/**
|
|
1824
2080
|
* 向本地插入一条消息，不发送到服务器
|
|
1825
2081
|
* @category 消息
|
|
@@ -1979,6 +2235,36 @@ declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Prom
|
|
|
1979
2235
|
*/
|
|
1980
2236
|
declare function setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<IAsyncRes<void>>;
|
|
1981
2237
|
|
|
2238
|
+
/**
|
|
2239
|
+
* 上传任务
|
|
2240
|
+
*/
|
|
2241
|
+
declare class UploadTask {
|
|
2242
|
+
private readonly _promise;
|
|
2243
|
+
private _resolve;
|
|
2244
|
+
private _client;
|
|
2245
|
+
readonly id: number;
|
|
2246
|
+
constructor(info: IUploadInfo, config: IUploadConfig);
|
|
2247
|
+
/**
|
|
2248
|
+
* 中断上传
|
|
2249
|
+
*/
|
|
2250
|
+
abort(): void;
|
|
2251
|
+
private _uploadInLoop;
|
|
2252
|
+
private _handleUpload;
|
|
2253
|
+
awaitResult(): Promise<IAsyncRes<IUploadResult>>;
|
|
2254
|
+
}
|
|
2255
|
+
|
|
2256
|
+
/**
|
|
2257
|
+
* 创建文件上传任务
|
|
2258
|
+
* @param uploadInfo
|
|
2259
|
+
* @returns
|
|
2260
|
+
*/
|
|
2261
|
+
declare function createUploadTask(uploadInfo: IUploadInfo): Promise<IAsyncRes<UploadTask>>;
|
|
2262
|
+
/**
|
|
2263
|
+
* 停止文件上传任务
|
|
2264
|
+
* @param taskId
|
|
2265
|
+
* @returns
|
|
2266
|
+
*/
|
|
2267
|
+
declare function stopUploadTask(taskId: number): Promise<IAsyncRes<boolean>>;
|
|
1982
2268
|
declare function upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResult>>;
|
|
1983
2269
|
/**
|
|
1984
2270
|
* 获取文件 token
|
|
@@ -2046,6 +2332,7 @@ declare const MessageType: {
|
|
|
2046
2332
|
FILE: string;
|
|
2047
2333
|
SIGHT: string;
|
|
2048
2334
|
COMBINE: string;
|
|
2335
|
+
COMBINE_V2: string;
|
|
2049
2336
|
CHRM_KV_NOTIFY: string;
|
|
2050
2337
|
LOG_COMMAND: string;
|
|
2051
2338
|
EXPANSION_NOTIFY: string;
|
|
@@ -2158,6 +2445,31 @@ declare function clearMessages(conversation: IConversationOption): Promise<IAsyn
|
|
|
2158
2445
|
* 数据在被抹除的情况下，未清理的磁盘空间会在后续存储操作中复用，且对数据查询无影响
|
|
2159
2446
|
*/
|
|
2160
2447
|
declare function deleteMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
|
|
2448
|
+
/**
|
|
2449
|
+
* 批量清除多个会话的本地消息
|
|
2450
|
+
* @param options 会话列表，最大数量为 20
|
|
2451
|
+
* @since 5.9.0
|
|
2452
|
+
* @description 从本地消息数据库中批量删除多个会话指定时间之前的消息数据,
|
|
2453
|
+
* 时间戳传 0 时，清除所有消息
|
|
2454
|
+
* 支持的会话类型：单聊, 群聊, 聊天室, 系统消息
|
|
2455
|
+
* @example
|
|
2456
|
+
* ```js
|
|
2457
|
+
* const conversations = [{
|
|
2458
|
+
* conversationType: ConversationType.PRIVATE,
|
|
2459
|
+
* targetId: 'targetId',
|
|
2460
|
+
* timestamp: 0,
|
|
2461
|
+
* channelId: '',
|
|
2462
|
+
* }]
|
|
2463
|
+
* RongIMLib.batchClearMessagesByTimestamp(conversations, 0).then(res => {
|
|
2464
|
+
* if (res.code === ErrorCode.SUCCESS) {
|
|
2465
|
+
* console.log('删除成功')
|
|
2466
|
+
* } else {
|
|
2467
|
+
* console.log('删除失败', res.code)
|
|
2468
|
+
* }
|
|
2469
|
+
* })
|
|
2470
|
+
* ```
|
|
2471
|
+
*/
|
|
2472
|
+
declare function batchClearMessagesByTimestamp(options: IClearMessageOption[]): Promise<IAsyncRes<void>>;
|
|
2161
2473
|
/**
|
|
2162
2474
|
* 向本地插入一条消息，不发送到服务器
|
|
2163
2475
|
* @param conversation 会话
|
|
@@ -2236,6 +2548,7 @@ declare const index_setMessageContent: typeof setMessageContent;
|
|
|
2236
2548
|
declare const index_deleteMessages: typeof deleteMessages;
|
|
2237
2549
|
declare const index_clearMessages: typeof clearMessages;
|
|
2238
2550
|
declare const index_deleteMessagesByTimestamp: typeof deleteMessagesByTimestamp;
|
|
2551
|
+
declare const index_batchClearMessagesByTimestamp: typeof batchClearMessagesByTimestamp;
|
|
2239
2552
|
declare const index_insertMessage: typeof insertMessage;
|
|
2240
2553
|
declare const index_batchInsertMessage: typeof batchInsertMessage;
|
|
2241
2554
|
declare const index_getMessageCount: typeof getMessageCount;
|
|
@@ -2260,6 +2573,7 @@ declare namespace index {
|
|
|
2260
2573
|
index_deleteMessages as deleteMessages,
|
|
2261
2574
|
index_clearMessages as clearMessages,
|
|
2262
2575
|
index_deleteMessagesByTimestamp as deleteMessagesByTimestamp,
|
|
2576
|
+
index_batchClearMessagesByTimestamp as batchClearMessagesByTimestamp,
|
|
2263
2577
|
index_insertMessage as insertMessage,
|
|
2264
2578
|
index_batchInsertMessage as batchInsertMessage,
|
|
2265
2579
|
index_getMessageCount as getMessageCount,
|
|
@@ -2290,4 +2604,4 @@ declare function getProxy(): IPromiseResult<IProxy>;
|
|
|
2290
2604
|
*/
|
|
2291
2605
|
declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IResponse>;
|
|
2292
2606
|
|
|
2293
|
-
export { BaseMessage, _default$
|
|
2607
|
+
export { BaseMessage, _default$a as CombineMessage, _default$9 as CombineV2Message, CombineV2MessageContent, _default$2 as CommandMessage, ConnectType, EventListeners, Events, _default$8 as FileMessage, _default$7 as GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, _default as GroupNotificationMessage, _default$d as HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetHistoryMessagesByTypesOption, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageDesc, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, _default$e as ImageMessage, _default$1 as InformationNotificationMessage, _default$5 as LocationMessage, MentionedInfo, MessageConstructor, MessageType, _default$4 as ReferenceMessage, _default$3 as RichContentMessage, _default$c as SightMessage, _default$b as TextMessage, UploadTask, _default$6 as VoiceMessage, __addSDKVersion, addConversationsToTag, addEventListener, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, bindRTCRoomForChatroom, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createUploadTask, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationState, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList$1 as getConversationList, getConversationNotificationLevel, getConversationNotificationStatus, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getHistoryMessages, getMessage, getMessageReadReceiptV4, getMessageReader, getProxy, getRemoteHistoryMessages, getServerTime, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionedCount, getUnreadMentionedMessages, init, insertMessage$1 as insertMessage, installPlugin, joinChatRoom, joinExistChatRoom, modifyMessage, onceEventListener, quitChatRoom, recallMessage, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeMessageExpansionForKey, removeTag, removeTagFromConversations, removeTagsFromConversation, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchMessages$1 as searchMessages, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setMessageReceivedStatus$1 as setMessageReceivedStatus, setProxy, setUltraGroupDefaultNotificationLevel, stopUploadTask, testProxy, updateExpansionForUltraGroupMessage, updateMessageExpansion, updateTag, upload };
|