@rongcloud/imlib-next 5.32.0-c-rtc-alpha.3 → 5.32.0-c-dq.1
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.cjs +1 -1
- package/index.cjs.js +1 -1
- package/index.d.ts +81 -17
- package/index.esm.js +2 -2
- package/index.mjs +2 -2
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { FileType, APIContext, RCResult, IPluginGenerator, MessageTypeDescription, LogLevel, EnableLogL, AreaCode, LogDBProxy, IReceivedMessage, IGetHistoryMessageOption, IReceivedConversation, IPushConfig, IAuditInfoKeyInMessage, IRecallMsgOptions, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IUserSettingsChangedEvent, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IReadReceiptData, ISyncReadStatusData, ISubscribeUserStatusInfo, ISubscribeRelationInfo, SubscribeType, IUserProfileInfo, IGroupOperationInfo, IGroupInfoChanged, IGroupMemberInfoChanged, IGroupApplicationInfo, IGroupRemarkChangedSync, IGroupFollowsChangedSync, IFriendAdd, IFriendDelete, IFriendApplicationStatusChange, IFriendInfoChangedSync, IStreamMessageResponseEventData as IStreamMessageResponseEventData$1, ReadReceiptResponseV5, ISpeechToTextResponse, TranslateItem, IGetUltraGroupListOption, IUltraGroupConversation, NotificationLevel, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUltraGroupUnreadInfo, IConversationIdentifier, ITextMessageContent, IUserExtraKeyInMessage, IExtraDataKeyInMessage, IMentionedInfoKeyInMessage, IMessageReadReceiptV4Response, IGroupReadReceiptData, MessageDirection, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, ConversationType, ReadReceiptInfoV5, IMessageIdentifier, ReadReceiptUsersOption, ReadReceiptUsersResult, IConvertSpeechToTextOption, TranslateMessagesParams, TranslateTextsParams, IModifyMessageParams, ITagParam, ITagInfo, IConversationTag, ICombineMessageContent, ICombineV2MessageContent, ICommandMessageContent, IFileMessageContent, IGIFMessageContent, IGroupNotificationMessageContent, IImageMessageContent, IInformationNotificationMessageContent, ILocationMessageContent, IReferenceMessageContent, IRichContentMessageContent, ISightMessageContent, IStreamMessageContent, IHQVoiceMessageContent, IVoiceMessageContent, IUploadAuth, IDownloadAuth, UploadMethod, IEditedMessageDraft, IGetHistoryMessagesByTypesOption, ReceivedStatus, IReceivedStatusInfo, SentStatus, IInsertMessage, ISearchMessageParams, IProxy, IUpdateMyProfileFail, UserProfileVisibility, ISubscribeUserOnlineStatus, IGroupInfoOption, ICreateGroupFail, IErrorKeys, IGroupInfo, IQuitGroupConfig, GroupMemberRole, IGetGroupMembersOption, IPagingQueryResult, IGroupMemberInfo, IPagingQueryOption, IProcessCode, GroupApplicationDirection, GroupApplicationStatus, IFollowsInfo, DirectionType, IFriendRelationInfo, QueryFriendsDirectionType, IFriendInfo, FriendApplicationType, FriendApplicationStatus, IFriendApplicationInfo, FriendAddPermission, RCConnectionStatus, AppSettings, INotificationQuietHoursSetting, IGetConversationListByTimestampParams, ConversationBatchDeletionParams, TranslateStrategy, NotificationStatus, IConversationUnreadCount, IGetUnreadMentionMeConversationListParams, IChatroomJoinResponse, IChatroomInfo, IChatroomEntry, IChatroomEntries, IRemoveChatroomEntry, IRTCRoomBindOption, MentionedInfo } from '@rongcloud/engine';
|
|
2
|
-
export { AppSettings, AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationBatchDeletionParams, ConversationType, DirectionType, EnableLogL, ErrorCode, FileType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupReadReceiptVersion, IAndroidPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConversationFilter, IConversationIdentifier, IConversationOption, IConversationTag, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IErrorKeys, IEventListener, IExpansionListenerData, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetGroupMembersOption, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocationMessageContent, ILogData, IMentionedInfoKeyInMessage, IMessageDesc, IMessageFilter, IMessageIdentifier, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IModifyMessageParams, INotificationQuietHoursSetting, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPrivateReadReceiptData, IProcessCode, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, IRichContentMessageContent, ISearchMessageParams, ISearchMessagesResult, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStreamMessageContent, IStreamMessageResponseChunkData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IVoiceMessageContent, IiOSPushConfig, InterruptionLevel, LogDBProxy, LogL, LogLevel, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Platform, Platform as PlatformInfo, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, createLogDBProxy, fail, ok } from '@rongcloud/engine';
|
|
1
|
+
import { FileType, APIContext, RCResult, IPluginGenerator, MessageTypeDescription, LogLevel, EnableLogL, AreaCode, LogDBProxy, IReceivedMessage, IGetHistoryMessageOption, IReceivedConversation, IPushConfig, IAuditInfoKeyInMessage, IRecallMsgOptions, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IUserSettingsChangedEvent, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IReadReceiptData, ISyncReadStatusData, ISubscribeUserStatusInfo, ISubscribeRelationInfo, SubscribeType, IUserProfileInfo, IGroupOperationInfo, IGroupInfoChanged, IGroupMemberInfoChanged, IGroupApplicationInfo, IGroupRemarkChangedSync, IGroupFollowsChangedSync, IFriendAdd, IFriendDelete, IFriendApplicationStatusChange, IFriendInfoChangedSync, IStreamMessageResponseEventData as IStreamMessageResponseEventData$1, ReadReceiptResponseV5, ISpeechToTextResponse, TranslateItem, IRobotInfo, IGetUltraGroupListOption, IUltraGroupConversation, NotificationLevel, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUltraGroupUnreadInfo, IConversationIdentifier, ITextMessageContent, IUserExtraKeyInMessage, IExtraDataKeyInMessage, IMentionedInfoKeyInMessage, IMessageReadReceiptV4Response, IGroupReadReceiptData, MessageDirection, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, ConversationType, ReadReceiptInfoV5, IMessageIdentifier, ReadReceiptUsersOption, ReadReceiptUsersResult, IConvertSpeechToTextOption, TranslateMessagesParams, TranslateTextsParams, IModifyMessageParams, ITagParam, ITagInfo, IConversationTag, ICombineMessageContent, ICombineV2MessageContent, ICommandMessageContent, IFileMessageContent, IGIFMessageContent, IGroupNotificationMessageContent, IImageMessageContent, IInformationNotificationMessageContent, ILocationMessageContent, IReferenceMessageContent, IRichContentMessageContent, ISightMessageContent, IStreamMessageContent, IHQVoiceMessageContent, IVoiceMessageContent, IUploadAuth, IDownloadAuth, UploadMethod, IEditedMessageDraft, IGetHistoryMessagesByTypesOption, ReceivedStatus, IReceivedStatusInfo, SentStatus, IInsertMessage, ISearchMessageParams, IProxy, IUpdateMyProfileFail, UserProfileVisibility, ISubscribeUserOnlineStatus, IGroupInfoOption, ICreateGroupFail, IErrorKeys, IGroupInfo, IQuitGroupConfig, GroupMemberRole, IGetGroupMembersOption, IPagingQueryResult, IGroupMemberInfo, IPagingQueryOption, IProcessCode, GroupApplicationDirection, GroupApplicationStatus, IFollowsInfo, DirectionType, IFriendRelationInfo, QueryFriendsDirectionType, IFriendInfo, FriendApplicationType, FriendApplicationStatus, IFriendApplicationInfo, FriendAddPermission, RCConnectionStatus, AppSettings, INotificationQuietHoursSetting, IGetConversationListByTimestampParams, ConversationBatchDeletionParams, TranslateStrategy, NotificationStatus, IConversationUnreadCount, IGetUnreadMentionMeConversationListParams, IConversationListLoaderOptions, ConversationListLoader, IGetConversationsIncludingRobotsOption, IChatroomJoinResponse, IChatroomInfo, IChatroomEntry, IChatroomEntries, IRemoveChatroomEntry, IRTCRoomBindOption, MentionedInfo } from '@rongcloud/engine';
|
|
2
|
+
export { AppSettings, AreaCode, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, ConnectionStatus, ConversationBatchDeletionParams, ConversationListLoader, ConversationType, DirectionType, EnableLogL, ErrorCode, FileType, FilterRobotType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupReadReceiptVersion, IAndroidPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomJoinResponse, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConversationFilter, IConversationIdentifier, IConversationListLoaderOptions, IConversationOption, IConversationTag, IConversationTagFilter, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IErrorKeys, IEventListener, IExpansionListenerData, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetConversationsIncludingRobotsOption, IGetGroupMembersOption, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocationMessageContent, ILogData, IMentionedInfoKeyInMessage, IMessageDesc, IMessageExtraData, IMessageFilter, IMessageIdentifier, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IModifyMessageParams, INotificationQuietHoursSetting, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPrivateReadReceiptData, IProcessCode, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCRoomBindOption, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, IRichContentMessageContent, IRobotInfo, ISearchMessageParams, ISearchMessagesResult, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStreamMessageContent, IStreamMessageResponseChunkData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IVoiceMessageContent, IiOSPushConfig, InterruptionLevel, LogDBProxy, LogL, LogLevel, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Platform, Platform as PlatformInfo, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, createLogDBProxy, fail, ok } from '@rongcloud/engine';
|
|
3
3
|
|
|
4
4
|
/** [EN]
|
|
5
5
|
* Thumbnail configuration
|
|
@@ -687,7 +687,12 @@ declare enum Events {
|
|
|
687
687
|
* @description 因底层实现机制不同,超级群不需要额外做编辑数据同步,因此无需关注该事件
|
|
688
688
|
* @since 5.26.0
|
|
689
689
|
*/
|
|
690
|
-
MESSAGE_MODIFIED_SYNC_COMPLETED = "MESSAGE_MODIFIED_SYNC_COMPLETED"
|
|
690
|
+
MESSAGE_MODIFIED_SYNC_COMPLETED = "MESSAGE_MODIFIED_SYNC_COMPLETED",
|
|
691
|
+
/**
|
|
692
|
+
* 机器人列表同步完成
|
|
693
|
+
* @since 5.32.0
|
|
694
|
+
*/
|
|
695
|
+
ROBOTS_SYNCED = "ROBOTS_SYNCED"
|
|
691
696
|
}
|
|
692
697
|
|
|
693
698
|
declare class BaseMessage<T = any> {
|
|
@@ -896,7 +901,7 @@ declare type IInitOption = {
|
|
|
896
901
|
* TODO(Translation)
|
|
897
902
|
*/
|
|
898
903
|
/**
|
|
899
|
-
*
|
|
904
|
+
* 日志存储代理,用于自定义日志存储;不支持 Electron 平台。
|
|
900
905
|
* @hidden
|
|
901
906
|
* @since 5.22.0
|
|
902
907
|
*/
|
|
@@ -1646,6 +1651,7 @@ declare type EventListeners = {
|
|
|
1646
1651
|
[Events.TRANSLATE_RESPONSE]: (response: TranslateItem[]) => void;
|
|
1647
1652
|
[Events.MESSAGE_MODIFIED]: (messages: IAReceivedMessage[]) => void;
|
|
1648
1653
|
[Events.MESSAGE_MODIFIED_SYNC_COMPLETED]: () => void;
|
|
1654
|
+
[Events.ROBOTS_SYNCED]: (code: number, updatedRobots: IRobotInfo[]) => void;
|
|
1649
1655
|
};
|
|
1650
1656
|
|
|
1651
1657
|
/** [EN]
|
|
@@ -3687,8 +3693,8 @@ declare function searchConversationByContent$1(keyword: string, conversationType
|
|
|
3687
3693
|
* Example of clearing unread count before timestamp:
|
|
3688
3694
|
* ```ts
|
|
3689
3695
|
* const conversation = {
|
|
3690
|
-
*
|
|
3691
|
-
*
|
|
3696
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
3697
|
+
* targetId: 'targetId',
|
|
3692
3698
|
* }
|
|
3693
3699
|
* const timestamp = 1626955200000;
|
|
3694
3700
|
* const clearRes = await RongIMLib.clearUnreadCountByTimestamp(conversation, timestamp);
|
|
@@ -3706,8 +3712,8 @@ declare function searchConversationByContent$1(keyword: string, conversationType
|
|
|
3706
3712
|
* 清除时间戳前的未读数示例:
|
|
3707
3713
|
* ```ts
|
|
3708
3714
|
* const conversation = {
|
|
3709
|
-
*
|
|
3710
|
-
*
|
|
3715
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
3716
|
+
* targetId: 'targetId',
|
|
3711
3717
|
* }
|
|
3712
3718
|
* const timestamp = 1626955200000;
|
|
3713
3719
|
* const clearRes = await RongIMLib.clearUnreadCountByTimestamp(conversation, timestamp);
|
|
@@ -4201,13 +4207,14 @@ declare function removeTagsFromConversation(conversation: IConversationOption, t
|
|
|
4201
4207
|
declare function removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<RCResult>;
|
|
4202
4208
|
/** [EN]
|
|
4203
4209
|
* Paginate conversations under a tag
|
|
4204
|
-
*
|
|
4205
|
-
*
|
|
4206
|
-
*
|
|
4207
|
-
*
|
|
4208
|
-
*
|
|
4209
|
-
*
|
|
4210
|
-
*
|
|
4210
|
+
* @category Tag
|
|
4211
|
+
* @param tagId The ID of the tag
|
|
4212
|
+
* @param count The number of conversations to retrieve
|
|
4213
|
+
* @param timestamp The timestamp of the message in the conversation
|
|
4214
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data is an array of conversations of type {@link IAReceivedConversationByTag} or undefined
|
|
4215
|
+
* Starting from SDK version @since 5.7.0, the return data type of this interface has changed from {@link IReceivedConversationByTag} to {@link IAReceivedConversationByTag}
|
|
4216
|
+
* @deprecated - Since SDK version 5.32.0, it is recommended to use {@link createConversationListLoader} instead.
|
|
4217
|
+
* @example Example of paginating conversations under a tag:
|
|
4211
4218
|
* ```ts
|
|
4212
4219
|
* const tagId = 'tagId';
|
|
4213
4220
|
* const count = 10;
|
|
@@ -4224,6 +4231,7 @@ declare function removeTagFromConversations(tagId: string, conversations: IConve
|
|
|
4224
4231
|
* @param timestamp 分页起始时间戳
|
|
4225
4232
|
* @returns 返回一个 Promise<{@link RCResult}> 实例,data 为会话列表,类型为 {@link IAReceivedConversationByTag} 数组。
|
|
4226
4233
|
* 从 SDK 5.7.0 版本开始该接口的返回数据类型由 {@link IReceivedConversationByTag} 变更为 {@link IAReceivedConversationByTag}
|
|
4234
|
+
* @deprecated - 从 SDK 5.32.0 版本开始,建议使用 {@link createConversationListLoader} 替代
|
|
4227
4235
|
* @example 分页获取标签下会话列表示例:
|
|
4228
4236
|
* ```ts
|
|
4229
4237
|
* const tagId = 'tagId';
|
|
@@ -8188,6 +8196,35 @@ declare function getRealtimeConUnreadCounts(identifiers: IConversationIdentifier
|
|
|
8188
8196
|
* @since 5.28.0
|
|
8189
8197
|
*/
|
|
8190
8198
|
declare function getUnreadMentionMeConversationList(params: IGetUnreadMentionMeConversationListParams): Promise<RCResult<IAReceivedConversation[]>>;
|
|
8199
|
+
/** [EN]
|
|
8200
|
+
* Create Conversation List Loader
|
|
8201
|
+
* @description This API is used to create a conversation list loader. This API is not supported on the Electron platform, and does not support user-obtained ultra group conversations.
|
|
8202
|
+
* @param options Conversation list loader options
|
|
8203
|
+
* @since 5.32.0
|
|
8204
|
+
*/
|
|
8205
|
+
/**
|
|
8206
|
+
* 创建会话列表加载器,该接口暂不支持 Electron 平台,不支持获取超级群会话
|
|
8207
|
+
* @param options 会话列表加载器选项
|
|
8208
|
+
* @since 5.32.0
|
|
8209
|
+
*/
|
|
8210
|
+
declare function createConversationListLoader(options?: IConversationListLoaderOptions): Promise<RCResult<ConversationListLoader>>;
|
|
8211
|
+
/** [EN]
|
|
8212
|
+
* Get Conversation List Containing Robots, currently only supported for single chat and system sessions.
|
|
8213
|
+
* @param options Get Robot Conversation List Option, reference {@link IGetConversationsIncludingRobotsOption}
|
|
8214
|
+
* @since 5.32.0
|
|
8215
|
+
*/
|
|
8216
|
+
/**
|
|
8217
|
+
* 获取包含机器人的会话列表,当前仅支持单聊会话、系统会话。
|
|
8218
|
+
* @param options 获取机器人会话列表参数,参考 {@link IGetConversationsIncludingRobotsOption}
|
|
8219
|
+
* @since 5.32.0
|
|
8220
|
+
*/
|
|
8221
|
+
declare function getConversationsIncludingRobots(options: IGetConversationsIncludingRobotsOption): Promise<RCResult<IAReceivedConversation[]>>;
|
|
8222
|
+
/**
|
|
8223
|
+
* 标记远程会话为已读
|
|
8224
|
+
* @description 此接口需要开通“服务器记录未读数”功能,
|
|
8225
|
+
* @since 5.34.0
|
|
8226
|
+
*/
|
|
8227
|
+
declare function markRemoteConversationAsRead(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
8191
8228
|
|
|
8192
8229
|
/** [EN]
|
|
8193
8230
|
* TODO(Translate)
|
|
@@ -8278,6 +8315,7 @@ declare function joinExistChatRoom(targetId: string, options: IChatroomJoinOpts)
|
|
|
8278
8315
|
* @description The client user can actively exit the chatroom. After exiting, the user will no longer receive chatroom messages.
|
|
8279
8316
|
* @category Chatroom
|
|
8280
8317
|
* @param targetId Chatroom ID
|
|
8318
|
+
* @param extra Extended information
|
|
8281
8319
|
* @example
|
|
8282
8320
|
* Example of exiting a chatroom:
|
|
8283
8321
|
* ```ts
|
|
@@ -8291,6 +8329,7 @@ declare function joinExistChatRoom(targetId: string, options: IChatroomJoinOpts)
|
|
|
8291
8329
|
* @description 客户端用户可主动退出聊天室,退出后不再接收聊天室消息
|
|
8292
8330
|
* @category 聊天室
|
|
8293
8331
|
* @param targetId 聊天室 ID
|
|
8332
|
+
* @param extra 透传信息,从 5.30.1 版本开始支持
|
|
8294
8333
|
* @example
|
|
8295
8334
|
* 退出聊天室示例:
|
|
8296
8335
|
* ```ts
|
|
@@ -8299,7 +8338,7 @@ declare function joinExistChatRoom(targetId: string, options: IChatroomJoinOpts)
|
|
|
8299
8338
|
* console.log('退出聊天室结果:', res);
|
|
8300
8339
|
* ```
|
|
8301
8340
|
*/
|
|
8302
|
-
declare function quitChatRoom(targetId: string): Promise<RCResult>;
|
|
8341
|
+
declare function quitChatRoom(targetId: string, extra?: string): Promise<RCResult>;
|
|
8303
8342
|
declare type IGetChatroomInfoOptions = {
|
|
8304
8343
|
/** [EN]
|
|
8305
8344
|
* Retrieves the number of users in the chatroom. The value range is 0-20, with a default value of 0. When the value is 0, only the total number of members is returned, and the member list is not included.
|
|
@@ -8864,6 +8903,31 @@ declare function setAutoTranslateEnabled(enabled: boolean): Promise<RCResult>;
|
|
|
8864
8903
|
*/
|
|
8865
8904
|
declare function getAutoTranslateEnabled(): Promise<RCResult<boolean>>;
|
|
8866
8905
|
|
|
8906
|
+
/** [EN]
|
|
8907
|
+
* Get all robots in the application, the SDK internally caches robot information and keeps it valid for 10 minutes.
|
|
8908
|
+
* When repeated requests are made during the data validity period, the SDK will directly return the current cached data.
|
|
8909
|
+
* When the data expires, the SDK will re-fetch from the server. If the re-fetch fails, the local data will still be returned. If there is no local cache, an empty array will be returned.
|
|
8910
|
+
* @since 5.32.0
|
|
8911
|
+
*/
|
|
8912
|
+
/**
|
|
8913
|
+
* 获取应用下的所有机器人列表,SDK 内部缓存会缓存机器人信息,并保持 10 分钟内持续有效。
|
|
8914
|
+
* 数据有效期内重复请求时,SDK 将直接返回当前的缓存数据。
|
|
8915
|
+
* 数据失效后,SDK 将从服务器重新拉取,若拉取失败,仍返回本地数据。本地无缓存时,将返回空数组。
|
|
8916
|
+
* @since 5.32.0
|
|
8917
|
+
*/
|
|
8918
|
+
declare function getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
8919
|
+
/** [EN]
|
|
8920
|
+
* Get the information of the specified robot, if it does not exist, return RCResult<null>
|
|
8921
|
+
* @param robotId The robot ID
|
|
8922
|
+
* @since 5.32.0
|
|
8923
|
+
*/
|
|
8924
|
+
/**
|
|
8925
|
+
* 获取指定机器人信息,若不存在,则返回 RCResult<null>
|
|
8926
|
+
* @param robotId 机器人 ID
|
|
8927
|
+
* @since 5.32.0
|
|
8928
|
+
*/
|
|
8929
|
+
declare function getRobotById(robotId: string): Promise<RCResult<IRobotInfo | null>>;
|
|
8930
|
+
|
|
8867
8931
|
declare type IStreamMessageResponseEventData = IStreamMessageResponseEventData$1<IAReceivedMessage>;
|
|
8868
8932
|
|
|
8869
|
-
export { BaseMessage, BuiltinMessage, CombineMessage, CombineV2Message, CombineV2MessageContent, CommandMessage, ConnectType, EventListeners, Events, FileMessage, GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, GroupNotificationMessage, HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, IAuditInfo, IBaseConversationInfo, IChatroomJoinOpts, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetChatroomInfoOptions, IGetConversationListOptions, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRefreshReferenceMessageParams, IRefreshReferenceMessageResult, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, IStreamMessageBody, IStreamMessageResponseEventData, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, ImageMessage, InformationNotificationMessage, LocationMessage, MentionedInfoBody, MessageConstructor, Monitor, MonitorableAPI, ReferenceMessage, RichContentMessage, SightMessage, TextMessage, Transformer, UploadTask, VoiceMessage, __addSDKVersion, acceptFriendApplication, acceptGroupApplication, acceptGroupInvite, addConversationsToTag, addEventListener, addFriend, addGroupFollows, addGroupManagers, addMonitor, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchDeleteConversations, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, batchSetConversationTranslateStrategy, bindRTCRoomForChatroom, checkFriends, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearRealtimeConUnreadCount, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createGroup, createUploadTask, deleteFriends, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, dismissGroup, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationList, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getAppSettings, getAutoTranslateEnabled, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList, getConversationListByTimestamp, getConversationNotificationLevel, getConversationNotificationStatus, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getFriendAddPermission, getFriendApplications, getFriends, getFriendsInfo, getGroupApplications, getGroupFollows, getGroupMembers, getGroupMembersByRole, getGroupsInfo, getHistoryMessages, getJoinedGroups, getJoinedGroupsByRole, getMessage, getMessageReadReceiptInfoV5, getMessageReadReceiptInfoV5ByIdentifiers, getMessageReadReceiptV4, getMessageReader, getMessagesReadReceiptByUsersV5, getMessagesReadReceiptUsersByPageV5, getMyUserProfile, getMyUserProfileVisibility, getNotificationQuietHoursSetting, getProxy, getRealtimeConTotalUnreadCount, getRealtimeConUnreadCounts, getRealtimeConversations, getRemoteHistoryMessages, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getSubscribeUsersOnlineStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getTranslationLanguage, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionMeConversationList, getUnreadMentionedCount, getUnreadMentionedMessages$1 as getUnreadMentionedMessages, getUserProfiles, init, insertMessage$1 as insertMessage, installPlugin, inviteUsersToGroup, joinChatRoom, joinExistChatRoom, joinGroup, kickGroupMembers, modifyMessage, modifyMessageWithParams, onceEventListener, quitChatRoom, quitGroup, recallMessage, refreshReferenceMessageWithParams, refuseFriendApplication, refuseGroupApplication, refuseGroupInvite, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeGroupFollows, removeGroupManagers, removeMessageExpansionForKey, removeMonitor, removeNotificationQuietHoursSetting, removeRealtimeConversations, removeTag, removeTagFromConversations, removeTagsFromConversation, requestSpeechToTextForMessage, requestStreamMessageContent, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchFriendsInfo, searchGroupMembers, searchJoinedGroups, searchMessages$1 as searchMessages, searchUserProfileByUniqueId, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendReadReceiptResponseV5, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setAutoTranslateEnabled, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setFriendAddPermission, setFriendInfo, setGroupMemberInfo, setGroupRemark, setMessageReceivedStatus$1 as setMessageReceivedStatus, setNotificationQuietHoursWithSetting, setProxy, setTranslationLanguage, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, transferGroupOwner, translateMessagesWithParams, translateTextsWithParams, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateGroupInfo, updateMessageExpansion, updateMyUserProfile, updateMyUserProfileVisibility, updateTag, upload };
|
|
8933
|
+
export { BaseMessage, BuiltinMessage, CombineMessage, CombineV2Message, CombineV2MessageContent, CommandMessage, ConnectType, EventListeners, Events, FileMessage, GIFMessage, GetHistoryMessageOption, GetHistoryMessageResult, GroupNotificationMessage, HQVoiceMessage, IAReceivedConversation, IAReceivedConversationByTag, IAReceivedMessage, IAUltraGroupReceivedConversation, IAuditInfo, IBaseConversationInfo, IChatroomJoinOpts, ICombineMessageBody, ICommandMessageBody, IConversationEvent, IConversationState, IConversationUpdateItem, IExtraData, IFileMessageBody, IGIFMessageBody, IGetChatroomInfoOptions, IGetConversationListOptions, IGroupNotificationMessageBody, IHQVoiceMessageBody, IImageMessageBody, IImageMessageOption, IInformationNotificationMessageBody, IInitOption, IInsertOptions, ILocationMessageBody, IMessageReceiptRequestEvent, IMessageReceiptResponseEvent, IMessagesEvent, IReadReceiptReceivedEvent, IRecallMessageOptions, IReceivedUpdateConversation, IReferenceMessageBody, IRefreshReferenceMessageParams, IRefreshReferenceMessageResult, IRichContentMessageBody, ISearchMessageInTimeRangeOption, ISendBody, ISendFileMessageOptions, ISendImageMessageOptions, ISendMessageOptions, ISendSightMessageOptions, ISightMessageBody, IStreamMessageBody, IStreamMessageResponseEventData, ITextMessageBody, IThumbnailConfig, ITypingStatusEvent, IUploadConfig, IUploadHooks, IUploadInfo, IUploadMessageOption, IUploadResult, IUserInfo, IVoiceMessageBody, ImageMessage, InformationNotificationMessage, LocationMessage, MentionedInfoBody, MessageConstructor, Monitor, MonitorableAPI, ReferenceMessage, RichContentMessage, SightMessage, TextMessage, Transformer, UploadTask, VoiceMessage, __addSDKVersion, acceptFriendApplication, acceptGroupApplication, acceptGroupInvite, addConversationsToTag, addEventListener, addFriend, addGroupFollows, addGroupManagers, addMonitor, addTag, addToBlacklist, batchClearRemoteHistoryMessages, batchDeleteConversations, batchGetMessageReadReceiptInfoV4, batchRemoveConversation, batchSetConversationNotificationLevel, batchSetConversationToTop, batchSetConversationTranslateStrategy, bindRTCRoomForChatroom, checkFriends, clearAllMessagesUnreadStatus, clearEventListeners, clearHistoryMessages, clearMessages$1 as clearMessages, clearMessagesUnreadStatus, clearRealtimeConUnreadCount, clearTextMessageDraft, clearUnreadCountByTimestamp, connect, createConversationListLoader, createGroup, createUploadTask, deleteFriends, deleteLocalMessagesByTimestamp, deleteMessages$1 as deleteMessages, destroy, disconnect, dismissGroup, index as electronExtension, forceRemoveChatRoomEntry, forceSetChatRoomEntry, getAllChatRoomEntries, getAllConversationList, getAllRobots, getAllUltraGroupUnreadCount, getAllUltraGroupUnreadMentionedCount, getAllUnreadMentionedCount, getAppSettings, getAutoTranslateEnabled, getBlacklist, getBlacklistStatus, getBlockUltraGroupList, getBlockedConversationList, getChatRoomEntry, getChatRoomInfo, getChatroomHistoryMessages, getConnectionStatus, getConversation, getConversationList, getConversationListByTimestamp, getConversationNotificationLevel, getConversationNotificationStatus, getConversationTypeNotificationLevel, getConversationsFromTagByPage, getConversationsIncludingRobots, getCurrentUserId, getDeviceId, getDownloadAuth, getFileToken, getFileUrl, getFirstUnreadMessage, getFirstUnreadMessageInfo, getFriendAddPermission, getFriendApplications, getFriends, getFriendsInfo, getGroupApplications, getGroupFollows, getGroupMembers, getGroupMembersByRole, getGroupsInfo, getHistoryMessages, getJoinedGroups, getJoinedGroupsByRole, getMessage, getMessageReadReceiptInfoV5, getMessageReadReceiptInfoV5ByIdentifiers, getMessageReadReceiptV4, getMessageReader, getMessagesReadReceiptByUsersV5, getMessagesReadReceiptUsersByPageV5, getMyUserProfile, getMyUserProfileVisibility, getNotificationQuietHoursSetting, getProxy, getRealtimeConTotalUnreadCount, getRealtimeConUnreadCounts, getRealtimeConversations, getRemoteHistoryMessages, getRobotById, getServerTime, getSubscribeUserList, getSubscribeUserStatus, getSubscribeUsersOnlineStatus, getTags, getTagsFromConversation, getTextMessageDraft, getTopConversationList, getTotalUnreadCount, getTotalUnreadCountByLevels, getTotalUnreadMentionedCountByLevels, getTranslationLanguage, getUltraGroupDefaultNotificationLevel, getUltraGroupFirstUnreadMessageTimestamp, getUltraGroupList, getUltraGroupMessageListByMessageUId, getUltraGroupUnreadCountByTargetId, getUltraGroupUnreadInfoList, getUltraGroupUnreadMentionedCountByTargetId, getUltraGroupUnreadMentionedMessages, getUnreadConversationList, getUnreadCount, getUnreadCountByTag, getUnreadMentionMeConversationList, getUnreadMentionedCount, getUnreadMentionedMessages$1 as getUnreadMentionedMessages, getUserProfiles, init, insertMessage$1 as insertMessage, installPlugin, inviteUsersToGroup, joinChatRoom, joinExistChatRoom, joinGroup, kickGroupMembers, markRemoteConversationAsRead, modifyMessage, modifyMessageWithParams, onceEventListener, quitChatRoom, quitGroup, recallMessage, refreshReferenceMessageWithParams, refuseFriendApplication, refuseGroupApplication, refuseGroupInvite, registerMessageType, removeAllExpansionForUltraGroupMessage, removeChatRoomEntries, removeChatRoomEntry, removeConversation, removeConversationsFromTag, removeEventListener, removeEventListeners, removeExpansionForUltraGroupMessage, removeFromBlacklist, removeGroupFollows, removeGroupManagers, removeMessageExpansionForKey, removeMonitor, removeNotificationQuietHoursSetting, removeRealtimeConversations, removeTag, removeTagFromConversations, removeTagsFromConversation, requestSpeechToTextForMessage, requestStreamMessageContent, saveTextMessageDraft, searchConversationByContent$1 as searchConversationByContent, searchFriendsInfo, searchGroupMembers, searchJoinedGroups, searchMessages$1 as searchMessages, searchUserProfileByUniqueId, sendFileMessage, sendGIFMessage, sendHQVoiceMessage, sendImageMessage, sendMessage, sendReadReceiptMessage, sendReadReceiptMessageV4, sendReadReceiptRequest, sendReadReceiptResponse, sendReadReceiptResponseV2, sendReadReceiptResponseV5, sendSightMessage, sendSyncReadStatusMessage, sendTextMessage, sendTypingStatusMessage, sendUltraGroupTypingStatus, setAutoTranslateEnabled, setChatRoomEntries, setChatRoomEntry, setConversationNotificationLevel, setConversationNotificationStatus, setConversationToTop, setConversationToTopInTag, setConversationTypeNotificationLevel, setFriendAddPermission, setFriendInfo, setGroupMemberInfo, setGroupRemark, setMessageReceivedStatus$1 as setMessageReceivedStatus, setNotificationQuietHoursWithSetting, setProxy, setTranslationLanguage, setUltraGroupDefaultNotificationLevel, stopUploadTask, subscribeUserStatus, testProxy, transferGroupOwner, translateMessagesWithParams, translateTextsWithParams, unSubscribeUserStatus, updateExpansionForUltraGroupMessage, updateGroupInfo, updateMessageExpansion, updateMyUserProfile, updateMyUserProfileVisibility, updateTag, upload };
|