@rongcloud/engine 5.0.2 → 5.0.3-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.0.2
- * CommitId - 2f7e168dbfa90aeb36ded32505fa5b07d1fde72f
- * Thu Dec 30 2021 14:14:19 GMT+0800 (China Standard Time)
+ * RCEngine - v5.0.3-alpha.1
+ * CommitId - 19b3a26341747fa66c9ef0742388df8d8787ba39
+ * Tue Jan 04 2022 14:07:36 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 /**
@@ -1969,7 +1969,7 @@ interface IChatroomListenerData {
      */
     chatroomDestroyed?: string;
 }
-interface IChatRoomEntry {
+interface IChatroomEntry {
     /**
      * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
      */
@@ -2012,7 +2012,7 @@ interface IChatroomInfo {
      */
     userCount: number;
 }
-interface IRemoveChatRoomEntry {
+interface IRemoveChatroomEntry {
     /**
      * 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
      */
@@ -2026,7 +2026,7 @@ interface IRemoveChatRoomEntry {
      */
     notificationExtra?: string;
 }
-interface IRemoveChatRoomEntries {
+interface IRemoveChatroomEntries {
     /**
      * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
      */
@@ -2041,7 +2041,7 @@ interface IRemoveChatRoomEntries {
      */
     notificationExtra?: string;
 }
-interface IChatRoomEntries {
+interface IChatroomEntries {
     /**
      * entries ,要设置的属性列表
      * key 属性名称, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符
@@ -3329,6 +3329,27 @@ interface ITypingMessage {
     list: Array<ITypingUser>;
 }
 
+/**
+ * 定义已废弃，请使用 `IRemoveChatroomEntries` 替换
+ * @deprecated
+ */
+declare type IRemoveChatRoomEntries = IRemoveChatroomEntries;
+/**
+ * 定义已废弃，请使用 `IChatroomEntry` 替换
+ * @deprecated
+ */
+declare type IChatRoomEntry = IChatroomEntry;
+/**
+ * 定义已废弃，请使用 `IChatroomEntries` 替换
+ * @deprecated
+ */
+declare type IChatRoomEntries = IChatroomEntries;
+/**
+ * 定义已废弃，请使用 `IRemoveChatroomEntry` 替换
+ * @deprecated
+ */
+declare type IRemoveChatRoomEntry = IRemoveChatroomEntry;
+
 /**
  * 序列化、反序列化数据通道
 */
@@ -4167,8 +4188,8 @@ declare class APIContext {
      * @param roomId 聊天室房间 id
      * @param entry 属性信息
      */
-    setChatroomEntry(roomId: string, entry: IChatRoomEntry): Promise<ErrorCode>;
-    setChatroomEntries(roomId: string, entryOptions: IChatRoomEntries): Promise<{
+    setChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
+    setChatroomEntries(roomId: string, entryOptions: IChatroomEntries): Promise<{
         code: ErrorCode;
         data?: any;
     }>;
@@ -4178,21 +4199,21 @@ declare class APIContext {
      * @param roomId 聊天室房间 id
      * @param entry 属性信息
      */
-    forceSetChatroomEntry(roomId: string, entry: IChatRoomEntry): Promise<ErrorCode>;
+    forceSetChatroomEntry(roomId: string, entry: IChatroomEntry): Promise<ErrorCode>;
     /**
      * 删除聊天室属性
      * @description 该方法仅限于删除自己设置的聊天室属性
      * @param roomId 聊天室房间 id
      * @param entry 要移除的属性信息
      */
-    removeChatroomEntry(roomId: string, entry: IRemoveChatRoomEntry): Promise<ErrorCode>;
+    removeChatroomEntry(roomId: string, entry: IRemoveChatroomEntry): Promise<ErrorCode>;
     /**
      * 批量删除聊天室属性
      * @description 该方法仅限于删除自己设置的聊天室属性
      * @param roomId 聊天室房间 id
      * @param entry 要移除的属性信息
      */
-    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatRoomEntries): Promise<{
+    removeChatroomEntries(roomId: string, entryOptions: IRemoveChatroomEntries): Promise<{
         code: ErrorCode;
         data?: any;
     }>;
@@ -4202,7 +4223,7 @@ declare class APIContext {
      * @param roomId 聊天室房间 id
      * @param entry 要移除的属性信息
      */
-    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatRoomEntry): Promise<ErrorCode>;
+    forceRemoveChatroomEntry(roomId: string, entry: IRemoveChatroomEntry): Promise<ErrorCode>;
     /**
      * 获取聊天室中的指定属性
      * @param roomId 聊天室房间 id
@@ -4225,7 +4246,15 @@ declare class APIContext {
      * * 1：升序，用于获取晚于指定时间戳发送的消息
      * @param timestamp 指定拉取消息用到的时间戳。默认值为 `0`，表示按当前时间拉取
      */
-    getChatRoomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
+    getChatroomHistoryMessages(roomId: string, count?: number, order?: 0 | 1, timestamp?: number): Promise<IAsyncRes<{
+        list: IReceivedMessage[];
+        hasMore: boolean;
+    }>>;
+    /**
+     * 方法已废弃，推荐使用 `getChatroomHistoryMessages` 替代
+     * @deprecated
+     */
+    getChatRoomHistoryMessages: (roomId: string, count?: number, order?: 0 | 1, timestamp?: number) => Promise<IAsyncRes<{
         list: IReceivedMessage[];
         hasMore: boolean;
     }>>;
@@ -5722,4 +5751,4 @@ declare enum CONNECTION_TYPE {
  */
 declare const version: string;
 
-export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };
+export { AEngine, ANavi, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType as ChatroomMemberChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IInsertMsgOptions, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomInfo, IRTCUsers, IReadReceiptInfo, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogType, Logger, MAX_MESSAGE_CONTENT_BYTES, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NotificationStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, cloneByJSON, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidFileType, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, todo, usingCppEngine, validate, version };