@rongcloud/engine 5.0.2-custom-qihoo.3 → 5.1.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCEngine - v5.0.2-custom-qihoo.3
- * CommitId - f8a1324d21580d810213ad3d49224159427c2f46
- * Fri Dec 31 2021 10:38:29 GMT+0800 (China Standard Time)
+ * RCEngine - v5.1.0
+ * CommitId - a336c0de6ae1d26b24ec675889d919bcb2195568
+ * Fri Jan 07 2022 15:56:12 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 字符
@@ -2742,6 +2742,111 @@ interface IExtraMethod {
     updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
 }
 
+interface IReqRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 被邀请房间 ID
+     */
+    invitedRoomId: string;
+    /**
+     * 被邀请用户 ID
+     */
+    invitedUserId: string;
+    /**
+     * 本次邀请超时时间
+     */
+    inviteTimeout: number;
+    /**
+     * 本次邀请额外信息
+     */
+    inviteInfo: string;
+    /**
+     * 本次邀请唯一 ID
+     */
+    inviteSessionId: string;
+}
+interface ICancelRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 被邀请房间 ID
+     */
+    invitedRoomId: string;
+    /**
+     * 被邀请用户 ID
+     */
+    invitedUserId: string;
+    /**
+     * 本次邀请额外信息
+     */
+    inviteInfo: string;
+    /**
+     * 本次邀请唯一 ID
+     */
+    inviteSessionId: string;
+}
+interface IResRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 邀请者 ID
+     */
+    inviteUserId: string;
+    /**
+     * 邀请者房间 ID
+     */
+    inviteRoomId: string;
+    /**
+     * 邀请的 session ID
+     */
+    inviteSessionId: string;
+    /**
+     * 需要转发的信息
+     */
+    content: string;
+    /**
+     * 同意邀请时要设置的 key, 放在room级别的k和v,新加入房间的能拉取到
+     */
+    key: string;
+    /**
+     * 同意邀请时要设置的 value, 放在room级别的k和v,新加入房间的能拉取到
+     */
+    value: string;
+    /**
+     * 是否同意邀请
+     */
+    agree: boolean;
+}
+interface IEndRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 需要结束的连麦房间 ID
+     */
+    endRoomId: string;
+    /**
+     * 需要结束连麦的 sessionID
+     */
+    sessionId: string;
+    /**
+     * 结束连麦的信息
+     */
+    content: string;
+    /**
+     * 需要删除连麦的信息的 keys
+     */
+    keys: string[];
+}
+
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
  */
@@ -3243,6 +3348,10 @@ interface IEngine {
     setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
     setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
+    cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
+    responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
+    endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
 }
 
 interface IExpansionMsgContent {
@@ -3329,6 +3438,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;
+
 /**
  * 序列化、反序列化数据通道
 */
@@ -3614,6 +3744,22 @@ declare class DataCodec {
      * RTC 查询在房间内用户的信息
      */
     encodeQueryUserJoinedInfo(userId: string): any;
+    /**
+     * 连麦 PK 请求
+     */
+    encodeRequestRoomPK(options: IReqRoomPKOptions): any;
+    /**
+     * 取消连麦 PK 请求
+     */
+    encodeCancelRoomPK(options: ICancelRoomPKOptions): any;
+    /**
+     * 响应连麦 PK 请求
+     */
+    encodeResponseRoomPK(options: IResRoomPKOptions): any;
+    /**
+     * 结束连麦 PK
+     */
+    encodeEndRoomPK(options: IEndRoomPKOptions): any;
 }
 
 interface IDataChannelWatcher {
@@ -4167,8 +4313,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 +4324,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 +4348,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 +4371,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;
     }>>;
@@ -4487,6 +4641,22 @@ declare class APIContext {
      * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
      */
     getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
+    /**
+     * 连麦 PK 请求
+     */
+    requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 取消连麦 PK 请求
+     */
+    cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 响应连麦 PK 请求
+     */
+    responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 结束连麦 PK
+     */
+    endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
 }
 
 declare class PluginContext {
@@ -4657,6 +4827,22 @@ declare class RTCPluginContext extends PluginContext {
      * 直播身份切换
      */
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
+    /**
+     * 连麦 PK 请求
+     */
+    requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 取消连麦 PK 请求
+     */
+    cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 响应连麦 PK 请求
+     */
+    responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 结束连麦 PK
+     */
+    endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
 }
 
 declare abstract class ANavi {
@@ -5255,6 +5441,10 @@ declare abstract class AEngine implements IEngine {
     abstract rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
     abstract getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
     abstract setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    abstract requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
+    abstract cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
+    abstract responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
+    abstract endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
 }
 
 declare class AppStorage {
@@ -5722,4 +5912,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, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, 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, IReqRoomPKOptions, IRequest, IResRoomPKOptions, 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 };