@rongcloud/engine 5.34.0 → 5.36.0-alpha.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 +53 -364
- package/index.esm.js +1 -1
- package/index.mjs +1 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -10460,6 +10460,14 @@ interface INaviInfo {
|
|
|
10460
10460
|
* @since 5.34.0
|
|
10461
10461
|
*/
|
|
10462
10462
|
serverSaveUnread?: 0 | 1;
|
|
10463
|
+
/**
|
|
10464
|
+
* 是否开启多端离线消息补偿。
|
|
10465
|
+
* @description 只有导航明确下发值为 0 时,才表示关闭多端离线消息补偿。其他情况均表示开启多端离线消息补偿。
|
|
10466
|
+
* 0: 关闭。
|
|
10467
|
+
* 1: 开启。
|
|
10468
|
+
* @since 5.36.0
|
|
10469
|
+
*/
|
|
10470
|
+
openHistoryMsg?: 0 | 1;
|
|
10463
10471
|
}
|
|
10464
10472
|
|
|
10465
10473
|
/** [EN]
|
|
@@ -12625,11 +12633,7 @@ interface IIPCMethods {
|
|
|
12625
12633
|
/**
|
|
12626
12634
|
* 设置当前用户在线状态
|
|
12627
12635
|
*/
|
|
12628
|
-
setUserStatus(status: number): Promise<
|
|
12629
|
-
/**
|
|
12630
|
-
* 订阅用户在线状态
|
|
12631
|
-
*/
|
|
12632
|
-
subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
|
|
12636
|
+
setUserStatus(status: number): Promise<RCResult>;
|
|
12633
12637
|
/**
|
|
12634
12638
|
* 获取用户状态
|
|
12635
12639
|
*/
|
|
@@ -12694,8 +12698,9 @@ interface IIPCMethods {
|
|
|
12694
12698
|
setMessageContent(messageId: number, content: string, messageType: string): Promise<RCResult>;
|
|
12695
12699
|
/**
|
|
12696
12700
|
* 设置消息搜索字段
|
|
12701
|
+
* @deprecated 老版 V2 中用到
|
|
12697
12702
|
*/
|
|
12698
|
-
setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<
|
|
12703
|
+
setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<RCResult>;
|
|
12699
12704
|
/**
|
|
12700
12705
|
* 通过关键字与 channelId 搜索所有会话
|
|
12701
12706
|
*/
|
|
@@ -12869,6 +12874,9 @@ interface IIPCMethods {
|
|
|
12869
12874
|
setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
12870
12875
|
removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
12871
12876
|
getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
12877
|
+
/**
|
|
12878
|
+
* 获取统计地址
|
|
12879
|
+
*/
|
|
12872
12880
|
getStatsUrlList(): Promise<RCResult<string[]>>;
|
|
12873
12881
|
/**
|
|
12874
12882
|
* 发送消息已读回执(V5 版本)
|
|
@@ -12908,6 +12916,13 @@ interface IIPCMethods {
|
|
|
12908
12916
|
}>>;
|
|
12909
12917
|
rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
12910
12918
|
bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<RCResult>;
|
|
12919
|
+
/**
|
|
12920
|
+
* RTC 通用调用接口
|
|
12921
|
+
* @param roomId 房间 ID
|
|
12922
|
+
* @param method CMP 接口方法名
|
|
12923
|
+
* @param isQuery 使用 `qry` or `pub` 进行请求,按服务要求传递
|
|
12924
|
+
* @param sourceData PB 数据
|
|
12925
|
+
*/
|
|
12911
12926
|
rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<RCResult<Uint8Array>>;
|
|
12912
12927
|
requestSpeechToTextForMessage(messageUId: string, option?: IConvertSpeechToTextOption): Promise<RCResult>;
|
|
12913
12928
|
setMessageSpeechToTextVisible(messageId: number, isVisible: boolean): Promise<RCResult>;
|
|
@@ -13402,9 +13417,9 @@ interface IEngineWatcher extends IConnectionListener {
|
|
|
13402
13417
|
ultraGroupChannelUserKicked: (list: IUltraChannelUserKickedInfo[]) => void;
|
|
13403
13418
|
ultraGroupChannelDelete: (list: IUltraChannelDeleteInfo[]) => void;
|
|
13404
13419
|
/**
|
|
13405
|
-
* RTC
|
|
13420
|
+
* RTC KV 数据变更通知,由 RTC 插件自行解析和处理
|
|
13406
13421
|
*/
|
|
13407
|
-
onRTCDataChange: (
|
|
13422
|
+
onRTCDataChange: (buffer: Uint8Array) => void;
|
|
13408
13423
|
pullFinished: () => void;
|
|
13409
13424
|
callInfo: (data: string) => void;
|
|
13410
13425
|
onNaviDataChange: (naviInfo: INaviInfo) => void;
|
|
@@ -14698,10 +14713,6 @@ interface IModuleContext extends Pick<IIPCMethods, 'sendMessage'> {
|
|
|
14698
14713
|
* 应用 Key
|
|
14699
14714
|
*/
|
|
14700
14715
|
get appkey(): string;
|
|
14701
|
-
/**
|
|
14702
|
-
* 初始化选项
|
|
14703
|
-
*/
|
|
14704
|
-
get initOption(): IAPIContextOption;
|
|
14705
14716
|
/**
|
|
14706
14717
|
* 当前连接状态
|
|
14707
14718
|
*/
|
|
@@ -14920,34 +14931,6 @@ declare class DataHosting extends BaseModule {
|
|
|
14920
14931
|
getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
14921
14932
|
}
|
|
14922
14933
|
|
|
14923
|
-
/**
|
|
14924
|
-
* 会话聊天模块
|
|
14925
|
-
*/
|
|
14926
|
-
interface IChatService extends Pick<IIPCMethods, 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllSGUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2' | 'syncRemoteConversations' | 'sendUltraGroupTypingStatus' | 'getUltraGroupList' | 'getRemoteMessagesByUIds' | 'getUGUnreadMentionedDigest' | 'getHistoryMessagesByObjectNames' | 'getContinuousMessages' | 'getMessagesAroundTimestamp' | 'deleteLocalUGMessagesForAllChannel' | 'updateUGMessageExpansion' | 'setUGDefaultNotificationLevel' | 'getUGDefaultNotificationLevel' | 'getUnreadMentionedMessages' | 'getUnreadMentionedCount' | 'getAllUnreadMentionedCount' | 'getTotalUnreadCountByLevels' | 'getConversationUnreadCount' | 'getFirstUnreadMessage' | 'getFirstUnreadMessageDigest' | 'getUGUnreadCountForAllChannels' | 'getUGUnreadInfoList' | 'getUGFirstUnreadMessageDigest' | 'getConversations' | 'clearConversationUnreadCount' | 'markRemoteConversationAsRead' | 'getTopConversationList' | 'getUnreadConversationList' | 'getConversationListByPageIndex' | 'getAllConversationList' | 'getConversationListByTimestamp' | 'clearConversations' | 'getBlockedConversationList' | 'getBlockedUGList' | 'saveEditedMessageDraft' | 'getEditedMessageDraft' | 'clearEditedMessageDraft' | 'getUnreadMentionMeConversationList' | 'sendUltraGroupTypingStatus' | 'updateConversationReadTime' | 'clearUnreadCountByTimestamp' | 'getMessageReader' | 'getMessageReadReceiptV4' | 'sendReadReceiptMessageV4' | 'getConversationsIncludingRobots'> {
|
|
14927
|
-
/** 超级群是否已同步完成 */
|
|
14928
|
-
get ugSynced(): boolean;
|
|
14929
|
-
getRealtimeConversations(count: number, startTime: number, order: 0 | 1): Promise<RCResult<IReceivedConversation[]>>;
|
|
14930
|
-
getRealtimeConTotalUnreadCount(): Promise<RCResult<number>>;
|
|
14931
|
-
clearRealtimeConUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
14932
|
-
removeRealtimeConversations(identifiers: IConversationIdentifier[]): Promise<RCResult>;
|
|
14933
|
-
batchGetRealtimeConUnreadCount(identifiers: IConversationIdentifier[]): Promise<RCResult<IConversationUnreadCount[]>>;
|
|
14934
|
-
/**
|
|
14935
|
-
* 分页加载会话列表
|
|
14936
|
-
* @param pageToken 分页 token
|
|
14937
|
-
* @param count 分页数量
|
|
14938
|
-
* @param options 会话列表加载器选项,仅 pageToken 无值时有效
|
|
14939
|
-
*/
|
|
14940
|
-
loadConversationList(pageToken: string, count: number, options: IConversationListLoaderOptions): Promise<RCResult<{
|
|
14941
|
-
pageToken: string;
|
|
14942
|
-
finished: boolean;
|
|
14943
|
-
list: IReceivedConversation[];
|
|
14944
|
-
}>>;
|
|
14945
|
-
/**
|
|
14946
|
-
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
14947
|
-
*/
|
|
14948
|
-
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
14949
|
-
}
|
|
14950
|
-
|
|
14951
14934
|
/**
|
|
14952
14935
|
* 会话列表加载器,暂不支持用于获取超级群会话列表,不支持 Electron 平台
|
|
14953
14936
|
* @since 5.32.0
|
|
@@ -15178,10 +15161,6 @@ declare class APIContext {
|
|
|
15178
15161
|
private _friendApplicationStatusChanged;
|
|
15179
15162
|
private _friendCleared;
|
|
15180
15163
|
private _friendInfoChangedSync;
|
|
15181
|
-
/**
|
|
15182
|
-
* rtc 数据变更通知 pluginContext
|
|
15183
|
-
*/
|
|
15184
|
-
private _rtcDataChange;
|
|
15185
15164
|
/**
|
|
15186
15165
|
* 导航数据变更通知
|
|
15187
15166
|
*/
|
|
@@ -15276,6 +15255,8 @@ declare class APIContext {
|
|
|
15276
15255
|
* @param isStatusMessage 是否是状态消息
|
|
15277
15256
|
*/
|
|
15278
15257
|
registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): void;
|
|
15258
|
+
private _rtcListener?;
|
|
15259
|
+
private _rtcDataChange;
|
|
15279
15260
|
/**
|
|
15280
15261
|
* 注册 RTC KV 通知监听器
|
|
15281
15262
|
* @param listener
|
|
@@ -15666,8 +15647,9 @@ declare class APIContext {
|
|
|
15666
15647
|
setMessageContent(messageId: number, content: any, messageType: string): Promise<RCResult>;
|
|
15667
15648
|
/**
|
|
15668
15649
|
* 设置消息搜索字段
|
|
15650
|
+
* @deprecated 老版 V2 中用到
|
|
15669
15651
|
*/
|
|
15670
|
-
setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<
|
|
15652
|
+
setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<RCResult>;
|
|
15671
15653
|
/**
|
|
15672
15654
|
* 设置消息发送状态
|
|
15673
15655
|
*/
|
|
@@ -15684,12 +15666,7 @@ declare class APIContext {
|
|
|
15684
15666
|
* 设置当前用户在线状态
|
|
15685
15667
|
* @deprecated 老版 V2 中用到
|
|
15686
15668
|
*/
|
|
15687
|
-
setUserStatus(status: number): Promise<
|
|
15688
|
-
/**
|
|
15689
|
-
* 订阅用户在线状态
|
|
15690
|
-
* @deprecated 老版 V2 中用到
|
|
15691
|
-
*/
|
|
15692
|
-
subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
|
|
15669
|
+
setUserStatus(status: number): Promise<RCResult>;
|
|
15693
15670
|
/**
|
|
15694
15671
|
* 获取用户在线状态
|
|
15695
15672
|
* @deprecated 老版 V2 中用到
|
|
@@ -16007,326 +15984,38 @@ declare class RTCPluginContext extends PluginContext {
|
|
|
16007
15984
|
}
|
|
16008
15985
|
|
|
16009
15986
|
/**
|
|
16010
|
-
*
|
|
15987
|
+
* 会话聊天模块
|
|
16011
15988
|
*/
|
|
16012
|
-
|
|
16013
|
-
|
|
16014
|
-
|
|
16015
|
-
|
|
16016
|
-
|
|
16017
|
-
|
|
16018
|
-
|
|
16019
|
-
|
|
16020
|
-
*/
|
|
16021
|
-
abstract get connectedTime(): number;
|
|
16022
|
-
protected readonly _appkey: string;
|
|
16023
|
-
private _rtcKVManager;
|
|
16024
|
-
/**
|
|
16025
|
-
* 会话聊天模块
|
|
16026
|
-
*/
|
|
16027
|
-
abstract get chat(): IChatService;
|
|
16028
|
-
abstract get chatroom(): IChatroomService;
|
|
16029
|
-
/**
|
|
16030
|
-
* 用户级配置模块
|
|
16031
|
-
*/
|
|
16032
|
-
abstract get userSettings(): IUserSettingsModule;
|
|
16033
|
-
abstract get naviInfo(): INaviInfo | null;
|
|
16034
|
-
get appkey(): string;
|
|
16035
|
-
get initOption(): IAPIContextOption;
|
|
16036
|
-
abstract get connectionStatus(): RCConnectionStatus;
|
|
16037
|
-
abstract get userId(): string;
|
|
16038
|
-
abstract get logger(): BasicLogger;
|
|
16039
|
-
abstract get usingCppEngine(): boolean;
|
|
16040
|
-
/**
|
|
16041
|
-
* 用户信息托管模块
|
|
16042
|
-
*/
|
|
16043
|
-
abstract get dataHosting(): IDataHostingService;
|
|
16044
|
-
/**
|
|
16045
|
-
* 引擎初始化
|
|
16046
|
-
* @param _appkey
|
|
16047
|
-
*/
|
|
16048
|
-
constructor(_watcher: IEngineWatcher, _options: IAPIContextOption);
|
|
16049
|
-
protected _rtcSignalingListener?: (buffer: Uint8Array) => void;
|
|
16050
|
-
/**
|
|
16051
|
-
* 注册 RTC KV 变更监听器
|
|
16052
|
-
* @param listener
|
|
16053
|
-
*/
|
|
16054
|
-
registerRTCSignalingListener(listener: ((buffer: Uint8Array) => void) | undefined): void;
|
|
16055
|
-
abstract refetchNaviInfo(): Promise<RCResult<INaviInfo | null>>;
|
|
16056
|
-
/**
|
|
16057
|
-
* 为非 engine 包创建 logger 工具实例
|
|
16058
|
-
*/
|
|
16059
|
-
abstract createLogger(id: string, type: LogType): BasicLogger;
|
|
16060
|
-
/**
|
|
16061
|
-
* 建立连接
|
|
16062
|
-
* @param token
|
|
16063
|
-
* @param reconnectKickEnable
|
|
16064
|
-
* @param openCallPlus
|
|
16065
|
-
* @param traceId
|
|
16066
|
-
*/
|
|
16067
|
-
abstract connect(token: string, reconnectKickEnable: boolean, openCallPlus: boolean, traceId: string): Promise<RCResult<string>>;
|
|
16068
|
-
/**
|
|
16069
|
-
* 发送 SDK 版本
|
|
16070
|
-
* @param versionInfo
|
|
16071
|
-
*/
|
|
16072
|
-
abstract reportSDKInfo(versionInfo: Record<string, string>): void;
|
|
16073
|
-
abstract getHistoryMessage(conversation: IConversationOption, options: Required<IGetHistoryMessageOption>, fromLocal: boolean): Promise<RCResult<{
|
|
16074
|
-
list: IReceivedMessage[];
|
|
16075
|
-
hasMore: boolean;
|
|
16076
|
-
}>>;
|
|
16077
|
-
abstract recallMsg(conversation: IConversationOption, recallMsgOptions: IRecallMsgOptions): Promise<RCResult<IReceivedMessage>>;
|
|
16078
|
-
abstract saveTextMessageDraft(conversation: IConversationOption, draft: string): Promise<RCResult>;
|
|
16079
|
-
/**
|
|
16080
|
-
* 获取指定会话消息草稿
|
|
16081
|
-
*/
|
|
16082
|
-
abstract getTextMessageDraft(conversation: IConversationOption): Promise<RCResult<string>>;
|
|
16083
|
-
/**
|
|
16084
|
-
* 清除指定会话消息草稿
|
|
16085
|
-
*/
|
|
16086
|
-
abstract clearTextMessageDraft(conversation: IConversationOption): Promise<RCResult>;
|
|
16087
|
-
/**
|
|
16088
|
-
* 发送消息
|
|
16089
|
-
* @param identifier 会话标识
|
|
16090
|
-
* @param options 消息发送配置
|
|
16091
|
-
* @param traceId 追踪 ID
|
|
16092
|
-
* @param onBefore 消息发送之前的回调,用于返回消息的 messageId
|
|
16093
|
-
*/
|
|
16094
|
-
abstract sendMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
16095
|
-
/**
|
|
16096
|
-
* 断开连接
|
|
16097
|
-
* @param closeDB 是否关闭数据库,默认为 true,仅 Electron 平台有效
|
|
16098
|
-
* @param disablePush 是否禁用推送,默认为 false(≥ 5.20.0)
|
|
16099
|
-
*/
|
|
16100
|
-
abstract disconnect(closeDB?: boolean, disablePush?: boolean): Promise<RCResult>;
|
|
16101
|
-
/**
|
|
16102
|
-
* 消息注册
|
|
16103
|
-
* @description
|
|
16104
|
-
* 消息注册需在应用初始化完成前进行,否则在搭配 C++ 协议栈使用时,本端发出的消息将不默认作为未知消息处理,不存储、不计数
|
|
16105
|
-
*/
|
|
16106
|
-
abstract registerMessageType(objectName: string, desc: MessageRegisterParams): void;
|
|
16107
|
-
abstract getFileToken(fileType: FileType, fileName?: string, httpMethod?: string, queryUriString?: string, url?: string, size?: number): Promise<RCResult<IUploadAuth>>;
|
|
16108
|
-
/**
|
|
16109
|
-
* 获取文件的下载地址
|
|
16110
|
-
* @param fileType 文件类型
|
|
16111
|
-
* @param serverType 使用的存储服务标识
|
|
16112
|
-
* @param fileName 文件名
|
|
16113
|
-
* @param saveName 下载后的存储文件名
|
|
16114
|
-
* @returns
|
|
16115
|
-
*/
|
|
16116
|
-
abstract getFileUrl(fileType: FileType, serverType: UploadMethod, fileName: string, originName: string): Promise<RCResult<{
|
|
16117
|
-
downloadUrl: string;
|
|
16118
|
-
}>>;
|
|
16119
|
-
/**
|
|
16120
|
-
* 创建标签
|
|
16121
|
-
* @param tag 标签
|
|
16122
|
-
*/
|
|
16123
|
-
abstract createTag(tag: ITagParam): Promise<RCResult>;
|
|
16124
|
-
/**
|
|
16125
|
-
* 删除标签
|
|
16126
|
-
* @param tagId 标签 id
|
|
16127
|
-
*/
|
|
16128
|
-
abstract removeTag(tagId: string): Promise<RCResult>;
|
|
16129
|
-
/**
|
|
16130
|
-
* 编辑标签
|
|
16131
|
-
* @param tag 标签
|
|
16132
|
-
*/
|
|
16133
|
-
abstract updateTag(tag: ITagParam): Promise<RCResult>;
|
|
16134
|
-
/**
|
|
16135
|
-
* 获取标签列表
|
|
16136
|
-
*/
|
|
16137
|
-
abstract getTagList(): Promise<RCResult<ITagInfo[]>>;
|
|
16138
|
-
/**
|
|
16139
|
-
* 获取服务器时间
|
|
16140
|
-
*/
|
|
16141
|
-
abstract get serverTime(): number;
|
|
16142
|
-
/**
|
|
16143
|
-
* 获取设备 ID
|
|
16144
|
-
*/
|
|
16145
|
-
abstract get deviceId(): string;
|
|
16146
|
-
/**
|
|
16147
|
-
* 设置推送配置
|
|
16148
|
-
* @param config 推送配置
|
|
16149
|
-
*/
|
|
16150
|
-
abstract setPushConfig(config: IAppPushConfig): void;
|
|
16151
|
-
/**
|
|
16152
|
-
* 超级群消息发送
|
|
16153
|
-
* @param targetId
|
|
16154
|
-
* @param options
|
|
16155
|
-
*/
|
|
16156
|
-
abstract sendUltraMessage(identifier: IConversationIdentifier, options: IMessageSendOptions, traceId: string, onSendBefore?: (messageId: number) => void): Promise<RCResult<IReceivedMessage>>;
|
|
16157
|
-
/**
|
|
16158
|
-
* 设置当前用户在线状态
|
|
16159
|
-
*/
|
|
16160
|
-
abstract setUserStatus(status: number): Promise<ErrorCode>;
|
|
16161
|
-
/**
|
|
16162
|
-
* 订阅用户在线状态
|
|
16163
|
-
*/
|
|
16164
|
-
abstract subscribeUserStatus(userIds: string[]): Promise<ErrorCode>;
|
|
16165
|
-
/**
|
|
16166
|
-
* 获取用户状态
|
|
16167
|
-
*/
|
|
16168
|
-
abstract getUserStatus(userId: string): Promise<RCResult<{
|
|
16169
|
-
status: string;
|
|
16170
|
-
}>>;
|
|
16171
|
-
/**
|
|
16172
|
-
* 加入黑名单
|
|
16173
|
-
*/
|
|
16174
|
-
abstract addToBlacklist(userId: string): Promise<RCResult>;
|
|
16175
|
-
/**
|
|
16176
|
-
* 将指定用户移除黑名单
|
|
16177
|
-
*/
|
|
16178
|
-
abstract removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
16179
|
-
/**
|
|
16180
|
-
* 获取黑名单列表
|
|
16181
|
-
*/
|
|
16182
|
-
abstract getBlacklist(): Promise<RCResult<string[]>>;
|
|
16183
|
-
/**
|
|
16184
|
-
* 获取指定人员在黑名单中的状态
|
|
16185
|
-
*/
|
|
16186
|
-
abstract getBlacklistStatus(userId: string): Promise<RCResult<number>>;
|
|
16187
|
-
/**
|
|
16188
|
-
* 向本地插入一条消息,不发送到服务器
|
|
16189
|
-
*/
|
|
16190
|
-
abstract insertMessage(conversation: IConversationOption, insertOptions: InnerInsertMessageParams): Promise<RCResult<IReceivedMessage>>;
|
|
16191
|
-
/**
|
|
16192
|
-
* 向本地批量插入消息
|
|
16193
|
-
* @param messages
|
|
16194
|
-
* @param checkDuplicate
|
|
16195
|
-
*/
|
|
16196
|
-
abstract batchInsertMessage(messages: IInsertMessage[], checkDuplicate: boolean): Promise<RCResult<boolean>>;
|
|
16197
|
-
/**
|
|
16198
|
-
* 删除本地消息
|
|
16199
|
-
*/
|
|
16200
|
-
abstract deleteLocalMessages(messageIds: number[]): Promise<RCResult>;
|
|
16201
|
-
/**
|
|
16202
|
-
* 通过时间戳删除本地消息
|
|
16203
|
-
*/
|
|
16204
|
-
abstract deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<RCResult>;
|
|
16205
|
-
/**
|
|
16206
|
-
* 通过时间戳批量清除本地消息
|
|
16207
|
-
*/
|
|
16208
|
-
abstract batchClearLocalMessagesByTimestamp(options: IClearMessageOption[]): Promise<RCResult>;
|
|
16209
|
-
/**
|
|
16210
|
-
* 清空会话下历史消息
|
|
16211
|
-
*/
|
|
16212
|
-
abstract clearLocalMessages(conversation: IConversationOption): Promise<RCResult>;
|
|
16213
|
-
/**
|
|
16214
|
-
* 获取消息
|
|
16215
|
-
*/
|
|
16216
|
-
abstract getMessage(messageId: number | string): Promise<RCResult<IReceivedMessage>>;
|
|
16217
|
-
/**
|
|
16218
|
-
* 设置消息内容
|
|
16219
|
-
*/
|
|
16220
|
-
abstract setMessageContent(messageId: number, content: any, messageType: string): Promise<RCResult>;
|
|
16221
|
-
/**
|
|
16222
|
-
* 设置消息搜索字段
|
|
16223
|
-
*/
|
|
16224
|
-
abstract setMessageSearchField(messageId: number, content: any, searchFiles: string): Promise<ErrorCode>;
|
|
16225
|
-
/**
|
|
16226
|
-
* 通过关键字搜索所有会话
|
|
16227
|
-
*/
|
|
16228
|
-
abstract searchConversationByContentWithAllChannel(keyword: string, messageTypes: string[], conversationTypes: ConversationType[]): Promise<RCResult<IReceivedConversation[]>>;
|
|
16229
|
-
abstract searchMessagesWithParams(params: ISearchMessageParams): Promise<RCResult<ISearchMessagesResult>>;
|
|
16230
|
-
/**
|
|
16231
|
-
* 设置消息发送状态
|
|
16232
|
-
*/
|
|
16233
|
-
abstract setMessageSentStatus(messageId: number, sentStatus: number): Promise<RCResult>;
|
|
16234
|
-
/**
|
|
16235
|
-
* 设置消息接收状态
|
|
16236
|
-
*/
|
|
16237
|
-
abstract setMessageReceivedStatus(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
15989
|
+
interface IChatService extends Pick<IIPCMethods, 'getTotalUnreadCount' | 'getConversation' | 'batchSetConversationToTop' | 'batchSetConversationNotificationLevel' | 'getConversationNotificationLevel' | 'setConversationTypeNotificationLevel' | 'getConversationTypeNotificationLevel' | 'clearAllSGUnreadCount' | 'deleteRemoteMessage' | 'deleteRemoteMessageByTimestamp' | 'batchClearRemoteHistoryMessages' | 'sendReadReceiptResponseV5' | 'getMessageReadReceiptInfoV5ByIdentifiers' | 'getMessagesReadReceiptUsersByPageV5' | 'getMessagesReadReceiptByUsersV5' | 'searchConversationByContent' | 'requestSpeechToTextForMessage' | 'setMessageSpeechToTextVisible' | 'addTagForConversations' | 'getTagsForConversation' | 'setConversationStatusInTag' | 'removeTagForConversations' | 'removeTagsForConversation' | 'getConversationListByTag' | 'getUnreadCountByTag' | 'getUntaggedConversationListByPage' | 'batchSetConversationTranslateStrategy' | 'modifyMessageWithParams' | 'refreshReferenceMessageWithParams' | 'batchDeleteConversations' | 'sendReadReceiptV2' | 'syncRemoteConversations' | 'sendUltraGroupTypingStatus' | 'getUltraGroupList' | 'getRemoteMessagesByUIds' | 'getUGUnreadMentionedDigest' | 'getHistoryMessagesByObjectNames' | 'getContinuousMessages' | 'getMessagesAroundTimestamp' | 'deleteLocalUGMessagesForAllChannel' | 'updateUGMessageExpansion' | 'setUGDefaultNotificationLevel' | 'getUGDefaultNotificationLevel' | 'getUnreadMentionedMessages' | 'getUnreadMentionedCount' | 'getAllUnreadMentionedCount' | 'getTotalUnreadCountByLevels' | 'getConversationUnreadCount' | 'getFirstUnreadMessage' | 'getFirstUnreadMessageDigest' | 'getUGUnreadCountForAllChannels' | 'getUGUnreadInfoList' | 'getUGFirstUnreadMessageDigest' | 'getConversations' | 'clearConversationUnreadCount' | 'markRemoteConversationAsRead' | 'getTopConversationList' | 'getUnreadConversationList' | 'getConversationListByPageIndex' | 'getAllConversationList' | 'getConversationListByTimestamp' | 'clearConversations' | 'getBlockedConversationList' | 'getBlockedUGList' | 'saveEditedMessageDraft' | 'getEditedMessageDraft' | 'clearEditedMessageDraft' | 'getUnreadMentionMeConversationList' | 'sendUltraGroupTypingStatus' | 'updateConversationReadTime' | 'clearUnreadCountByTimestamp' | 'getMessageReader' | 'getMessageReadReceiptV4' | 'sendReadReceiptMessageV4' | 'getConversationsIncludingRobots'> {
|
|
15990
|
+
/** 超级群是否已同步完成 */
|
|
15991
|
+
get ugSynced(): boolean;
|
|
15992
|
+
getRealtimeConversations(count: number, startTime: number, order: 0 | 1): Promise<RCResult<IReceivedConversation[]>>;
|
|
15993
|
+
getRealtimeConTotalUnreadCount(): Promise<RCResult<number>>;
|
|
15994
|
+
clearRealtimeConUnreadCount(identifier: IConversationIdentifier): Promise<RCResult>;
|
|
15995
|
+
removeRealtimeConversations(identifiers: IConversationIdentifier[]): Promise<RCResult>;
|
|
15996
|
+
batchGetRealtimeConUnreadCount(identifiers: IConversationIdentifier[]): Promise<RCResult<IConversationUnreadCount[]>>;
|
|
16238
15997
|
/**
|
|
16239
|
-
*
|
|
15998
|
+
* 分页加载会话列表
|
|
15999
|
+
* @param pageToken 分页 token
|
|
16000
|
+
* @param count 分页数量
|
|
16001
|
+
* @param options 会话列表加载器选项,仅 pageToken 无值时有效
|
|
16240
16002
|
*/
|
|
16241
|
-
|
|
16242
|
-
|
|
16243
|
-
|
|
16244
|
-
|
|
16003
|
+
loadConversationList(pageToken: string, count: number, options: IConversationListLoaderOptions): Promise<RCResult<{
|
|
16004
|
+
pageToken: string;
|
|
16005
|
+
finished: boolean;
|
|
16006
|
+
list: IReceivedConversation[];
|
|
16245
16007
|
}>>;
|
|
16246
|
-
abstract clearLocalData(): Promise<RCResult<boolean>>;
|
|
16247
|
-
/**
|
|
16248
|
-
* 获取运行时的系统信息,仅限 Electron 平台可用
|
|
16249
|
-
*/
|
|
16250
|
-
abstract getOSInfo(): Promise<RCResult<IOSInfo>>;
|
|
16251
|
-
/**
|
|
16252
|
-
* 获取当前渲染进程信息,仅限 Electron 平台可用
|
|
16253
|
-
*/
|
|
16254
|
-
abstract getProcessInfo(): Promise<RCResult<IProcessInfo>>;
|
|
16255
|
-
/**
|
|
16256
|
-
* 获取应用主进程信息,仅限 Electron 平台可用
|
|
16257
|
-
*/
|
|
16258
|
-
abstract getMainProcessInfo(): Promise<RCResult<IProcessInfo>>;
|
|
16259
|
-
/**
|
|
16260
|
-
* 设置融云消息重排开关
|
|
16261
|
-
*/
|
|
16262
|
-
abstract setCheckDuplicateMessage(enableCheck: boolean): Promise<RCResult<boolean>>;
|
|
16263
|
-
/**
|
|
16264
|
-
* RTC 通用调用接口
|
|
16265
|
-
* 在非 Comet 协议下,入参 sourceData 应为 ArrayBuffer 数据,返回结果为 Uint8Array 数据
|
|
16266
|
-
* @param roomId 房间 ID
|
|
16267
|
-
* @param method CMP 接口方法名
|
|
16268
|
-
* @param isQuery 使用 `qry` or `pub` 进行请求,按服务要求传递
|
|
16269
|
-
* @param sourceData PB 数据
|
|
16270
|
-
*/
|
|
16271
|
-
abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer): Promise<RCResult<Uint8Array>>;
|
|
16272
|
-
abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<RCResult<any>>;
|
|
16273
|
-
pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<RCResult<number>>;
|
|
16274
16008
|
/**
|
|
16275
|
-
*
|
|
16276
|
-
*/
|
|
16277
|
-
protected _receiveRtcKv(buffer: Uint8Array): void;
|
|
16278
|
-
/**
|
|
16279
|
-
* Engine 反初始化
|
|
16280
|
-
*/
|
|
16281
|
-
destroy(): void;
|
|
16282
|
-
/**
|
|
16283
|
-
* 设置代理
|
|
16284
|
-
*/
|
|
16285
|
-
abstract setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
16286
|
-
/**
|
|
16287
|
-
* 获取代理
|
|
16288
|
-
*/
|
|
16289
|
-
abstract getProxy(): Promise<RCResult<IProxy>>;
|
|
16290
|
-
/**
|
|
16291
|
-
* 测试代理
|
|
16292
|
-
*/
|
|
16293
|
-
abstract testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
16294
|
-
/**
|
|
16295
|
-
* 设置当前网络
|
|
16296
|
-
*/
|
|
16297
|
-
abstract setNetwork(data: INetwork, isUnPrintLog?: boolean): void;
|
|
16298
|
-
/**
|
|
16299
|
-
* 订阅用户状态事件
|
|
16300
|
-
*/
|
|
16301
|
-
abstract subscribeUser(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
16302
|
-
/**
|
|
16303
|
-
* 取消订阅用户状态事件
|
|
16304
|
-
*/
|
|
16305
|
-
abstract unSubscribeUser(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
16306
|
-
/**
|
|
16307
|
-
* 获取已订阅列表
|
|
16308
|
-
*/
|
|
16309
|
-
abstract getSubscribeUserList(subscribeType: SubscribeType, count: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
16310
|
-
/**
|
|
16311
|
-
* 获取指定用户的在线状态
|
|
16312
|
-
*/
|
|
16313
|
-
abstract getSubscribeUserStatus(subscribeType: SubscribeType, userIds: string[]): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
16314
|
-
abstract updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
16315
|
-
abstract getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
16316
|
-
abstract getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
16317
|
-
abstract setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>;
|
|
16318
|
-
abstract removeNotificationQuietHoursSetting(): Promise<RCResult>;
|
|
16319
|
-
abstract getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>;
|
|
16320
|
-
/**
|
|
16321
|
-
* 获取统计地址
|
|
16009
|
+
* 批量获取消息已读回执信息,暂仅支持群聊 (V4)
|
|
16322
16010
|
*/
|
|
16323
|
-
|
|
16324
|
-
abstract translateWithParams(list: InnerTransParam[], mode: TranslateMode, force: boolean, from: 0 | 1): Promise<RCResult>;
|
|
16325
|
-
abstract getLocalMessageCount(conversation: IConversationOption): Promise<RCResult<number>>;
|
|
16326
|
-
abstract getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCResult<ISubscribeUserOnlineStatus[]>>;
|
|
16327
|
-
abstract getAllRobots(): Promise<RCResult<IRobotInfo[]>>;
|
|
16011
|
+
batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
16328
16012
|
}
|
|
16329
16013
|
|
|
16014
|
+
/**
|
|
16015
|
+
* 用户设置模块
|
|
16016
|
+
*/
|
|
16017
|
+
declare type IUserSettingsModule = Pick<IIPCMethods, 'setTranslationLanguage' | 'getTranslationLanguage' | 'setAutoTranslateEnabled' | 'getAutoTranslateEnabled'>;
|
|
16018
|
+
|
|
16330
16019
|
/**
|
|
16331
16020
|
* 流式消息数据拉取响应事件类型
|
|
16332
16021
|
* @category Enum
|
|
@@ -16449,4 +16138,4 @@ declare const assert: (key: string, value: any, validator: AssertRules | ((value
|
|
|
16449
16138
|
*/
|
|
16450
16139
|
declare const validate: (key: string, value: any, validator: AssertRules | ((value?: any) => boolean), required?: boolean) => boolean;
|
|
16451
16140
|
|
|
16452
|
-
export { APIContext, AbsCodec, AppSettings, AreaCode, AssertRules,
|
|
16141
|
+
export { APIContext, AbsCodec, AppSettings, AreaCode, AssertRules, BasicLogger, ChatroomEntryType, ChatroomSyncStatusReason, ChatroomUserChangeType, ChrmMemBanType, ChrmMemOperateType, ChrmSyncStatus, Codec, CodecPBMaps, ConnectionStatus, ConversationBatchDeletionParams, ConversationListLoader, ConversationType, DataHosting, DirectionType, EnableLogL, ErrorCode, EventEmitter, FileType, FilterRobotType, FriendAddPermission, FriendApplicationStatus, FriendApplicationType, FriendRelationType, GroupApplicationDirection, GroupApplicationStatus, GroupApplicationType, GroupInviteHandlePermission, GroupJoinPermission, GroupMemberInfoEditPermission, GroupMemberRole, GroupOperation, GroupOperationPermission, GroupOperationRole, GroupOperationStatus, GroupOperationType, GroupReadReceiptVersion, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAppPushConfig, IAsyncRes, IAuditInfoKeyInMessage, IAuditInfoValueInMessage, IBlockedMessageInfo, IChannelAndUserGroupChangeData, IChatRoomEntries, IChatRoomEntry, IChatService, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomErrorKeys, IChatroomInfo, IChatroomJoinResponse, IChatroomListener, IChatroomListenerData, IChatroomNotifyBan, IChatroomNotifyBlock, IChatroomNotifyMultiLoginSync, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomService, IChatroomUser, IChatroomUserChangeInfo, IClearMessageOption, ICombineMessageContent, ICombineV2MessageContent, ICombinedMessage, ICommandMessageContent, IConnectionStatusListener, IConversationFilter, IConversationIdentifier, IConversationListLoaderOptions, IConversationOption, IConversationStateListener, IConversationTag, IConversationTagFilter, IConversationTagListener, IConversationUnreadCount, IConvertHQVoiceMessageToTextOption, IConvertSpeechToTextOption, IConvertVoiceMessageToTextOption, ICreateGroupFail, IDataHostingService, IDeletedExpansion, IDownloadAuth, IEditedMessageDraft, IEnginRefreshReferenceMessageResult, IEngineWatcher, IErrorKeys, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraDataKeyInMessage, IFileMessageContent, IFirstUnreadMessageInfo, IFollowsInfo, IFriendAdd, IFriendApplicationInfo, IFriendApplicationStatusChange, IFriendDelete, IFriendInfo, IFriendInfoChangedSync, IFriendRelationInfo, IGIFMessageContent, IGetConversationListByTimestampParams, IGetConversationsIncludingRobotsOption, IGetGroupMembersOption, IGetHistoryMessageOption, IGetHistoryMessageResult, IGetHistoryMessagesByTypesOption, IGetUltraGroupListOption, IGetUnreadMentionMeConversationListParams, IGooglePushConfig, IGroupApplicationInfo, IGroupFollowsChangedSync, IGroupFollowsList, IGroupFollowsUserInfo, IGroupInfo, IGroupInfoChanged, IGroupInfoOption, IGroupMemberInfo, IGroupMemberInfoChanged, IGroupMembers, IGroupNotificationMessageContent, IGroupOperationInfo, IGroupReadReceiptData, IGroupRemarkChangedSync, IHQVoiceMessageContent, IHarmonyOSPushConfig, IIPCMethods, IIPCMethodsSync, IIPCMethodsWithoutResult, IImageMessageContent, IInformationNotificationMessageContent, IInsertMessage, ILocalTagStatus, ILocationMessageContent, ILogData, ILogger, IMemberInviteResponse, IMentionedInfoKeyInMessage, IMessageAttrsForUpdateExpansion, IMessageDesc, IMessageExtraData, IMessageFilter, IMessageIdentifier, IMessageListnenr, IMessageReadReceiptV4Response, IMessageReader, IMessageReaderResponse, IMessageSendOptions, IModifyMessageParams, INaviInfo, INetwork, INotificationQuietHoursSetting, IOSInfo, IOperateInfo, IOperateStatusNotify, IOperateSummary, IPagingQueryOption, IPagingQueryResult, IPlatformOnlineStatus, IPluginGenerator, IPrivateReadReceiptData, IProcessCache, IProcessCode, IProcessInfo, IPromiseResult, IProxy, IPushConfig, IQuitGroupConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCUsers, IReadReceiptData, IReadReceiptInfo, IReadReceiptResponseInfo, IRecallCommandMessageContent, IRecallMsgOptions, IRecallNotificationMessageContent, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRefreshReferenceMessageParams, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IRequest, IResponse, IRichContentMessageContent, IRobotInfo, IRuntime, ISearchMessageParams, ISearchMessagesResult, ISendMsgOptions, IServerGroupBaseInfo, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStorage, IStreamMessageContent, IStreamMessageResponseChunkData, IStreamMessageResponseEventData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagListener, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IUserSettingsModule, IVoiceMessageContent, IWatcher, IiOSPushConfig, InnerInsertMessageParams, InnerTransParam, InterruptionLevel, ItypingStateListener, KVString, LogDBProxy, LogL, LogLevel, LogSource, Log as LogTagId, LogType, MAX_MESSAGE_CONTENT_BYTES, MAX_U32_INTEGER, MAX_UPLOAD_FILE_SIZE, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageRegisterParams, MessageType, MessageTypeDescription, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Codec$1 as PBCodec, Platform, PluginContext, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, RTCApiType, RTCJoinType, RTCMode, RTCPluginContext, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SSEModule, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, SuspendablePromise, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UPLOAD_FILE_CHUNK_SIZE, UUId, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, Validator, VersionManage, assert, createLogDBProxy, fail, fixUrlProtocol, forEach, getMessageTypeDescription, getUUID, getUUID22, hasMessageTypeDescription, httpRequest, isArray, isBoolean, isFunction, isHttpUrl, isInteger, isLimitedString, isNull, isNumber, isObject, isString, isUndefined, isValidConversationType, isValidEnum, isValidFileType, isValidGroupId, isValidTargetId, map, notEmptyArray, notEmptyObject, notEmptyString, ok, promiseWithResolvers, runtime, trans2IReceivedStatusInfo, trans2NotificationLevel, trans2NotificationStatus, transformReceivedStatusFlag, usingCppEngine, validate };
|