@rongcloud/imlib-next 5.30.0-c-tmp-alpha.2 → 5.32.0-c-rtc-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 +589 -679
- 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,
|
|
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,
|
|
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';
|
|
3
3
|
|
|
4
4
|
/** [EN]
|
|
5
5
|
* Thumbnail configuration
|
|
@@ -116,7 +116,7 @@ declare class UploadTask {
|
|
|
116
116
|
abort(): void;
|
|
117
117
|
private _uploadInLoop;
|
|
118
118
|
private _handleUpload;
|
|
119
|
-
awaitResult(): Promise<
|
|
119
|
+
awaitResult(): Promise<RCResult<IUploadResult>>;
|
|
120
120
|
}
|
|
121
121
|
|
|
122
122
|
/** [EN]
|
|
@@ -125,7 +125,6 @@ declare class UploadTask {
|
|
|
125
125
|
* @category Basic
|
|
126
126
|
* @param plugins Plugin generator
|
|
127
127
|
* @param options Plugin configuration
|
|
128
|
-
|
|
129
128
|
*/
|
|
130
129
|
/**
|
|
131
130
|
* 装载 plugin 插件
|
|
@@ -179,7 +178,6 @@ declare function removeMonitor(id: number): void;
|
|
|
179
178
|
* const res = await RongIMLib.connect(token);
|
|
180
179
|
* console.info('IM connection result:', res);
|
|
181
180
|
* ```
|
|
182
|
-
|
|
183
181
|
*/
|
|
184
182
|
/**
|
|
185
183
|
* 建立 IM 连接
|
|
@@ -200,7 +198,7 @@ declare function removeMonitor(id: number): void;
|
|
|
200
198
|
* console.info('建立 IM 连接结果:', res);
|
|
201
199
|
* ```
|
|
202
200
|
*/
|
|
203
|
-
declare function connect(token: string, reconnectKickEnable?: boolean): Promise<
|
|
201
|
+
declare function connect(token: string, reconnectKickEnable?: boolean): Promise<RCResult<{
|
|
204
202
|
userId: string;
|
|
205
203
|
}>>;
|
|
206
204
|
/** [EN]
|
|
@@ -1027,7 +1025,6 @@ interface ISendMessageOptions {
|
|
|
1027
1025
|
* 1. Status messages only have pub, no ack response
|
|
1028
1026
|
* 2. Status messages are not stored or counted by default, and the `isPersisted` and `isCounted` configurations will be invalid
|
|
1029
1027
|
* @deprecated Please set whether the message type is a status message when registering the message
|
|
1030
|
-
|
|
1031
1028
|
*/
|
|
1032
1029
|
/**
|
|
1033
1030
|
* 是否是状态消息,一般为无需注册的自定义消息
|
|
@@ -1584,7 +1581,6 @@ interface IRefreshReferenceMessageResult {
|
|
|
1584
1581
|
/** [EN]
|
|
1585
1582
|
* Event listener
|
|
1586
1583
|
* @category Type
|
|
1587
|
-
|
|
1588
1584
|
*/
|
|
1589
1585
|
/**
|
|
1590
1586
|
* 事件监听器
|
|
@@ -1694,7 +1690,6 @@ declare function addEventListener<T extends Events>(eventType: T, listener: Even
|
|
|
1694
1690
|
* console.log('Connection established');
|
|
1695
1691
|
* });
|
|
1696
1692
|
* ```
|
|
1697
|
-
|
|
1698
1693
|
*/
|
|
1699
1694
|
/**
|
|
1700
1695
|
* 添加监听器 (仅执行一次)
|
|
@@ -1723,7 +1718,6 @@ declare function onceEventListener<T extends Events>(eventType: T, listener: Eve
|
|
|
1723
1718
|
* const listener = (evt) => console.log(evt.messages)
|
|
1724
1719
|
* RongIMLib.removeEventListener(Events.MESSAGES, listener);
|
|
1725
1720
|
* ```
|
|
1726
|
-
|
|
1727
1721
|
*/
|
|
1728
1722
|
/**
|
|
1729
1723
|
* 移除事件
|
|
@@ -1749,7 +1743,6 @@ declare function removeEventListener<T extends Events>(eventType: T, listener: E
|
|
|
1749
1743
|
* ```ts
|
|
1750
1744
|
* RongIMLib.removeEventListeners(Events.MESSAGES);
|
|
1751
1745
|
* ```
|
|
1752
|
-
|
|
1753
1746
|
*/
|
|
1754
1747
|
/**
|
|
1755
1748
|
* 移除同一类型下的所有事件
|
|
@@ -2294,7 +2287,6 @@ declare function getUltraGroupUnreadInfoList(targetIds: string[]): Promise<RCRes
|
|
|
2294
2287
|
* const res = await RongIMLib.addToBlacklist(userId);
|
|
2295
2288
|
* console.log('blacklist addition result:', res);
|
|
2296
2289
|
* ```
|
|
2297
|
-
|
|
2298
2290
|
*/
|
|
2299
2291
|
/**
|
|
2300
2292
|
* 加入黑名单
|
|
@@ -2314,7 +2306,7 @@ declare function getUltraGroupUnreadInfoList(targetIds: string[]): Promise<RCRes
|
|
|
2314
2306
|
* console.log('加入黑名单结果:', res);
|
|
2315
2307
|
* ```
|
|
2316
2308
|
*/
|
|
2317
|
-
declare function addToBlacklist(userId: string): Promise<
|
|
2309
|
+
declare function addToBlacklist(userId: string): Promise<RCResult>;
|
|
2318
2310
|
/** [EN]
|
|
2319
2311
|
* Remove from blacklist
|
|
2320
2312
|
* @description This feature is currently limited to the Electron solution. After removing a user from the blacklist, the user will resume receiving any one-to-one chat messages from the previously blocked user.
|
|
@@ -2343,7 +2335,7 @@ declare function addToBlacklist(userId: string): Promise<IAsyncRes<void>>;
|
|
|
2343
2335
|
* console.log('移出黑名单结果:', res);
|
|
2344
2336
|
* ```
|
|
2345
2337
|
*/
|
|
2346
|
-
declare function removeFromBlacklist(userId: string): Promise<
|
|
2338
|
+
declare function removeFromBlacklist(userId: string): Promise<RCResult>;
|
|
2347
2339
|
/** [EN]
|
|
2348
2340
|
* Get blacklist
|
|
2349
2341
|
* @description This feature is currently only available in the Electron solution for retrieving the blacklist.
|
|
@@ -2370,7 +2362,7 @@ declare function removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>;
|
|
|
2370
2362
|
* console.log('获取黑名单列表结果:', res);
|
|
2371
2363
|
* ```
|
|
2372
2364
|
*/
|
|
2373
|
-
declare function getBlacklist(): Promise<
|
|
2365
|
+
declare function getBlacklist(): Promise<RCResult<string[]>>;
|
|
2374
2366
|
/** [EN]
|
|
2375
2367
|
* Check if a user is in the blacklist
|
|
2376
2368
|
* @description This feature is currently limited to the Electron solution and is used to check if a user is in the blacklist.
|
|
@@ -2384,7 +2376,6 @@ declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
|
|
|
2384
2376
|
* const res = await RongIMLib.getBlacklistStatus(userId);
|
|
2385
2377
|
* console.log('blacklist retrieval result:', res);
|
|
2386
2378
|
* ```
|
|
2387
|
-
|
|
2388
2379
|
*/
|
|
2389
2380
|
/**
|
|
2390
2381
|
* 查询用户是否在黑名单中
|
|
@@ -2400,253 +2391,7 @@ declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
|
|
|
2400
2391
|
* console.log('获取黑名单列表结果:', res);
|
|
2401
2392
|
* ```
|
|
2402
2393
|
*/
|
|
2403
|
-
declare function getBlacklistStatus(userId: string): Promise<
|
|
2404
|
-
|
|
2405
|
-
/** [EN]
|
|
2406
|
-
* TODO(Translation)
|
|
2407
|
-
* @category Interface
|
|
2408
|
-
*/
|
|
2409
|
-
/**
|
|
2410
|
-
* @deprecated - 已废弃,请使用 `ICombineMessageContent` 替代
|
|
2411
|
-
* @category Interface
|
|
2412
|
-
*/
|
|
2413
|
-
declare type ICombineMessageBody = ICombineMessageContent;
|
|
2414
|
-
|
|
2415
|
-
/** [EN]
|
|
2416
|
-
* TODO(Translation)
|
|
2417
|
-
*/
|
|
2418
|
-
/**
|
|
2419
|
-
* 合并转发消息类型
|
|
2420
|
-
*/
|
|
2421
|
-
declare class CombineMessage extends BuiltinMessage<ICombineMessageContent> {
|
|
2422
|
-
constructor(content: ICombineMessageContent);
|
|
2423
|
-
}
|
|
2424
|
-
|
|
2425
|
-
/**
|
|
2426
|
-
* 合并转发消息 v2 版本 Content 结构
|
|
2427
|
-
* @category Type
|
|
2428
|
-
* @hidden
|
|
2429
|
-
* @deprecated - 已废弃,请使用 `ICombineV2MessageContent` 替代
|
|
2430
|
-
*/
|
|
2431
|
-
declare type CombineV2MessageContent = ICombineV2MessageContent;
|
|
2432
|
-
|
|
2433
|
-
/**
|
|
2434
|
-
* 合并转发消息 v2 版本
|
|
2435
|
-
* @since 5.22.0
|
|
2436
|
-
*/
|
|
2437
|
-
declare class CombineV2Message extends BuiltinMessage<ICombineV2MessageContent> {
|
|
2438
|
-
constructor(content: ICombineV2MessageContent);
|
|
2439
|
-
}
|
|
2440
|
-
|
|
2441
|
-
/** [EN]
|
|
2442
|
-
* TODO(Translation)
|
|
2443
|
-
*/
|
|
2444
|
-
/**
|
|
2445
|
-
* 命令消息
|
|
2446
|
-
* @category Interface
|
|
2447
|
-
* @deprecated - 已废弃,请使用 `ICommandMessageContent` 替代
|
|
2448
|
-
*/
|
|
2449
|
-
declare type ICommandMessageBody = ICommandMessageContent;
|
|
2450
|
-
|
|
2451
|
-
/** [EN]
|
|
2452
|
-
* TODO(Translation)
|
|
2453
|
-
*/
|
|
2454
|
-
/**
|
|
2455
|
-
* 命令消息类型
|
|
2456
|
-
*/
|
|
2457
|
-
declare class CommandMessage extends BuiltinMessage<ICommandMessageContent> {
|
|
2458
|
-
constructor(content: ICommandMessageContent);
|
|
2459
|
-
}
|
|
2460
|
-
|
|
2461
|
-
/** [EN]
|
|
2462
|
-
* TODO(Translation)
|
|
2463
|
-
*/
|
|
2464
|
-
/**
|
|
2465
|
-
* 文件消息
|
|
2466
|
-
* @category Interface
|
|
2467
|
-
* @deprecated - 已废弃,请使用 `IFileMessageContent` 替代
|
|
2468
|
-
*/
|
|
2469
|
-
declare type IFileMessageBody = IFileMessageContent;
|
|
2470
|
-
|
|
2471
|
-
declare class FileMessage extends BuiltinMessage<IFileMessageContent> {
|
|
2472
|
-
constructor(content: IFileMessageContent);
|
|
2473
|
-
}
|
|
2474
|
-
|
|
2475
|
-
/** [EN]
|
|
2476
|
-
* @category Interface
|
|
2477
|
-
* @deprecated Please use `IGIFMessageContent` instead.
|
|
2478
|
-
*/
|
|
2479
|
-
/**
|
|
2480
|
-
* @category Interface
|
|
2481
|
-
* @deprecated - 已废弃,请使用 `IGIFMessageContent` 替代
|
|
2482
|
-
*/
|
|
2483
|
-
declare type IGIFMessageBody = IGIFMessageContent;
|
|
2484
|
-
|
|
2485
|
-
declare class GIFMessage extends BuiltinMessage<IGIFMessageContent> {
|
|
2486
|
-
constructor(content: IGIFMessageContent);
|
|
2487
|
-
}
|
|
2488
|
-
|
|
2489
|
-
/** [EN]
|
|
2490
|
-
* @category Interface
|
|
2491
|
-
* @deprecated Please use `IGroupNotificationMessageContent` instead.
|
|
2492
|
-
*/
|
|
2493
|
-
/**
|
|
2494
|
-
* 群组通知消息
|
|
2495
|
-
* @category Interface
|
|
2496
|
-
* @deprecated - 已废弃,请使用 `IGroupNotificationMessageContent` 替代
|
|
2497
|
-
*/
|
|
2498
|
-
declare type IGroupNotificationMessageBody = IGroupNotificationMessageContent;
|
|
2499
|
-
|
|
2500
|
-
declare class GroupNotificationMessage extends BuiltinMessage<IGroupNotificationMessageBody> {
|
|
2501
|
-
constructor(content: IGroupNotificationMessageBody);
|
|
2502
|
-
}
|
|
2503
|
-
|
|
2504
|
-
/** [EN]
|
|
2505
|
-
* Image message
|
|
2506
|
-
* @category Interface
|
|
2507
|
-
*/
|
|
2508
|
-
/**
|
|
2509
|
-
* 图片消息
|
|
2510
|
-
* @category Interface
|
|
2511
|
-
* @deprecated - 已废弃,请使用 `IImageMessageContent` 替代
|
|
2512
|
-
*/
|
|
2513
|
-
declare type IImageMessageBody = IImageMessageContent;
|
|
2514
|
-
|
|
2515
|
-
declare class ImageMessage extends BuiltinMessage<IImageMessageContent> {
|
|
2516
|
-
constructor(content: IImageMessageContent);
|
|
2517
|
-
}
|
|
2518
|
-
|
|
2519
|
-
/** [EN]
|
|
2520
|
-
* Gray bar message
|
|
2521
|
-
* @category Interface
|
|
2522
|
-
*/
|
|
2523
|
-
/**
|
|
2524
|
-
* 小灰条消息
|
|
2525
|
-
* @category Interface
|
|
2526
|
-
* @deprecated - 已废弃,请使用 `IInformationNotificationMessageContent` 替代
|
|
2527
|
-
*/
|
|
2528
|
-
declare type IInformationNotificationMessageBody = IInformationNotificationMessageContent;
|
|
2529
|
-
|
|
2530
|
-
declare class InformationNotificationMessage extends BuiltinMessage<IInformationNotificationMessageContent> {
|
|
2531
|
-
constructor(content: IInformationNotificationMessageContent);
|
|
2532
|
-
}
|
|
2533
|
-
|
|
2534
|
-
/** [EN]
|
|
2535
|
-
* Local message content data
|
|
2536
|
-
* @category Interface
|
|
2537
|
-
*/
|
|
2538
|
-
/**
|
|
2539
|
-
* 位置消息数据
|
|
2540
|
-
* @category Interface
|
|
2541
|
-
* @deprecated - 已废弃,请使用 `ILocationMessageContent` 替代
|
|
2542
|
-
*/
|
|
2543
|
-
declare type ILocationMessageBody = ILocationMessageContent;
|
|
2544
|
-
|
|
2545
|
-
/**
|
|
2546
|
-
* 位置消息
|
|
2547
|
-
*/
|
|
2548
|
-
declare class LocationMessage extends BuiltinMessage<ILocationMessageContent> {
|
|
2549
|
-
constructor(content: ILocationMessageContent);
|
|
2550
|
-
}
|
|
2551
|
-
|
|
2552
|
-
/** [EN]
|
|
2553
|
-
* Quote message content data
|
|
2554
|
-
* @category Interface
|
|
2555
|
-
*/
|
|
2556
|
-
/**
|
|
2557
|
-
* 引用消息
|
|
2558
|
-
* @category Interface
|
|
2559
|
-
* @deprecated - 已废弃,请使用 `IReferenceMessageContent` 替代
|
|
2560
|
-
*/
|
|
2561
|
-
declare type IReferenceMessageBody = IReferenceMessageContent;
|
|
2562
|
-
|
|
2563
|
-
declare class ReferenceMessage extends BuiltinMessage<IReferenceMessageContent> {
|
|
2564
|
-
constructor(content: IReferenceMessageContent);
|
|
2565
|
-
}
|
|
2566
|
-
|
|
2567
|
-
/** [EN]
|
|
2568
|
-
* Rich text message
|
|
2569
|
-
* @category Interface
|
|
2570
|
-
*/
|
|
2571
|
-
/**
|
|
2572
|
-
* 富文本消息
|
|
2573
|
-
* @category Interface
|
|
2574
|
-
* @deprecated - 已废弃,请使用 `IRichContentMessageContent` 替代
|
|
2575
|
-
*/
|
|
2576
|
-
declare type IRichContentMessageBody = IRichContentMessageContent;
|
|
2577
|
-
|
|
2578
|
-
declare class RichContentMessage extends BuiltinMessage<IRichContentMessageContent> {
|
|
2579
|
-
constructor(content: IRichContentMessageContent);
|
|
2580
|
-
}
|
|
2581
|
-
|
|
2582
|
-
/** [EN]
|
|
2583
|
-
* Short video message content data
|
|
2584
|
-
* @category Interface
|
|
2585
|
-
*/
|
|
2586
|
-
/**
|
|
2587
|
-
* 短视频消息 content 数据
|
|
2588
|
-
* @deprecated - 已废弃,请使用 `ISightMessageContent` 替代
|
|
2589
|
-
* @category Interface
|
|
2590
|
-
*/
|
|
2591
|
-
declare type ISightMessageBody = ISightMessageContent;
|
|
2592
|
-
|
|
2593
|
-
/** [EN]
|
|
2594
|
-
* Short video message
|
|
2595
|
-
*/
|
|
2596
|
-
/**
|
|
2597
|
-
* 短视频消息
|
|
2598
|
-
*/
|
|
2599
|
-
declare class SightMessage extends BuiltinMessage<ISightMessageBody> {
|
|
2600
|
-
constructor(content: ISightMessageBody);
|
|
2601
|
-
}
|
|
2602
|
-
|
|
2603
|
-
/**
|
|
2604
|
-
* 流式消息内容结构
|
|
2605
|
-
* @category Interface
|
|
2606
|
-
* @deprecated - 已废弃,请使用 `IStreamMessageContent` 替代
|
|
2607
|
-
*/
|
|
2608
|
-
declare type IStreamMessageBody = IStreamMessageContent;
|
|
2609
|
-
|
|
2610
|
-
/** [EN]
|
|
2611
|
-
* Text message content data
|
|
2612
|
-
* @category Interface
|
|
2613
|
-
*/
|
|
2614
|
-
/**
|
|
2615
|
-
* 文本消息 content 数据
|
|
2616
|
-
* @deprecated - 已废弃,请使用 `ITextMessageContent` 替代
|
|
2617
|
-
* @category Interface
|
|
2618
|
-
*/
|
|
2619
|
-
declare type ITextMessageBody = ITextMessageContent;
|
|
2620
|
-
|
|
2621
|
-
declare class TextMessage extends BuiltinMessage<ITextMessageContent> {
|
|
2622
|
-
constructor(content: ITextMessageContent);
|
|
2623
|
-
}
|
|
2624
|
-
|
|
2625
|
-
/** [EN]
|
|
2626
|
-
* Voice Message content data
|
|
2627
|
-
* @category Interface
|
|
2628
|
-
*/
|
|
2629
|
-
/**
|
|
2630
|
-
* 高清语音消息 content 数据
|
|
2631
|
-
* @category Interface
|
|
2632
|
-
* @deprecated - 已废弃,使用 IHQVoiceMessageContent 代替
|
|
2633
|
-
*/
|
|
2634
|
-
declare type IHQVoiceMessageBody = IHQVoiceMessageContent;
|
|
2635
|
-
/**
|
|
2636
|
-
* 高清语音消息类型
|
|
2637
|
-
*/
|
|
2638
|
-
declare class HQVoiceMessage extends BuiltinMessage<IHQVoiceMessageContent> {
|
|
2639
|
-
constructor(content: IHQVoiceMessageContent);
|
|
2640
|
-
}
|
|
2641
|
-
/**
|
|
2642
|
-
* 语音消息 content 数据
|
|
2643
|
-
* @category Interface
|
|
2644
|
-
* @deprecated - 已废弃,使用 IVoiceMessageContent 代替
|
|
2645
|
-
*/
|
|
2646
|
-
declare type IVoiceMessageBody = IVoiceMessageContent;
|
|
2647
|
-
declare class VoiceMessage extends BuiltinMessage<IVoiceMessageContent> {
|
|
2648
|
-
constructor(content: IVoiceMessageContent);
|
|
2649
|
-
}
|
|
2394
|
+
declare function getBlacklistStatus(userId: string): Promise<RCResult<boolean>>;
|
|
2650
2395
|
|
|
2651
2396
|
/**
|
|
2652
2397
|
* 获取本地消息
|
|
@@ -2660,7 +2405,7 @@ declare const getMessage: typeof getLocalMessage;
|
|
|
2660
2405
|
* @param conversation Conversation information
|
|
2661
2406
|
* @param message The message body, which is a subclass of BaseMessage, such as TextMessage, ImageMessage, obtained via new TextMessage()
|
|
2662
2407
|
* @param options Configuration options for sending messages
|
|
2663
|
-
* @returns Returns a Promise of type {@link
|
|
2408
|
+
* @returns Returns a Promise of type {@link RCResult}, with the data structure being {@link IAReceivedMessage}
|
|
2664
2409
|
* @example
|
|
2665
2410
|
* Example of sending a text message:
|
|
2666
2411
|
* ```ts
|
|
@@ -2682,7 +2427,7 @@ declare const getMessage: typeof getLocalMessage;
|
|
|
2682
2427
|
* @param message 消息体,类型为 BaseMessage 的子类,如 TextMessage、ImageMessage,通过 new TextMessage() 获取
|
|
2683
2428
|
* @param options 发送消息配置项
|
|
2684
2429
|
*
|
|
2685
|
-
* @returns 返回一个 {@link
|
|
2430
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2686
2431
|
*
|
|
2687
2432
|
* @example
|
|
2688
2433
|
* 发送文本消息示例:
|
|
@@ -2697,7 +2442,7 @@ declare const getMessage: typeof getLocalMessage;
|
|
|
2697
2442
|
* console.info('消息发送结果:', sendRes);
|
|
2698
2443
|
* ```
|
|
2699
2444
|
*/
|
|
2700
|
-
declare const sendMessage: MonitorableAPI<(conversation:
|
|
2445
|
+
declare const sendMessage: MonitorableAPI<(conversation: IConversationIdentifier, message: BaseMessage, options?: ISendMessageOptions | undefined) => Promise<RCResult<IAReceivedMessage>>>;
|
|
2701
2446
|
/** [EN]
|
|
2702
2447
|
* Send text message
|
|
2703
2448
|
* @description A shortcut for sending text messages, equivalent to creating a message body using `new TextMessage()` and then calling the `sendMessage()` method.
|
|
@@ -2705,7 +2450,6 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
|
|
|
2705
2450
|
* @param conversation Conversation information
|
|
2706
2451
|
* @param messageBody Message body
|
|
2707
2452
|
* @param options Message sending configuration options
|
|
2708
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, with the data structure of type {@link IAReceivedMessage}
|
|
2709
2453
|
* @example
|
|
2710
2454
|
* Example of sending a text message:
|
|
2711
2455
|
* ```ts
|
|
@@ -2725,9 +2469,6 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
|
|
|
2725
2469
|
* @param conversation 会话信息
|
|
2726
2470
|
* @param messageBody 消息体
|
|
2727
2471
|
* @param options 发送消息配置项
|
|
2728
|
-
*
|
|
2729
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2730
|
-
*
|
|
2731
2472
|
* @example
|
|
2732
2473
|
* 发送文本消息示例:
|
|
2733
2474
|
* ```ts
|
|
@@ -2740,7 +2481,7 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
|
|
|
2740
2481
|
* console.info('消息发送结果:', sendRes);
|
|
2741
2482
|
* ```
|
|
2742
2483
|
*/
|
|
2743
|
-
declare function sendTextMessage(conversation: IConversationOption, messageBody:
|
|
2484
|
+
declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageContent, options?: ISendMessageOptions): Promise<RCResult<IAReceivedMessage>>;
|
|
2744
2485
|
/** [EN]
|
|
2745
2486
|
* Basic message types
|
|
2746
2487
|
* @category Type
|
|
@@ -2772,9 +2513,6 @@ declare type ISendFileMessageOptions = ISendBody;
|
|
|
2772
2513
|
* @param msgBody 消息体,其中 file 为待上传文件引用
|
|
2773
2514
|
* @param hooks 上传文件过程中的回调钩子,类型为 {@link IUploadHooks} 可选
|
|
2774
2515
|
* @param sendOptions 文件消息配置项,类型为 {@link IUploadMessageOption} 可选
|
|
2775
|
-
*
|
|
2776
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2777
|
-
*
|
|
2778
2516
|
* @example
|
|
2779
2517
|
* 发送文本消息示例:
|
|
2780
2518
|
* ```ts
|
|
@@ -2787,7 +2525,7 @@ declare type ISendFileMessageOptions = ISendBody;
|
|
|
2787
2525
|
* console.info('消息发送结果:', sendRes);
|
|
2788
2526
|
* ```
|
|
2789
2527
|
*/
|
|
2790
|
-
declare const sendFileMessage: (conversation:
|
|
2528
|
+
declare const sendFileMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
|
|
2791
2529
|
/** [EN]
|
|
2792
2530
|
* Image message sending configuration
|
|
2793
2531
|
* @category Type
|
|
@@ -2805,8 +2543,6 @@ declare type ISendImageMessageOptions = ISendBody;
|
|
|
2805
2543
|
* @param msgBody Message body, where file is the reference to the image to be uploaded
|
|
2806
2544
|
* @param hooks Callback hooks during the image upload process, of type {@link IUploadHooks} (optional)
|
|
2807
2545
|
* @param sendOptions Image message configuration options, of type {@link IImageMessageOption} (optional)
|
|
2808
|
-
* *
|
|
2809
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, with data structured as {@link IAReceivedMessage}
|
|
2810
2546
|
* @example
|
|
2811
2547
|
* Example of sending an image message:
|
|
2812
2548
|
* ```ts
|
|
@@ -2827,8 +2563,6 @@ declare type ISendImageMessageOptions = ISendBody;
|
|
|
2827
2563
|
* @param msgBody 消息体,其中 file 为待上传图片引用
|
|
2828
2564
|
* @param hooks 上传图片过程中的回调钩子,类型为 {@link IUploadHooks} 可选
|
|
2829
2565
|
* @param sendOptions 图片消息配置项,类型为 {@link IImageMessageOption} 可选
|
|
2830
|
-
*
|
|
2831
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2832
2566
|
* @example
|
|
2833
2567
|
* 发送图片消息示例:
|
|
2834
2568
|
* ```ts
|
|
@@ -2841,7 +2575,7 @@ declare type ISendImageMessageOptions = ISendBody;
|
|
|
2841
2575
|
* console.info('消息发送结果:', sendRes);
|
|
2842
2576
|
* ```
|
|
2843
2577
|
*/
|
|
2844
|
-
declare const sendImageMessage: (conversation:
|
|
2578
|
+
declare const sendImageMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IImageMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
|
|
2845
2579
|
/** [EN]
|
|
2846
2580
|
* Send a GIF image message
|
|
2847
2581
|
* @description A shortcut method for sending a GIF image message, equivalent to creating a message body using new GIFMessage() and then calling the sendMessage() method. Supports GIF image upload, and automatically sends the message upon successful upload.
|
|
@@ -2850,8 +2584,6 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
|
|
|
2850
2584
|
* @param msgBody Message body, where 'file' is the reference to the GIF image to be uploaded
|
|
2851
2585
|
* @param hooks Callback hooks during the GIF image upload process, of type {@link IUploadHooks} (optional)
|
|
2852
2586
|
* @param sendOptions Configuration options for the GIF image message, of type {@link IGIFMessageOption} (optional)
|
|
2853
|
-
* *
|
|
2854
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the 'data' structure is of type {@link IAReceivedMessage}
|
|
2855
2587
|
* @example
|
|
2856
2588
|
* Example of sending a GIF image message:
|
|
2857
2589
|
* ```ts
|
|
@@ -2872,8 +2604,6 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
|
|
|
2872
2604
|
* @param msgBody 消息体,其中 file 为待上传 GIF 图片引用
|
|
2873
2605
|
* @param hooks 上传 GIF 图片过程中的回调钩子,类型为 {@link IUploadHooks} 可选
|
|
2874
2606
|
* @param sendOptions GIF 图片消息配置项,类型为 {@link IGIFMessageOption} 可选
|
|
2875
|
-
*
|
|
2876
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2877
2607
|
* @example
|
|
2878
2608
|
* 发送 GIF 图片消息示例:
|
|
2879
2609
|
* ```ts
|
|
@@ -2886,7 +2616,7 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
|
|
|
2886
2616
|
* console.info('消息发送结果:', sendRes);
|
|
2887
2617
|
* ```
|
|
2888
2618
|
*/
|
|
2889
|
-
declare const sendGIFMessage: (conversation:
|
|
2619
|
+
declare const sendGIFMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
|
|
2890
2620
|
/** [EN]
|
|
2891
2621
|
* Send high-quality voice message
|
|
2892
2622
|
* @description The file to be sent must be an AAC audio file.
|
|
@@ -2896,7 +2626,6 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
|
|
|
2896
2626
|
* @param msgBody Message body, where `file` is the reference to the high-quality voice file to be uploaded
|
|
2897
2627
|
* @param hooks Callback hooks during the high-quality voice upload process, of type {@link IUploadHooks} (optional)
|
|
2898
2628
|
* @param sendOptions Configuration options for high-quality voice messages, of type {@link ISendHQVoiceMessageOptions} (optional)
|
|
2899
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the `data` structure is of type {@link IAReceivedMessage}
|
|
2900
2629
|
* @example
|
|
2901
2630
|
* Example of sending a high-quality voice message:
|
|
2902
2631
|
* ```ts
|
|
@@ -2918,7 +2647,6 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
|
|
|
2918
2647
|
* @param msgBody 消息体,其中 file 为待上传高清语音引用
|
|
2919
2648
|
* @param hooks 上传高清语音过程中的回调钩子,类型为 {@link IUploadHooks} 可选
|
|
2920
2649
|
* @param sendOptions 高清语音消息配置项,类型为 {@link ISendHQVoiceMessageOptions} 可选
|
|
2921
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2922
2650
|
* @example
|
|
2923
2651
|
* 发送高清语音消息示例:
|
|
2924
2652
|
* ```ts
|
|
@@ -2931,7 +2659,7 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
|
|
|
2931
2659
|
* console.info('消息发送结果:', sendRes);
|
|
2932
2660
|
* ```
|
|
2933
2661
|
*/
|
|
2934
|
-
declare const sendHQVoiceMessage: (conversation:
|
|
2662
|
+
declare const sendHQVoiceMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
|
|
2935
2663
|
/** [EN]
|
|
2936
2664
|
* Configuration options for sending short video messages
|
|
2937
2665
|
* @category Type
|
|
@@ -2954,7 +2682,6 @@ declare type ISendSightMessageOptions = {
|
|
|
2954
2682
|
* @param msgBody Message body, where file is the reference to the short video to be uploaded
|
|
2955
2683
|
* @param hooks Callback hooks during the short video upload process, of type {@link IUploadHooks} (optional)
|
|
2956
2684
|
* @param sendOptions Configuration options for the short video message, of type {@link ISendSightMessageOptions} (optional)
|
|
2957
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, with the data structure of type {@link IAReceivedMessage}
|
|
2958
2685
|
* @example
|
|
2959
2686
|
* Example of sending a short video message:
|
|
2960
2687
|
* ```ts
|
|
@@ -2976,7 +2703,6 @@ declare type ISendSightMessageOptions = {
|
|
|
2976
2703
|
* @param msgBody 消息体,其中 file 为待上传小视频引用
|
|
2977
2704
|
* @param hooks 上传小视频过程中的回调钩子,类型为 {@link IUploadHooks} 可选
|
|
2978
2705
|
* @param sendOptions 小视频消息配置项,类型为 {@link ISendSightMessageOptions} 可选
|
|
2979
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
2980
2706
|
* @example
|
|
2981
2707
|
* 发送小视频消息示例:
|
|
2982
2708
|
* ```ts
|
|
@@ -2989,7 +2715,7 @@ declare type ISendSightMessageOptions = {
|
|
|
2989
2715
|
* console.info('消息发送结果:', sendRes);
|
|
2990
2716
|
* ```
|
|
2991
2717
|
*/
|
|
2992
|
-
declare const sendSightMessage: (conversation:
|
|
2718
|
+
declare const sendSightMessage: (conversation: IConversationIdentifier, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
|
|
2993
2719
|
/** [EN]
|
|
2994
2720
|
* Get history messages
|
|
2995
2721
|
* @category Message
|
|
@@ -3003,8 +2729,6 @@ declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISe
|
|
|
3003
2729
|
* @param conversation Conversation information
|
|
3004
2730
|
* @param options Configuration for retrieving historical messages, of type {@link GetHistoryMessageOption} (optional)
|
|
3005
2731
|
* @defaultValue options = { timestamp: 0, count: 20, order: 0 }
|
|
3006
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the `data` structure is of type {@link GetHistoryMessageResult}
|
|
3007
|
-
* *
|
|
3008
2732
|
* @example
|
|
3009
2733
|
* Example of retrieving historical messages:
|
|
3010
2734
|
* ```ts
|
|
@@ -3029,8 +2753,6 @@ declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISe
|
|
|
3029
2753
|
* @param conversation 会话信息
|
|
3030
2754
|
* @param options 获取历史消息配置项,类型为 {@link GetHistoryMessageOption} 可选
|
|
3031
2755
|
* @defaultValue options = { timestamp: 0, count: 20, order: 0 }
|
|
3032
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link GetHistoryMessageResult} 类型
|
|
3033
|
-
*
|
|
3034
2756
|
* @example
|
|
3035
2757
|
* 获取历史消息示例:
|
|
3036
2758
|
* ```ts
|
|
@@ -3053,7 +2775,6 @@ declare function getHistoryMessages(conversation: IConversationOption, options?:
|
|
|
3053
2775
|
* @param conversation Conversation information
|
|
3054
2776
|
* @param options Configuration options for retrieving history messages, of type {@link GetHistoryMessageOption} (optional)
|
|
3055
2777
|
* @defaultValue options = { timestamp: 0, count: 20, order: 0 }
|
|
3056
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, with the data structure being {@link GetHistoryMessageResult}
|
|
3057
2778
|
* @example
|
|
3058
2779
|
* Example of retrieving remote history messages:
|
|
3059
2780
|
* ```ts
|
|
@@ -3077,8 +2798,6 @@ declare function getHistoryMessages(conversation: IConversationOption, options?:
|
|
|
3077
2798
|
* @param conversation 会话信息
|
|
3078
2799
|
* @param options 获取历史消息配置项,类型为 {@link GetHistoryMessageOption} 可选
|
|
3079
2800
|
* @defaultValue options = { timestamp: 0, count: 20, order: 0 }
|
|
3080
|
-
*
|
|
3081
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link GetHistoryMessageResult} 类型
|
|
3082
2801
|
* @example
|
|
3083
2802
|
* 获取远程历史消息示例:
|
|
3084
2803
|
* ```ts
|
|
@@ -3147,7 +2866,7 @@ declare function getRemoteHistoryMessages(conversation: IConversationOption, opt
|
|
|
3147
2866
|
* console.info('单聊消息回执:', readReceiptRes)
|
|
3148
2867
|
* ```
|
|
3149
2868
|
*/
|
|
3150
|
-
declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<
|
|
2869
|
+
declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<RCResult>;
|
|
3151
2870
|
/** [EN]
|
|
3152
2871
|
* Send group read receipt request
|
|
3153
2872
|
* @description Implements the request for obtaining the read status of messages sent by oneself in a group chat on demand. This interface is used in conjunction with the group chat read receipt response interface {@link sendReadReceiptResponseV2}. Calling this interface alone does not enable group receipt functionality.
|
|
@@ -3182,7 +2901,7 @@ declare function sendReadReceiptMessage(targetId: string, messageUId: string, ti
|
|
|
3182
2901
|
* console.info('群已读回执请求:', readReceiptRes)
|
|
3183
2902
|
* ```
|
|
3184
2903
|
*/
|
|
3185
|
-
declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<
|
|
2904
|
+
declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<RCResult>;
|
|
3186
2905
|
/** [EN]
|
|
3187
2906
|
* @category Message
|
|
3188
2907
|
* @deprecated since version 5.1.1. Please use {@link sendReadReceiptResponseV2} instead.
|
|
@@ -3279,7 +2998,7 @@ declare function sendReadReceiptResponseV2(targetId: string, messageList: Record
|
|
|
3279
2998
|
* console.info('多端同步阅读状态:', syncReadStatusRes);
|
|
3280
2999
|
* ```
|
|
3281
3000
|
*/
|
|
3282
|
-
declare function sendSyncReadStatusMessage(conversation:
|
|
3001
|
+
declare function sendSyncReadStatusMessage(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
3283
3002
|
/** [EN]
|
|
3284
3003
|
* Send read receipt (V4 version)
|
|
3285
3004
|
* After calling this interface, the message sender will receive the EVENTS.MESSAGE_READ_RECEIPT_V4 event notification.
|
|
@@ -3292,15 +3011,15 @@ declare function sendSyncReadStatusMessage(conversation: IConversationOption, ti
|
|
|
3292
3011
|
* @example
|
|
3293
3012
|
* ```js
|
|
3294
3013
|
* const con = {
|
|
3295
|
-
*
|
|
3296
|
-
*
|
|
3014
|
+
* conversationType: ConversationType.Group,
|
|
3015
|
+
* targetId: 'targetId'
|
|
3297
3016
|
* }
|
|
3298
3017
|
* sendReadReceiptMessageV4(con, 'endMsgUId', 'startMsgUId').then(res => {
|
|
3299
|
-
*
|
|
3300
|
-
*
|
|
3301
|
-
*
|
|
3302
|
-
*
|
|
3303
|
-
*
|
|
3018
|
+
* if (res.code === ErrorCode.success) {
|
|
3019
|
+
* console.log('Send success')
|
|
3020
|
+
* } else {
|
|
3021
|
+
* console.log('Send error', res.msg)
|
|
3022
|
+
* }
|
|
3304
3023
|
* })
|
|
3305
3024
|
* ```
|
|
3306
3025
|
*/
|
|
@@ -3330,7 +3049,7 @@ declare function sendSyncReadStatusMessage(conversation: IConversationOption, ti
|
|
|
3330
3049
|
* })
|
|
3331
3050
|
* ```
|
|
3332
3051
|
*/
|
|
3333
|
-
declare function sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<
|
|
3052
|
+
declare function sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<RCResult>;
|
|
3334
3053
|
/** [EN]
|
|
3335
3054
|
* Get the read receipt list for a message
|
|
3336
3055
|
* This API requires enabling the service in the developer console
|
|
@@ -3341,15 +3060,15 @@ declare function sendReadReceiptMessageV4(conversation: IConversationOption, end
|
|
|
3341
3060
|
* @example
|
|
3342
3061
|
* ```js
|
|
3343
3062
|
* const con = {
|
|
3344
|
-
*
|
|
3345
|
-
*
|
|
3063
|
+
* conversationType: ConversationType.Group,
|
|
3064
|
+
* targetId: 'targetId'
|
|
3346
3065
|
* }
|
|
3347
3066
|
* getMessageReadReceiptV4(con, 'MsgUId').then(res => {
|
|
3348
|
-
*
|
|
3349
|
-
*
|
|
3350
|
-
*
|
|
3351
|
-
*
|
|
3352
|
-
*
|
|
3067
|
+
* if (res.code === ErrorCode.success) {
|
|
3068
|
+
* console.log('send success', res.data)
|
|
3069
|
+
* } else {
|
|
3070
|
+
* console.log('send error', res.msg)
|
|
3071
|
+
* }
|
|
3353
3072
|
* })
|
|
3354
3073
|
* ```
|
|
3355
3074
|
*/
|
|
@@ -3376,7 +3095,7 @@ declare function sendReadReceiptMessageV4(conversation: IConversationOption, end
|
|
|
3376
3095
|
* })
|
|
3377
3096
|
* ```
|
|
3378
3097
|
*/
|
|
3379
|
-
declare function getMessageReadReceiptV4(conversation:
|
|
3098
|
+
declare function getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUId: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
|
|
3380
3099
|
/** [EN]
|
|
3381
3100
|
* Get the read receipt list for messages
|
|
3382
3101
|
* This API requires the service to be enabled in the developer console
|
|
@@ -3387,15 +3106,15 @@ declare function getMessageReadReceiptV4(conversation: IConversationOption, mess
|
|
|
3387
3106
|
* @example
|
|
3388
3107
|
* ```js
|
|
3389
3108
|
* const con = {
|
|
3390
|
-
*
|
|
3109
|
+
* conversationType: ConversationType.Group,
|
|
3391
3110
|
* targetId: 'targetId'
|
|
3392
3111
|
* }
|
|
3393
3112
|
* batchGetMessageReadReceiptInfoV4(con, ['MsgUId']).then(res => {
|
|
3394
|
-
*
|
|
3395
|
-
*
|
|
3396
|
-
*
|
|
3397
|
-
*
|
|
3398
|
-
*
|
|
3113
|
+
* if (res.code === ErrorCode.success) {
|
|
3114
|
+
* console.log('send success', res.data)
|
|
3115
|
+
* } else {
|
|
3116
|
+
* console.log('send error', res.msg)
|
|
3117
|
+
* }
|
|
3399
3118
|
* })
|
|
3400
3119
|
* ```
|
|
3401
3120
|
*/
|
|
@@ -3422,7 +3141,7 @@ declare function getMessageReadReceiptV4(conversation: IConversationOption, mess
|
|
|
3422
3141
|
* })
|
|
3423
3142
|
* ```
|
|
3424
3143
|
*/
|
|
3425
|
-
declare function batchGetMessageReadReceiptInfoV4(conversation:
|
|
3144
|
+
declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
|
|
3426
3145
|
/** [EN]
|
|
3427
3146
|
* Recall message
|
|
3428
3147
|
* @description RC does not impose restrictions on who can recall messages.
|
|
@@ -3444,7 +3163,6 @@ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOpt
|
|
|
3444
3163
|
* const recallRes = await RongIMLib.recallMessage(conversation, options);
|
|
3445
3164
|
* console.info('Recall message result:', recallRes);
|
|
3446
3165
|
* ```
|
|
3447
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IAReceivedMessage}
|
|
3448
3166
|
*/
|
|
3449
3167
|
/**
|
|
3450
3168
|
* 撤回消息
|
|
@@ -3467,7 +3185,6 @@ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOpt
|
|
|
3467
3185
|
* const recallRes = await RongIMLib.recallMessage(conversation, options);
|
|
3468
3186
|
* console.info('撤回消息结果:', recallRes);
|
|
3469
3187
|
* ```
|
|
3470
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
3471
3188
|
*/
|
|
3472
3189
|
declare const recallMessage: MonitorableAPI<(conversation: IConversationOption, options: IRecallMessageOptions) => Promise<RCResult<IAReceivedMessage>>>;
|
|
3473
3190
|
/** [EN]
|
|
@@ -3706,14 +3423,13 @@ declare function removeMessageExpansionForKey(keys: string[], message: IAReceive
|
|
|
3706
3423
|
* @category Message
|
|
3707
3424
|
* @param conversation Conversation information
|
|
3708
3425
|
* @param typingContentType Typing status message type
|
|
3709
|
-
* @returns Returns a Promise of type {@link
|
|
3710
|
-
* *
|
|
3426
|
+
* @returns Returns a Promise of type {@link RCResult}, with data structured as {@link IAReceivedMessage}
|
|
3711
3427
|
* @example
|
|
3712
3428
|
* Example of sending a typing status message:
|
|
3713
3429
|
* ```ts
|
|
3714
3430
|
* const conversation = {
|
|
3715
|
-
*
|
|
3716
|
-
*
|
|
3431
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
3432
|
+
* targetId: 'targetId',
|
|
3717
3433
|
* }
|
|
3718
3434
|
* const typingContentType = RongIMLib.MessageType.TEXT;
|
|
3719
3435
|
* const typingRes = await RongIMLib.sendTypingStatusMessage(conversation, typingContentType);
|
|
@@ -3726,27 +3442,26 @@ declare function removeMessageExpansionForKey(keys: string[], message: IAReceive
|
|
|
3726
3442
|
* @category 消息
|
|
3727
3443
|
* @param conversation 会话信息
|
|
3728
3444
|
* @param typingContentType 输入状态消息类型
|
|
3729
|
-
* @returns 返回一个 {@link
|
|
3730
|
-
*
|
|
3445
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
3731
3446
|
* @example
|
|
3732
3447
|
* 发送输入状态消息示例:
|
|
3733
3448
|
* ```ts
|
|
3734
3449
|
* const conversation = {
|
|
3735
|
-
*
|
|
3736
|
-
*
|
|
3450
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
3451
|
+
* targetId: 'targetId',
|
|
3737
3452
|
* }
|
|
3738
3453
|
* const typingContentType = RongIMLib.MessageType.TEXT;
|
|
3739
3454
|
* const typingRes = await RongIMLib.sendTypingStatusMessage(conversation, typingContentType);
|
|
3740
3455
|
* console.info('发送 typing 消息结果:', typingRes);
|
|
3741
3456
|
* ```
|
|
3742
3457
|
*/
|
|
3743
|
-
declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<
|
|
3458
|
+
declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<RCResult<IAReceivedMessage>>;
|
|
3744
3459
|
/** [EN]
|
|
3745
|
-
* Get group read list
|
|
3460
|
+
* Get group read list, need to enable group read receipt service V2 version, otherwise it cannot be used.
|
|
3746
3461
|
* @category Message
|
|
3747
3462
|
* @param targetId Group ID
|
|
3748
3463
|
* @param messageUId Message UID
|
|
3749
|
-
* @returns Returns a Promise of type {@link
|
|
3464
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data structure is of type {@link IMessageReaderResponse}
|
|
3750
3465
|
* @example
|
|
3751
3466
|
* ```ts
|
|
3752
3467
|
* const messageUId = 'messageUId';
|
|
@@ -3756,11 +3471,11 @@ declare function sendTypingStatusMessage(conversation: IConversationOption, typi
|
|
|
3756
3471
|
* ```
|
|
3757
3472
|
*/
|
|
3758
3473
|
/**
|
|
3759
|
-
*
|
|
3474
|
+
* 获取群已读列表,需开通群已读回执服务 V2 版本,否则无法使用
|
|
3760
3475
|
* @category 消息
|
|
3761
3476
|
* @param targetId 群 ID
|
|
3762
3477
|
* @param messageUId 消息 UID
|
|
3763
|
-
* @returns 返回一个 {@link
|
|
3478
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IMessageReaderResponse} 类型
|
|
3764
3479
|
* @example
|
|
3765
3480
|
* ```ts
|
|
3766
3481
|
* const messageUId = 'messageUId';
|
|
@@ -3769,7 +3484,7 @@ declare function sendTypingStatusMessage(conversation: IConversationOption, typi
|
|
|
3769
3484
|
* console.info('获取群已读列表结果:', getReaderRes);
|
|
3770
3485
|
* ```
|
|
3771
3486
|
*/
|
|
3772
|
-
declare function getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<
|
|
3487
|
+
declare function getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<RCResult<IMessageReaderResponse>>;
|
|
3773
3488
|
/** [EN]
|
|
3774
3489
|
* Register custom message
|
|
3775
3490
|
* @description Registers a custom message type, which affects the sending and receiving of custom messages.
|
|
@@ -3828,8 +3543,6 @@ declare function registerMessageType<T>(messageType: string, isPersited: boolean
|
|
|
3828
3543
|
* @description Retrieves the first unread message in the specified conversation. This feature is only supported on the Electron platform.
|
|
3829
3544
|
* @category Message
|
|
3830
3545
|
* @param conversation
|
|
3831
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IAReceivedMessage}.
|
|
3832
|
-
*
|
|
3833
3546
|
* @example
|
|
3834
3547
|
* Example of getting the first unread message:
|
|
3835
3548
|
* ```ts
|
|
@@ -3846,7 +3559,6 @@ declare function registerMessageType<T>(messageType: string, isPersited: boolean
|
|
|
3846
3559
|
* @description 获取指定会话中的第一条未读消息,仅支持 Electron 平台
|
|
3847
3560
|
* @category 消息
|
|
3848
3561
|
* @param conversation
|
|
3849
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
|
|
3850
3562
|
* @example
|
|
3851
3563
|
* 获取第一条未读消息示例:
|
|
3852
3564
|
* ```ts
|
|
@@ -3868,7 +3580,6 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
|
|
|
3868
3580
|
* **Note**:
|
|
3869
3581
|
* 1. When there are no unread messages, the returned data is null
|
|
3870
3582
|
* 2. When the first unread message is recalled, this information will not be updated
|
|
3871
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IFirstUnreadMessageInfo}
|
|
3872
3583
|
* @example
|
|
3873
3584
|
* Example of getting the first unread message information:
|
|
3874
3585
|
* ```ts
|
|
@@ -3889,7 +3600,6 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
|
|
|
3889
3600
|
* **注意**:
|
|
3890
3601
|
* 1. 当没有未读消息时,返回的 data 为 null
|
|
3891
3602
|
* 2. 当第一条未读消息被撤回时,此信息不会更新
|
|
3892
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IFirstUnreadMessageInfo} 类型
|
|
3893
3603
|
* @example
|
|
3894
3604
|
* 获取第一条未读消息信息示例:
|
|
3895
3605
|
* ```ts
|
|
@@ -3912,7 +3622,7 @@ declare function getFirstUnreadMessageInfo(conversation: IConversationOption): P
|
|
|
3912
3622
|
* @category 消息
|
|
3913
3623
|
* @deprecated 请使用 {@link electronExtension.insertMessage} 代替
|
|
3914
3624
|
*/
|
|
3915
|
-
declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<
|
|
3625
|
+
declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<RCResult<IAReceivedMessage>>;
|
|
3916
3626
|
/** [EN]
|
|
3917
3627
|
* Get unread mentioned messages
|
|
3918
3628
|
* @deprecated This method is deprecated since version 5.28.0. Please use {@link electronExtension.getUnreadMentionedMessages} instead.
|
|
@@ -3943,7 +3653,7 @@ declare function searchMessages$1(conversation: IConversationOption, keyword: st
|
|
|
3943
3653
|
* @category 消息
|
|
3944
3654
|
* @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.deleteMessagesByTimestamp} 方法
|
|
3945
3655
|
*/
|
|
3946
|
-
declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<
|
|
3656
|
+
declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<RCResult>;
|
|
3947
3657
|
/** [EN]
|
|
3948
3658
|
* Clear historical messages in a conversation
|
|
3949
3659
|
* @category Message
|
|
@@ -3954,7 +3664,7 @@ declare function deleteLocalMessagesByTimestamp(conversation: IConversationOptio
|
|
|
3954
3664
|
* @category 消息
|
|
3955
3665
|
* @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.clearMessages} 方法
|
|
3956
3666
|
*/
|
|
3957
|
-
declare function clearMessages$1(conversation: IConversationOption): Promise<
|
|
3667
|
+
declare function clearMessages$1(conversation: IConversationOption): Promise<RCResult>;
|
|
3958
3668
|
/** [EN]
|
|
3959
3669
|
* Search conversations by content
|
|
3960
3670
|
* @category Message
|
|
@@ -3965,10 +3675,10 @@ declare function clearMessages$1(conversation: IConversationOption): Promise<IAs
|
|
|
3965
3675
|
* @category 消息
|
|
3966
3676
|
* @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.searchConversationByContent} 方法
|
|
3967
3677
|
*/
|
|
3968
|
-
declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<
|
|
3678
|
+
declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<RCResult<IAReceivedConversation[] | undefined>>;
|
|
3969
3679
|
/** [EN]
|
|
3970
3680
|
* Clear unread count before timestamp
|
|
3971
|
-
* @description Clears the unread count before the specified timestamp. This feature is only supported on the Electron platform.
|
|
3681
|
+
* @description Clears the unread count before the specified timestamp. This feature is only supported on the Electron platform. Not supported for clearing ultra group conversation.
|
|
3972
3682
|
* @category Message
|
|
3973
3683
|
* @param conversation Conversation information
|
|
3974
3684
|
* @param timestamp Timestamp for clearing unread count
|
|
@@ -3987,7 +3697,7 @@ declare function searchConversationByContent$1(keyword: string, conversationType
|
|
|
3987
3697
|
*/
|
|
3988
3698
|
/**
|
|
3989
3699
|
* 清除时间戳前的未读数
|
|
3990
|
-
* @description 清除时间戳前的未读数,仅支持 Electron
|
|
3700
|
+
* @description 清除时间戳前的未读数,仅支持 Electron 平台,不支持清理超级群会话
|
|
3991
3701
|
* @category 消息
|
|
3992
3702
|
* @param conversation 会话信息
|
|
3993
3703
|
* @param timestamp 清理未读时间戳
|
|
@@ -4004,7 +3714,7 @@ declare function searchConversationByContent$1(keyword: string, conversationType
|
|
|
4004
3714
|
* console.info('清除时间戳前的未读数结果:', clearRes);
|
|
4005
3715
|
* ```
|
|
4006
3716
|
*/
|
|
4007
|
-
declare function clearUnreadCountByTimestamp(conversation:
|
|
3717
|
+
declare function clearUnreadCountByTimestamp(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
|
|
4008
3718
|
/** [EN]
|
|
4009
3719
|
* Set message receiving status
|
|
4010
3720
|
* @category Message
|
|
@@ -4015,7 +3725,7 @@ declare function clearUnreadCountByTimestamp(conversation: IConversationOption,
|
|
|
4015
3725
|
* @category 消息
|
|
4016
3726
|
* @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.setMessageReceivedStatusInfo} 方法
|
|
4017
3727
|
*/
|
|
4018
|
-
declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<
|
|
3728
|
+
declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<RCResult>;
|
|
4019
3729
|
/**
|
|
4020
3730
|
* 请求流式消息内容;请求成功后,数据将通过 `Events.STREAM_MESSAGE_RESPONSE` 事件通知
|
|
4021
3731
|
* @param messageUId
|
|
@@ -4289,7 +3999,7 @@ declare function updateTag(tag: ITagParam): Promise<RCResult>;
|
|
|
4289
3999
|
* Get tag list
|
|
4290
4000
|
* @category Tag
|
|
4291
4001
|
* @description Retrieves the tag list of the current user
|
|
4292
|
-
* @returns Returns a Promise of type {@link
|
|
4002
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data is the tag list of type {@link ITagInfo} array or undefined
|
|
4293
4003
|
* @example Example of getting the tag list:
|
|
4294
4004
|
* ```ts
|
|
4295
4005
|
* const res = await RongIMLib.getTags();
|
|
@@ -4313,7 +4023,7 @@ declare function getTags(): Promise<RCResult<ITagInfo[]>>;
|
|
|
4313
4023
|
* @description Retrieves the list of tags for a specific conversation based on conversation information
|
|
4314
4024
|
* @category Tags
|
|
4315
4025
|
* @param conversation Conversation information, including conversation type, conversation ID, and channelId, of type {@link IConversationOption}
|
|
4316
|
-
* @returns Returns a Promise of type {@link
|
|
4026
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data is an array of tags of type {@link IConversationTag} or undefined
|
|
4317
4027
|
* @example Example of getting tags for a conversation:
|
|
4318
4028
|
* ```ts
|
|
4319
4029
|
* const conversation = {
|
|
@@ -4402,194 +4112,440 @@ declare function addConversationsToTag(tagId: string, conversations: IConversati
|
|
|
4402
4112
|
* ```
|
|
4403
4113
|
*/
|
|
4404
4114
|
/**
|
|
4405
|
-
* 从指定标签中删除多个会话
|
|
4406
|
-
* @description 从指定标签中删除多个会话,此操作仅解除会话与标签的关系,并不会删除会话数据
|
|
4407
|
-
* @category 标签
|
|
4408
|
-
* @param tagId 标签 ID
|
|
4409
|
-
* @param conversations 会话信息,包含会话类型、会话 ID 和 channelId,类型为 {@link IConversationOption} 数组
|
|
4410
|
-
* @example 从指定标签中删除多个会话示例:
|
|
4411
|
-
* ```ts
|
|
4412
|
-
* const tagId = 'tagId';
|
|
4413
|
-
* const conversations = [{
|
|
4414
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4415
|
-
* targetId: 'targetId',
|
|
4416
|
-
* }];
|
|
4417
|
-
* const res = await RongIMLib.removeConversationsFromTag(tagId, conversations);
|
|
4418
|
-
* console.log('从指定标签中删除多个会话果:', res);
|
|
4419
|
-
* ```
|
|
4115
|
+
* 从指定标签中删除多个会话
|
|
4116
|
+
* @description 从指定标签中删除多个会话,此操作仅解除会话与标签的关系,并不会删除会话数据
|
|
4117
|
+
* @category 标签
|
|
4118
|
+
* @param tagId 标签 ID
|
|
4119
|
+
* @param conversations 会话信息,包含会话类型、会话 ID 和 channelId,类型为 {@link IConversationOption} 数组
|
|
4120
|
+
* @example 从指定标签中删除多个会话示例:
|
|
4121
|
+
* ```ts
|
|
4122
|
+
* const tagId = 'tagId';
|
|
4123
|
+
* const conversations = [{
|
|
4124
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4125
|
+
* targetId: 'targetId',
|
|
4126
|
+
* }];
|
|
4127
|
+
* const res = await RongIMLib.removeConversationsFromTag(tagId, conversations);
|
|
4128
|
+
* console.log('从指定标签中删除多个会话果:', res);
|
|
4129
|
+
* ```
|
|
4130
|
+
*/
|
|
4131
|
+
declare function removeConversationsFromTag(tagId: string, conversations: IConversationOption[]): Promise<RCResult>;
|
|
4132
|
+
/** [EN]
|
|
4133
|
+
* Remove multiple tags from a specified conversation
|
|
4134
|
+
* @description Removes multiple tags from a specified conversation. This operation only disassociates the tags from the conversation and does not delete the conversation data.
|
|
4135
|
+
* @category Tag
|
|
4136
|
+
* @param conversation Conversation information, including conversation type, conversation ID, and channelId, of type {@link IConversationOption}
|
|
4137
|
+
* @param tagIds List of tags to be removed
|
|
4138
|
+
* @example Example of removing multiple tags from a specified conversation:
|
|
4139
|
+
* ```ts
|
|
4140
|
+
* const conversation = {
|
|
4141
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4142
|
+
* targetId: 'targetId',
|
|
4143
|
+
* };
|
|
4144
|
+
* const tagIds = ['tagId1', 'tagId2'];
|
|
4145
|
+
* const res = await RongIMLib.removeTagsFromConversation(conversation, tagIds);
|
|
4146
|
+
* console.log('Result of removing multiple tags from a specified conversation:', res);
|
|
4147
|
+
* ```
|
|
4148
|
+
*/
|
|
4149
|
+
/**
|
|
4150
|
+
* 从指定会话中删除多个标签
|
|
4151
|
+
* @description 从指定会话中删除多个标签,此操作仅解除会话与标签的关系,并不会删除会话数据
|
|
4152
|
+
* @category 标签
|
|
4153
|
+
* @param conversation 会话信息,包含会话类型、会话 ID 和 channelId,类型为 {@link IConversationOption}
|
|
4154
|
+
* @param tagIds 要删除的标签列表
|
|
4155
|
+
* @example 从指定会话中删除多个标签示例:
|
|
4156
|
+
* ```ts
|
|
4157
|
+
* const conversation = {
|
|
4158
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4159
|
+
* targetId: 'targetId',
|
|
4160
|
+
* };
|
|
4161
|
+
* const tagIds = ['tagId1', 'tagId2'];
|
|
4162
|
+
* const res = await RongIMLib.removeTagsFromConversation(conversation, tagIds);
|
|
4163
|
+
* console.log('从指定会话中删除多个标签结果:', res);
|
|
4164
|
+
* ```
|
|
4165
|
+
*/
|
|
4166
|
+
declare function removeTagsFromConversation(conversation: IConversationOption, tagIds: string[]): Promise<RCResult>;
|
|
4167
|
+
/** [EN]
|
|
4168
|
+
* Remove specified tag from multiple conversations
|
|
4169
|
+
* @description Removes the specified tag from multiple conversations. This operation only disassociates the tag from the conversations and does not delete the conversation data.
|
|
4170
|
+
* @category Tag
|
|
4171
|
+
* @param tagId The ID of the tag
|
|
4172
|
+
* @param conversations List of conversation information
|
|
4173
|
+
* @example Example of removing a specified tag from multiple conversations:
|
|
4174
|
+
* ```ts
|
|
4175
|
+
* const tagId = 'tagId';
|
|
4176
|
+
* const conversations = [{
|
|
4177
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4178
|
+
* targetId: 'targetId',
|
|
4179
|
+
* }];
|
|
4180
|
+
* const res = await RongIMLib.removeTagFromConversations(tagId, conversations);
|
|
4181
|
+
* console.log('Removed specified tag from multiple conversations:', res);
|
|
4182
|
+
* ```
|
|
4183
|
+
*/
|
|
4184
|
+
/**
|
|
4185
|
+
* 从多个会话中删除指定的标签
|
|
4186
|
+
* @description 从多个会话中删除指定的标签,此操作仅解除会话与标签的关系,并不会删除会话数据
|
|
4187
|
+
* @category 标签
|
|
4188
|
+
* @param tagId 标签 ID
|
|
4189
|
+
* @param conversations 会话信息列表
|
|
4190
|
+
* @example 从多个会话中删除指定的标签示例:
|
|
4191
|
+
* ```ts
|
|
4192
|
+
* const tagId = 'tagId';
|
|
4193
|
+
* const conversations = [{
|
|
4194
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4195
|
+
* targetId: 'targetId',
|
|
4196
|
+
* }];
|
|
4197
|
+
* const res = await RongIMLib.removeTagFromConversations(tagId, conversations);
|
|
4198
|
+
* console.log('从多个会话中删除指定的标签:', res);
|
|
4199
|
+
* ```
|
|
4200
|
+
*/
|
|
4201
|
+
declare function removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<RCResult>;
|
|
4202
|
+
/** [EN]
|
|
4203
|
+
* Paginate conversations under a tag
|
|
4204
|
+
* @category Tag
|
|
4205
|
+
* @param tagId The ID of the tag
|
|
4206
|
+
* @param count The number of conversations to retrieve
|
|
4207
|
+
* @param timestamp The timestamp of the message in the conversation
|
|
4208
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data is an array of conversations of type {@link IAReceivedConversationByTag} or undefined
|
|
4209
|
+
* Starting from SDK version @since 5.7.0, the return data type of this interface has changed from {@link IReceivedConversationByTag} to {@link IAReceivedConversationByTag}
|
|
4210
|
+
* @example Example of paginating conversations under a tag:
|
|
4211
|
+
* ```ts
|
|
4212
|
+
* const tagId = 'tagId';
|
|
4213
|
+
* const count = 10;
|
|
4214
|
+
* const timestamp = 0;
|
|
4215
|
+
* const res = await RongIMLib.getConversationsFromTagByPage(tagId, count, timestamp);
|
|
4216
|
+
* console.log('Result of paginating conversations under a tag:', res);
|
|
4217
|
+
* ```
|
|
4218
|
+
*/
|
|
4219
|
+
/**
|
|
4220
|
+
* 分页获取标签下会话列表
|
|
4221
|
+
* @category 标签
|
|
4222
|
+
* @param tagId 标签 id
|
|
4223
|
+
* @param count 数量
|
|
4224
|
+
* @param timestamp 分页起始时间戳
|
|
4225
|
+
* @returns 返回一个 Promise<{@link RCResult}> 实例,data 为会话列表,类型为 {@link IAReceivedConversationByTag} 数组。
|
|
4226
|
+
* 从 SDK 5.7.0 版本开始该接口的返回数据类型由 {@link IReceivedConversationByTag} 变更为 {@link IAReceivedConversationByTag}
|
|
4227
|
+
* @example 分页获取标签下会话列表示例:
|
|
4228
|
+
* ```ts
|
|
4229
|
+
* const tagId = 'tagId';
|
|
4230
|
+
* const count = 10;
|
|
4231
|
+
* const timestamp = 0;
|
|
4232
|
+
* const res = await RongIMLib.getConversationsFromTagByPage(tagId, count, timestamp);
|
|
4233
|
+
* console.log('分页获取标签下会话列表结果:', res);
|
|
4234
|
+
* ```
|
|
4235
|
+
*/
|
|
4236
|
+
declare function getConversationsFromTagByPage(tagId: string, count: number, startTime: number): Promise<RCResult<IAReceivedConversationByTag[]>>;
|
|
4237
|
+
/** [EN]
|
|
4238
|
+
* Get the unread message count by tag
|
|
4239
|
+
* @category Tag
|
|
4240
|
+
* @param tagId The ID of the tag
|
|
4241
|
+
* @param containMuted Indicates whether to include muted conversations
|
|
4242
|
+
* @example Example of getting the unread message count by tag:
|
|
4243
|
+
* ```ts
|
|
4244
|
+
* const tagId = 'tagId';
|
|
4245
|
+
* const containMuted = false;
|
|
4246
|
+
* const res = await RongIMLib.getUnreadCountByTag(tagId, containMuted);
|
|
4247
|
+
* console.log('Result of getting the unread message count by tag:', res);
|
|
4248
|
+
* ```
|
|
4249
|
+
*/
|
|
4250
|
+
/**
|
|
4251
|
+
* 根据标签获取未读消息数
|
|
4252
|
+
* @category 标签
|
|
4253
|
+
* @param tagId 标签 id
|
|
4254
|
+
* @param containMuted 是否包含免打扰
|
|
4255
|
+
* @example 根据标签获取未读消息数示例:
|
|
4256
|
+
* ```ts
|
|
4257
|
+
* const tagId = 'tagId';
|
|
4258
|
+
* const containMuted = false;
|
|
4259
|
+
* const res = await RongIMLib.getUnreadCountByTag(tagId, containMuted);
|
|
4260
|
+
* console.log('根据标签获取未读消息数结果:', res);
|
|
4261
|
+
* ```
|
|
4262
|
+
*/
|
|
4263
|
+
declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<RCResult<number>>;
|
|
4264
|
+
/** [EN]
|
|
4265
|
+
* Set conversation top in tag
|
|
4266
|
+
* @description Sets a conversation to be pinned under a specified tag. When retrieving conversations by tag, this property will be visible in the retrieved conversations. Note that this is distinct from pinning conversations in the conversation list.
|
|
4267
|
+
* @category Tag
|
|
4268
|
+
* @param tagId The tag ID
|
|
4269
|
+
* @param conversation The conversation
|
|
4270
|
+
* @param status The status
|
|
4271
|
+
* @example Example of setting a conversation to be pinned in a tag:
|
|
4272
|
+
* ```ts
|
|
4273
|
+
* const tagId = 'tagId';
|
|
4274
|
+
* const conversation = {
|
|
4275
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4276
|
+
* targetId: 'targetId',
|
|
4277
|
+
* };
|
|
4278
|
+
* const isTop = true;
|
|
4279
|
+
* const res = await RongIMLib.setConversationToTopInTag(tagId, conversation, isTop);
|
|
4280
|
+
* console.log('Result of setting conversation to top in tag:', res);
|
|
4281
|
+
* ```
|
|
4282
|
+
*/
|
|
4283
|
+
/**
|
|
4284
|
+
* 设置标签中会话置顶
|
|
4285
|
+
* @description 设置在指定标签下置顶的会话。如果根据标签获取会话,可在获取的会话中可以看到该属性。请注意与会话列表中的会话置顶相区分
|
|
4286
|
+
* @category 标签
|
|
4287
|
+
* @param tagId 标签 id
|
|
4288
|
+
* @param conversation 会话
|
|
4289
|
+
* @param status 状态
|
|
4290
|
+
* @example 设置标签中会话置顶示例:
|
|
4291
|
+
* ```ts
|
|
4292
|
+
* const tagId = 'tagId';
|
|
4293
|
+
* const conversation = {
|
|
4294
|
+
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4295
|
+
* targetId: 'targetId',
|
|
4296
|
+
* };
|
|
4297
|
+
* const isTop = true;
|
|
4298
|
+
* const res = await RongIMLib.setConversationToTopInTag(tagId, conversation, isTop);
|
|
4299
|
+
* console.log('设置标签中会话置顶结果:', res);
|
|
4300
|
+
* ```
|
|
4301
|
+
*/
|
|
4302
|
+
declare function setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<RCResult>;
|
|
4303
|
+
|
|
4304
|
+
/** [EN]
|
|
4305
|
+
* TODO(Translation)
|
|
4306
|
+
* @category Interface
|
|
4307
|
+
*/
|
|
4308
|
+
/**
|
|
4309
|
+
* @deprecated - 已废弃,请使用 `ICombineMessageContent` 替代
|
|
4310
|
+
* @category Interface
|
|
4311
|
+
*/
|
|
4312
|
+
declare type ICombineMessageBody = ICombineMessageContent;
|
|
4313
|
+
|
|
4314
|
+
/** [EN]
|
|
4315
|
+
* TODO(Translation)
|
|
4316
|
+
*/
|
|
4317
|
+
/**
|
|
4318
|
+
* 合并转发消息类型
|
|
4319
|
+
*/
|
|
4320
|
+
declare class CombineMessage extends BuiltinMessage<ICombineMessageContent> {
|
|
4321
|
+
constructor(content: ICombineMessageContent);
|
|
4322
|
+
}
|
|
4323
|
+
|
|
4324
|
+
/**
|
|
4325
|
+
* 合并转发消息 v2 版本 Content 结构
|
|
4326
|
+
* @category Type
|
|
4327
|
+
* @hidden
|
|
4328
|
+
* @deprecated - 已废弃,请使用 `ICombineV2MessageContent` 替代
|
|
4329
|
+
*/
|
|
4330
|
+
declare type CombineV2MessageContent = ICombineV2MessageContent;
|
|
4331
|
+
|
|
4332
|
+
/**
|
|
4333
|
+
* 合并转发消息 v2 版本
|
|
4334
|
+
* @since 5.22.0
|
|
4335
|
+
*/
|
|
4336
|
+
declare class CombineV2Message extends BuiltinMessage<ICombineV2MessageContent> {
|
|
4337
|
+
constructor(content: ICombineV2MessageContent);
|
|
4338
|
+
}
|
|
4339
|
+
|
|
4340
|
+
/** [EN]
|
|
4341
|
+
* TODO(Translation)
|
|
4342
|
+
*/
|
|
4343
|
+
/**
|
|
4344
|
+
* 命令消息
|
|
4345
|
+
* @category Interface
|
|
4346
|
+
* @deprecated - 已废弃,请使用 `ICommandMessageContent` 替代
|
|
4347
|
+
*/
|
|
4348
|
+
declare type ICommandMessageBody = ICommandMessageContent;
|
|
4349
|
+
|
|
4350
|
+
/** [EN]
|
|
4351
|
+
* TODO(Translation)
|
|
4352
|
+
*/
|
|
4353
|
+
/**
|
|
4354
|
+
* 命令消息类型
|
|
4355
|
+
*/
|
|
4356
|
+
declare class CommandMessage extends BuiltinMessage<ICommandMessageContent> {
|
|
4357
|
+
constructor(content: ICommandMessageContent);
|
|
4358
|
+
}
|
|
4359
|
+
|
|
4360
|
+
/** [EN]
|
|
4361
|
+
* TODO(Translation)
|
|
4362
|
+
*/
|
|
4363
|
+
/**
|
|
4364
|
+
* 文件消息
|
|
4365
|
+
* @category Interface
|
|
4366
|
+
* @deprecated - 已废弃,请使用 `IFileMessageContent` 替代
|
|
4367
|
+
*/
|
|
4368
|
+
declare type IFileMessageBody = IFileMessageContent;
|
|
4369
|
+
|
|
4370
|
+
declare class FileMessage extends BuiltinMessage<IFileMessageContent> {
|
|
4371
|
+
constructor(content: IFileMessageContent);
|
|
4372
|
+
}
|
|
4373
|
+
|
|
4374
|
+
/** [EN]
|
|
4375
|
+
* @category Interface
|
|
4376
|
+
* @deprecated Please use `IGIFMessageContent` instead.
|
|
4377
|
+
*/
|
|
4378
|
+
/**
|
|
4379
|
+
* @category Interface
|
|
4380
|
+
* @deprecated - 已废弃,请使用 `IGIFMessageContent` 替代
|
|
4381
|
+
*/
|
|
4382
|
+
declare type IGIFMessageBody = IGIFMessageContent;
|
|
4383
|
+
|
|
4384
|
+
declare class GIFMessage extends BuiltinMessage<IGIFMessageContent> {
|
|
4385
|
+
constructor(content: IGIFMessageContent);
|
|
4386
|
+
}
|
|
4387
|
+
|
|
4388
|
+
/** [EN]
|
|
4389
|
+
* @category Interface
|
|
4390
|
+
* @deprecated Please use `IGroupNotificationMessageContent` instead.
|
|
4391
|
+
*/
|
|
4392
|
+
/**
|
|
4393
|
+
* 群组通知消息
|
|
4394
|
+
* @category Interface
|
|
4395
|
+
* @deprecated - 已废弃,请使用 `IGroupNotificationMessageContent` 替代
|
|
4396
|
+
*/
|
|
4397
|
+
declare type IGroupNotificationMessageBody = IGroupNotificationMessageContent;
|
|
4398
|
+
|
|
4399
|
+
declare class GroupNotificationMessage extends BuiltinMessage<IGroupNotificationMessageBody> {
|
|
4400
|
+
constructor(content: IGroupNotificationMessageBody);
|
|
4401
|
+
}
|
|
4402
|
+
|
|
4403
|
+
/** [EN]
|
|
4404
|
+
* Image message
|
|
4405
|
+
* @category Interface
|
|
4406
|
+
*/
|
|
4407
|
+
/**
|
|
4408
|
+
* 图片消息
|
|
4409
|
+
* @category Interface
|
|
4410
|
+
* @deprecated - 已废弃,请使用 `IImageMessageContent` 替代
|
|
4411
|
+
*/
|
|
4412
|
+
declare type IImageMessageBody = IImageMessageContent;
|
|
4413
|
+
|
|
4414
|
+
declare class ImageMessage extends BuiltinMessage<IImageMessageContent> {
|
|
4415
|
+
constructor(content: IImageMessageContent);
|
|
4416
|
+
}
|
|
4417
|
+
|
|
4418
|
+
/** [EN]
|
|
4419
|
+
* Gray bar message
|
|
4420
|
+
* @category Interface
|
|
4421
|
+
*/
|
|
4422
|
+
/**
|
|
4423
|
+
* 小灰条消息
|
|
4424
|
+
* @category Interface
|
|
4425
|
+
* @deprecated - 已废弃,请使用 `IInformationNotificationMessageContent` 替代
|
|
4426
|
+
*/
|
|
4427
|
+
declare type IInformationNotificationMessageBody = IInformationNotificationMessageContent;
|
|
4428
|
+
|
|
4429
|
+
declare class InformationNotificationMessage extends BuiltinMessage<IInformationNotificationMessageContent> {
|
|
4430
|
+
constructor(content: IInformationNotificationMessageContent);
|
|
4431
|
+
}
|
|
4432
|
+
|
|
4433
|
+
/** [EN]
|
|
4434
|
+
* Local message content data
|
|
4435
|
+
* @category Interface
|
|
4436
|
+
*/
|
|
4437
|
+
/**
|
|
4438
|
+
* 位置消息数据
|
|
4439
|
+
* @category Interface
|
|
4440
|
+
* @deprecated - 已废弃,请使用 `ILocationMessageContent` 替代
|
|
4441
|
+
*/
|
|
4442
|
+
declare type ILocationMessageBody = ILocationMessageContent;
|
|
4443
|
+
|
|
4444
|
+
/**
|
|
4445
|
+
* 位置消息
|
|
4446
|
+
*/
|
|
4447
|
+
declare class LocationMessage extends BuiltinMessage<ILocationMessageContent> {
|
|
4448
|
+
constructor(content: ILocationMessageContent);
|
|
4449
|
+
}
|
|
4450
|
+
|
|
4451
|
+
/** [EN]
|
|
4452
|
+
* Quote message content data
|
|
4453
|
+
* @category Interface
|
|
4454
|
+
*/
|
|
4455
|
+
/**
|
|
4456
|
+
* 引用消息
|
|
4457
|
+
* @category Interface
|
|
4458
|
+
* @deprecated - 已废弃,请使用 `IReferenceMessageContent` 替代
|
|
4459
|
+
*/
|
|
4460
|
+
declare type IReferenceMessageBody = IReferenceMessageContent;
|
|
4461
|
+
|
|
4462
|
+
declare class ReferenceMessage extends BuiltinMessage<IReferenceMessageContent> {
|
|
4463
|
+
constructor(content: IReferenceMessageContent);
|
|
4464
|
+
}
|
|
4465
|
+
|
|
4466
|
+
/** [EN]
|
|
4467
|
+
* Rich text message
|
|
4468
|
+
* @category Interface
|
|
4469
|
+
*/
|
|
4470
|
+
/**
|
|
4471
|
+
* 富文本消息
|
|
4472
|
+
* @category Interface
|
|
4473
|
+
* @deprecated - 已废弃,请使用 `IRichContentMessageContent` 替代
|
|
4420
4474
|
*/
|
|
4421
|
-
declare
|
|
4475
|
+
declare type IRichContentMessageBody = IRichContentMessageContent;
|
|
4476
|
+
|
|
4477
|
+
declare class RichContentMessage extends BuiltinMessage<IRichContentMessageContent> {
|
|
4478
|
+
constructor(content: IRichContentMessageContent);
|
|
4479
|
+
}
|
|
4480
|
+
|
|
4422
4481
|
/** [EN]
|
|
4423
|
-
*
|
|
4424
|
-
* @
|
|
4425
|
-
* @category Tag
|
|
4426
|
-
* @param conversation Conversation information, including conversation type, conversation ID, and channelId, of type {@link IConversationOption}
|
|
4427
|
-
* @param tagIds List of tags to be removed
|
|
4428
|
-
* @example Example of removing multiple tags from a specified conversation:
|
|
4429
|
-
* ```ts
|
|
4430
|
-
* const conversation = {
|
|
4431
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4432
|
-
* targetId: 'targetId',
|
|
4433
|
-
* };
|
|
4434
|
-
* const tagIds = ['tagId1', 'tagId2'];
|
|
4435
|
-
* const res = await RongIMLib.removeTagsFromConversation(conversation, tagIds);
|
|
4436
|
-
* console.log('Result of removing multiple tags from a specified conversation:', res);
|
|
4437
|
-
* ```
|
|
4482
|
+
* Short video message content data
|
|
4483
|
+
* @category Interface
|
|
4438
4484
|
*/
|
|
4439
4485
|
/**
|
|
4440
|
-
*
|
|
4441
|
-
* @
|
|
4442
|
-
* @category
|
|
4443
|
-
* @param conversation 会话信息,包含会话类型、会话 ID 和 channelId,类型为 {@link IConversationOption}
|
|
4444
|
-
* @param tagIds 要删除的标签列表
|
|
4445
|
-
* @example 从指定会话中删除多个标签示例:
|
|
4446
|
-
* ```ts
|
|
4447
|
-
* const conversation = {
|
|
4448
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4449
|
-
* targetId: 'targetId',
|
|
4450
|
-
* };
|
|
4451
|
-
* const tagIds = ['tagId1', 'tagId2'];
|
|
4452
|
-
* const res = await RongIMLib.removeTagsFromConversation(conversation, tagIds);
|
|
4453
|
-
* console.log('从指定会话中删除多个标签结果:', res);
|
|
4454
|
-
* ```
|
|
4486
|
+
* 短视频消息 content 数据
|
|
4487
|
+
* @deprecated - 已废弃,请使用 `ISightMessageContent` 替代
|
|
4488
|
+
* @category Interface
|
|
4455
4489
|
*/
|
|
4456
|
-
declare
|
|
4490
|
+
declare type ISightMessageBody = ISightMessageContent;
|
|
4491
|
+
|
|
4457
4492
|
/** [EN]
|
|
4458
|
-
*
|
|
4459
|
-
* @description Removes the specified tag from multiple conversations. This operation only disassociates the tag from the conversations and does not delete the conversation data.
|
|
4460
|
-
* @category Tag
|
|
4461
|
-
* @param tagId The ID of the tag
|
|
4462
|
-
* @param conversations List of conversation information
|
|
4463
|
-
* @example Example of removing a specified tag from multiple conversations:
|
|
4464
|
-
* ```ts
|
|
4465
|
-
* const tagId = 'tagId';
|
|
4466
|
-
* const conversations = [{
|
|
4467
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4468
|
-
* targetId: 'targetId',
|
|
4469
|
-
* }];
|
|
4470
|
-
* const res = await RongIMLib.removeTagFromConversations(tagId, conversations);
|
|
4471
|
-
* console.log('Removed specified tag from multiple conversations:', res);
|
|
4472
|
-
* ```
|
|
4493
|
+
* Short video message
|
|
4473
4494
|
*/
|
|
4474
4495
|
/**
|
|
4475
|
-
*
|
|
4476
|
-
* @description 从多个会话中删除指定的标签,此操作仅解除会话与标签的关系,并不会删除会话数据
|
|
4477
|
-
* @category 标签
|
|
4478
|
-
* @param tagId 标签 ID
|
|
4479
|
-
* @param conversations 会话信息列表
|
|
4480
|
-
* @example 从多个会话中删除指定的标签示例:
|
|
4481
|
-
* ```ts
|
|
4482
|
-
* const tagId = 'tagId';
|
|
4483
|
-
* const conversations = [{
|
|
4484
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4485
|
-
* targetId: 'targetId',
|
|
4486
|
-
* }];
|
|
4487
|
-
* const res = await RongIMLib.removeTagFromConversations(tagId, conversations);
|
|
4488
|
-
* console.log('从多个会话中删除指定的标签:', res);
|
|
4489
|
-
* ```
|
|
4496
|
+
* 短视频消息
|
|
4490
4497
|
*/
|
|
4491
|
-
declare
|
|
4498
|
+
declare class SightMessage extends BuiltinMessage<ISightMessageBody> {
|
|
4499
|
+
constructor(content: ISightMessageBody);
|
|
4500
|
+
}
|
|
4501
|
+
|
|
4502
|
+
/**
|
|
4503
|
+
* 流式消息内容结构
|
|
4504
|
+
* @category Interface
|
|
4505
|
+
* @deprecated - 已废弃,请使用 `IStreamMessageContent` 替代
|
|
4506
|
+
*/
|
|
4507
|
+
declare type IStreamMessageBody = IStreamMessageContent;
|
|
4508
|
+
|
|
4492
4509
|
/** [EN]
|
|
4493
|
-
*
|
|
4494
|
-
*
|
|
4495
|
-
* @param tagId The ID of the tag
|
|
4496
|
-
* @param count The number of conversations to retrieve
|
|
4497
|
-
* @param timestamp The timestamp of the message in the conversation
|
|
4498
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of conversations of type {@link IAReceivedConversationByTag} or undefined
|
|
4499
|
-
* Starting from SDK version @since 5.7.0, the return data type of this interface has changed from {@link IReceivedConversationByTag} to {@link IAReceivedConversationByTag}
|
|
4500
|
-
* @example Example of paginating conversations under a tag:
|
|
4501
|
-
* ```ts
|
|
4502
|
-
* const tagId = 'tagId';
|
|
4503
|
-
* const count = 10;
|
|
4504
|
-
* const timestamp = 0;
|
|
4505
|
-
* const res = await RongIMLib.getConversationsFromTagByPage(tagId, count, timestamp);
|
|
4506
|
-
* console.log('Result of paginating conversations under a tag:', res);
|
|
4507
|
-
* ```
|
|
4510
|
+
* Text message content data
|
|
4511
|
+
* @category Interface
|
|
4508
4512
|
*/
|
|
4509
4513
|
/**
|
|
4510
|
-
*
|
|
4511
|
-
* @
|
|
4512
|
-
* @
|
|
4513
|
-
* @param count 数量
|
|
4514
|
-
* @param timestamp 分页起始时间戳
|
|
4515
|
-
* @returns 返回一个 Promise<{@link RCResult}> 实例,data 为会话列表,类型为 {@link IAReceivedConversationByTag} 数组。
|
|
4516
|
-
* 从 SDK 5.7.0 版本开始该接口的返回数据类型由 {@link IReceivedConversationByTag} 变更为 {@link IAReceivedConversationByTag}
|
|
4517
|
-
* @example 分页获取标签下会话列表示例:
|
|
4518
|
-
* ```ts
|
|
4519
|
-
* const tagId = 'tagId';
|
|
4520
|
-
* const count = 10;
|
|
4521
|
-
* const timestamp = 0;
|
|
4522
|
-
* const res = await RongIMLib.getConversationsFromTagByPage(tagId, count, timestamp);
|
|
4523
|
-
* console.log('分页获取标签下会话列表结果:', res);
|
|
4524
|
-
* ```
|
|
4514
|
+
* 文本消息 content 数据
|
|
4515
|
+
* @deprecated - 已废弃,请使用 `ITextMessageContent` 替代
|
|
4516
|
+
* @category Interface
|
|
4525
4517
|
*/
|
|
4526
|
-
declare
|
|
4518
|
+
declare type ITextMessageBody = ITextMessageContent;
|
|
4519
|
+
|
|
4520
|
+
declare class TextMessage extends BuiltinMessage<ITextMessageContent> {
|
|
4521
|
+
constructor(content: ITextMessageContent);
|
|
4522
|
+
}
|
|
4523
|
+
|
|
4527
4524
|
/** [EN]
|
|
4528
|
-
*
|
|
4529
|
-
* @category
|
|
4530
|
-
* @param tagId The ID of the tag
|
|
4531
|
-
* @param containMuted Indicates whether to include muted conversations
|
|
4532
|
-
* @example Example of getting the unread message count by tag:
|
|
4533
|
-
* ```ts
|
|
4534
|
-
* const tagId = 'tagId';
|
|
4535
|
-
* const containMuted = false;
|
|
4536
|
-
* const res = await RongIMLib.getUnreadCountByTag(tagId, containMuted);
|
|
4537
|
-
* console.log('Result of getting the unread message count by tag:', res);
|
|
4538
|
-
* ```
|
|
4525
|
+
* Voice Message content data
|
|
4526
|
+
* @category Interface
|
|
4539
4527
|
*/
|
|
4540
4528
|
/**
|
|
4541
|
-
*
|
|
4542
|
-
* @category
|
|
4543
|
-
* @
|
|
4544
|
-
* @param containMuted 是否包含免打扰
|
|
4545
|
-
* @example 根据标签获取未读消息数示例:
|
|
4546
|
-
* ```ts
|
|
4547
|
-
* const tagId = 'tagId';
|
|
4548
|
-
* const containMuted = false;
|
|
4549
|
-
* const res = await RongIMLib.getUnreadCountByTag(tagId, containMuted);
|
|
4550
|
-
* console.log('根据标签获取未读消息数结果:', res);
|
|
4551
|
-
* ```
|
|
4529
|
+
* 高清语音消息 content 数据
|
|
4530
|
+
* @category Interface
|
|
4531
|
+
* @deprecated - 已废弃,使用 IHQVoiceMessageContent 代替
|
|
4552
4532
|
*/
|
|
4553
|
-
declare
|
|
4554
|
-
/**
|
|
4555
|
-
*
|
|
4556
|
-
* @description Sets a conversation to be pinned under a specified tag. When retrieving conversations by tag, this property will be visible in the retrieved conversations. Note that this is distinct from pinning conversations in the conversation list.
|
|
4557
|
-
* @category Tag
|
|
4558
|
-
* @param tagId The tag ID
|
|
4559
|
-
* @param conversation The conversation
|
|
4560
|
-
* @param status The status
|
|
4561
|
-
* @example Example of setting a conversation to be pinned in a tag:
|
|
4562
|
-
* ```ts
|
|
4563
|
-
* const tagId = 'tagId';
|
|
4564
|
-
* const conversation = {
|
|
4565
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4566
|
-
* targetId: 'targetId',
|
|
4567
|
-
* };
|
|
4568
|
-
* const isTop = true;
|
|
4569
|
-
* const res = await RongIMLib.setConversationToTopInTag(tagId, conversation, isTop);
|
|
4570
|
-
* console.log('Result of setting conversation to top in tag:', res);
|
|
4571
|
-
* ```
|
|
4533
|
+
declare type IHQVoiceMessageBody = IHQVoiceMessageContent;
|
|
4534
|
+
/**
|
|
4535
|
+
* 高清语音消息类型
|
|
4572
4536
|
*/
|
|
4537
|
+
declare class HQVoiceMessage extends BuiltinMessage<IHQVoiceMessageContent> {
|
|
4538
|
+
constructor(content: IHQVoiceMessageContent);
|
|
4539
|
+
}
|
|
4573
4540
|
/**
|
|
4574
|
-
*
|
|
4575
|
-
* @
|
|
4576
|
-
* @
|
|
4577
|
-
* @param tagId 标签 id
|
|
4578
|
-
* @param conversation 会话
|
|
4579
|
-
* @param status 状态
|
|
4580
|
-
* @example 设置标签中会话置顶示例:
|
|
4581
|
-
* ```ts
|
|
4582
|
-
* const tagId = 'tagId';
|
|
4583
|
-
* const conversation = {
|
|
4584
|
-
* conversationType: RongIMLib.ConversationType.PRIVATE,
|
|
4585
|
-
* targetId: 'targetId',
|
|
4586
|
-
* };
|
|
4587
|
-
* const isTop = true;
|
|
4588
|
-
* const res = await RongIMLib.setConversationToTopInTag(tagId, conversation, isTop);
|
|
4589
|
-
* console.log('设置标签中会话置顶结果:', res);
|
|
4590
|
-
* ```
|
|
4541
|
+
* 语音消息 content 数据
|
|
4542
|
+
* @category Interface
|
|
4543
|
+
* @deprecated - 已废弃,使用 IVoiceMessageContent 代替
|
|
4591
4544
|
*/
|
|
4592
|
-
declare
|
|
4545
|
+
declare type IVoiceMessageBody = IVoiceMessageContent;
|
|
4546
|
+
declare class VoiceMessage extends BuiltinMessage<IVoiceMessageContent> {
|
|
4547
|
+
constructor(content: IVoiceMessageContent);
|
|
4548
|
+
}
|
|
4593
4549
|
|
|
4594
4550
|
/**
|
|
4595
4551
|
* 创建文件上传任务
|
|
@@ -4597,19 +4553,19 @@ declare function setConversationToTopInTag(tagId: string, conversation: IConvers
|
|
|
4597
4553
|
* @hidden
|
|
4598
4554
|
* @returns
|
|
4599
4555
|
*/
|
|
4600
|
-
declare function createUploadTask(uploadInfo: IUploadInfo): Promise<
|
|
4556
|
+
declare function createUploadTask(uploadInfo: IUploadInfo): Promise<RCResult<UploadTask>>;
|
|
4601
4557
|
/**
|
|
4602
4558
|
* 停止文件上传任务
|
|
4603
4559
|
* @hidden
|
|
4604
4560
|
* @param taskId
|
|
4605
4561
|
* @returns
|
|
4606
4562
|
*/
|
|
4607
|
-
declare function stopUploadTask(taskId: number): Promise<
|
|
4563
|
+
declare function stopUploadTask(taskId: number): Promise<RCResult<boolean>>;
|
|
4608
4564
|
/**
|
|
4609
4565
|
* 上传文件
|
|
4610
4566
|
* @hidden
|
|
4611
4567
|
*/
|
|
4612
|
-
declare function upload(uploadInfo: IUploadInfo): Promise<
|
|
4568
|
+
declare function upload(uploadInfo: IUploadInfo): Promise<RCResult<IUploadResult>>;
|
|
4613
4569
|
/**
|
|
4614
4570
|
* 获取文件 token
|
|
4615
4571
|
* @description 上传文件时,获取文件 token
|
|
@@ -4624,7 +4580,7 @@ declare function upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResul
|
|
|
4624
4580
|
* filename 为第一个步骤生成的 filename
|
|
4625
4581
|
* 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`,filename 为第一个步骤生成的 filename
|
|
4626
4582
|
*/
|
|
4627
|
-
declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<
|
|
4583
|
+
declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<RCResult<IUploadAuth & {
|
|
4628
4584
|
qiniu: string;
|
|
4629
4585
|
ossConfig: string;
|
|
4630
4586
|
}>>;
|
|
@@ -4636,7 +4592,7 @@ declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?
|
|
|
4636
4592
|
* token: 原 RCX 存储鉴权 token,优先使用
|
|
4637
4593
|
* downloadAuthInfo: RCX 升级后,公有云私有化部署的下载鉴权信息
|
|
4638
4594
|
*/
|
|
4639
|
-
declare function getDownloadAuth(url: string): Promise<
|
|
4595
|
+
declare function getDownloadAuth(url: string): Promise<RCResult<{
|
|
4640
4596
|
deadline: number;
|
|
4641
4597
|
token?: string;
|
|
4642
4598
|
downloadAuthInfo?: IDownloadAuth;
|
|
@@ -4654,7 +4610,7 @@ declare function getDownloadAuth(url: string): Promise<IAsyncRes<{
|
|
|
4654
4610
|
declare function getFileUrl(fileType: FileType, filename: string, saveName?: string, _?: {
|
|
4655
4611
|
isBosRes: boolean;
|
|
4656
4612
|
downloadUrl: string;
|
|
4657
|
-
}, serverType?: UploadMethod): Promise<
|
|
4613
|
+
}, serverType?: UploadMethod): Promise<RCResult<{
|
|
4658
4614
|
downloadUrl: string;
|
|
4659
4615
|
}>>;
|
|
4660
4616
|
|
|
@@ -5176,7 +5132,7 @@ declare function setMessageStatusToRead(conversation: IConversationOption, times
|
|
|
5176
5132
|
* @since 5.4.0
|
|
5177
5133
|
* @deprecated @since 5.9.3 MLib SDK 版本 ≧ 5.9.3,建议使用 {@link setMessageReceivedStatusInfo} 接口替换
|
|
5178
5134
|
*/
|
|
5179
|
-
declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<
|
|
5135
|
+
declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<RCResult>;
|
|
5180
5136
|
/** [EN]
|
|
5181
5137
|
* Set the received status of a message
|
|
5182
5138
|
* @category Electron Only
|
|
@@ -5217,7 +5173,7 @@ declare function setMessageReceivedStatus(messageId: number, receivedStatus: Rec
|
|
|
5217
5173
|
* console.info('设置消息的接收状态结果:', res);
|
|
5218
5174
|
* ```
|
|
5219
5175
|
*/
|
|
5220
|
-
declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<
|
|
5176
|
+
declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<RCResult>;
|
|
5221
5177
|
/** [EN]
|
|
5222
5178
|
* Set the sending status of a message
|
|
5223
5179
|
* @category Electron Only
|
|
@@ -5250,7 +5206,7 @@ declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusI
|
|
|
5250
5206
|
* console.info('设置消息的发送状态结果:', res);
|
|
5251
5207
|
* ```
|
|
5252
5208
|
*/
|
|
5253
|
-
declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<
|
|
5209
|
+
declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<RCResult>;
|
|
5254
5210
|
/** [EN]
|
|
5255
5211
|
* Modify message content
|
|
5256
5212
|
* @category Electron only
|
|
@@ -5598,7 +5554,7 @@ declare function getMessageCount(conversation: IConversationOption): Promise<RCR
|
|
|
5598
5554
|
* console.info('设置融云消息重排开关结果:', res);
|
|
5599
5555
|
* ```
|
|
5600
5556
|
*/
|
|
5601
|
-
declare function setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<
|
|
5557
|
+
declare function setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<RCResult<boolean>>;
|
|
5602
5558
|
/** [EN]
|
|
5603
5559
|
* Set chatroom message deduplication switch
|
|
5604
5560
|
* @category Electron Only
|
|
@@ -5771,7 +5727,7 @@ declare function getUnreadMentionedMessages(conversation: IConversationOption):
|
|
|
5771
5727
|
* @description This method is used to clear local data, including message lists, conversation lists, and the timestamp of pulled messages.
|
|
5772
5728
|
* **Note**: After clearing, logging in again will be treated as a new device for message pulling, and the operation cannot be restored. Use with caution.
|
|
5773
5729
|
* @since 5.4.0
|
|
5774
|
-
* @returns Returns a {@link
|
|
5730
|
+
* @returns Returns a {@link RCResult} type Promise, where data is of boolean type, indicating whether the clearing was successful.
|
|
5775
5731
|
* @example
|
|
5776
5732
|
* Example of clearing local data:
|
|
5777
5733
|
* ```ts
|
|
@@ -5785,7 +5741,7 @@ declare function getUnreadMentionedMessages(conversation: IConversationOption):
|
|
|
5785
5741
|
* @description 该方法用于清除本地数据,包括消息列表、会话列表、拉取消息的时间戳
|
|
5786
5742
|
* **注意**:清除后在此登录会作为新设备进行消息拉取切操作无法恢复,谨慎使用
|
|
5787
5743
|
* @since 5.4.0
|
|
5788
|
-
* @returns 返回一个 {@link
|
|
5744
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 为 boolean 类型,表示是否清除成功
|
|
5789
5745
|
* @example
|
|
5790
5746
|
* 清除本地数据示例:
|
|
5791
5747
|
* ```ts
|
|
@@ -5903,14 +5859,14 @@ declare namespace index {
|
|
|
5903
5859
|
* @since 5.7.0
|
|
5904
5860
|
* @param proxy 代理信息
|
|
5905
5861
|
*/
|
|
5906
|
-
declare function setProxy(proxy: IProxy | null):
|
|
5862
|
+
declare function setProxy(proxy: IProxy | null): Promise<RCResult>;
|
|
5907
5863
|
/**
|
|
5908
5864
|
* 获取代理
|
|
5909
5865
|
* @hidden
|
|
5910
5866
|
* @since 5.7.0
|
|
5911
5867
|
* @returns
|
|
5912
5868
|
*/
|
|
5913
|
-
declare function getProxy():
|
|
5869
|
+
declare function getProxy(): Promise<RCResult<IProxy>>;
|
|
5914
5870
|
/**
|
|
5915
5871
|
* 测试代理
|
|
5916
5872
|
* @hidden
|
|
@@ -5918,7 +5874,7 @@ declare function getProxy(): IPromiseResult<IProxy>;
|
|
|
5918
5874
|
* @param proxy 代理信息
|
|
5919
5875
|
* @param testHost 测试代理地址
|
|
5920
5876
|
*/
|
|
5921
|
-
declare function testProxy(proxy: IProxy, testHost: string):
|
|
5877
|
+
declare function testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
|
|
5922
5878
|
|
|
5923
5879
|
/** [EN]
|
|
5924
5880
|
* Subscribe user status
|
|
@@ -5930,7 +5886,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
|
|
|
5930
5886
|
* @param userIds List of user IDs to be subscribed to, with a maximum of 200 users per subscription.
|
|
5931
5887
|
* @param subscribeType Subscription type.
|
|
5932
5888
|
* @param expiry Subscription validity period, ranging from [60,2592000] (unit: seconds).
|
|
5933
|
-
* @returns Returns a {@link
|
|
5889
|
+
* @returns Returns a {@link RCResult} type Promise. When the subscription error is 26021, it returns a list of user IDs that have reached the subscription limit (a user can be subscribed to by a maximum of 5000 users).
|
|
5934
5890
|
* @since 5.9.8
|
|
5935
5891
|
* @example Example of subscribing to user status:
|
|
5936
5892
|
* ```ts
|
|
@@ -5952,7 +5908,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
|
|
|
5952
5908
|
* @param userIds 被订阅用户 ID 列表,一次最多订阅 200 个用户
|
|
5953
5909
|
* @param subscribeType 订阅类型
|
|
5954
5910
|
* @param expiry 订阅有效期,取值范围为 [60,2592000](单位:秒)
|
|
5955
|
-
* @returns 返回一个 {@link
|
|
5911
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,订阅错误为 26021 时返回被订阅达上限(用户最多可以被 5000 个用户订阅)的用户 ID 列表
|
|
5956
5912
|
* @since 5.9.8
|
|
5957
5913
|
* @example 订阅用户状态示例:
|
|
5958
5914
|
* ```ts
|
|
@@ -5964,7 +5920,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
|
|
|
5964
5920
|
* console.log('订阅用户状态结果:', res);
|
|
5965
5921
|
* ```
|
|
5966
5922
|
*/
|
|
5967
|
-
declare function subscribeUserStatus(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<
|
|
5923
|
+
declare function subscribeUserStatus(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
|
|
5968
5924
|
/** [EN]
|
|
5969
5925
|
* Unsubscribe user status
|
|
5970
5926
|
* @category Subscription user status
|
|
@@ -5995,14 +5951,13 @@ declare function subscribeUserStatus(userIds: string[], subscribeType: Subscribe
|
|
|
5995
5951
|
* console.log('取消订阅用户状态结果:', res);
|
|
5996
5952
|
* ```
|
|
5997
5953
|
*/
|
|
5998
|
-
declare function unSubscribeUserStatus(userIds: string[], subscribeType: SubscribeType): Promise<
|
|
5954
|
+
declare function unSubscribeUserStatus(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
|
|
5999
5955
|
/** [EN]
|
|
6000
5956
|
* Paginate and query the status information of subscribed users
|
|
6001
5957
|
* @category Subscription user status
|
|
6002
5958
|
* @description This method is used to retrieve the status information of all currently subscribed events (only supports online status type)
|
|
6003
5959
|
* @param pageSize The number of items per page
|
|
6004
5960
|
* @param offset The pagination offset
|
|
6005
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where data is an array of type {@link ISubscribeUserStatusInfo}
|
|
6006
5961
|
* @since 5.9.8
|
|
6007
5962
|
* @example Example of paginating and querying the status information of subscribed users:
|
|
6008
5963
|
* ```ts
|
|
@@ -6019,7 +5974,6 @@ declare function unSubscribeUserStatus(userIds: string[], subscribeType: Subscri
|
|
|
6019
5974
|
* @description 此方法用于获取当前所有订阅的事件的状态信息(仅支持在线状态类型)
|
|
6020
5975
|
* @param pageSize 数量
|
|
6021
5976
|
* @param offset 分页偏移量
|
|
6022
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
|
|
6023
5977
|
* @since 5.9.8
|
|
6024
5978
|
* @example 分页查询已订阅用户的状态信息示例:
|
|
6025
5979
|
* ```ts
|
|
@@ -6030,13 +5984,12 @@ declare function unSubscribeUserStatus(userIds: string[], subscribeType: Subscri
|
|
|
6030
5984
|
* console.log('分页查询已订阅用户的状态信息结果:', res);
|
|
6031
5985
|
* ```
|
|
6032
5986
|
*/
|
|
6033
|
-
declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: number, offset: number): Promise<
|
|
5987
|
+
declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
|
|
6034
5988
|
/** [EN]
|
|
6035
5989
|
* Query subscription status information
|
|
6036
5990
|
* @category Subscription user status
|
|
6037
5991
|
* @description Queries the status information of specified users and subscription types. A maximum of 200 users' status information can be queried at once.
|
|
6038
5992
|
* @param userIds List of subscribed user IDs. The list cannot be empty, and a maximum of 200 users' status information can be queried at once.
|
|
6039
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of type {@link ISubscribeUserStatusInfo}.
|
|
6040
5993
|
* @since 5.9.8
|
|
6041
5994
|
* @example Example of querying subscription status information:
|
|
6042
5995
|
* ```ts
|
|
@@ -6051,7 +6004,6 @@ declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: nu
|
|
|
6051
6004
|
* @category 订阅用户状态
|
|
6052
6005
|
* @description 查询指定用户和订阅类型的状态信息。一次最多查询 200 个用户的状态信息
|
|
6053
6006
|
* @param userIds 被订阅用户 ID 列表,列表不可为空,且一次最多查询 200 个用户的状态信息
|
|
6054
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
|
|
6055
6007
|
* @since 5.9.8
|
|
6056
6008
|
* @example 查询订阅状态信息示例:
|
|
6057
6009
|
* ```ts
|
|
@@ -6067,23 +6019,22 @@ declare function getSubscribeUserStatus(subscribeType: SubscribeType, userIds: s
|
|
|
6067
6019
|
* @category User profile
|
|
6068
6020
|
* @description This method is used to update the profile information of the current user.
|
|
6069
6021
|
* @param profile User profile information
|
|
6070
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type { errorKey: string }
|
|
6071
6022
|
* @since 5.10.1
|
|
6072
6023
|
* @example Example of updating user profile:
|
|
6073
6024
|
* ```ts
|
|
6074
6025
|
* const profile = {
|
|
6075
|
-
*
|
|
6076
|
-
*
|
|
6077
|
-
*
|
|
6078
|
-
*
|
|
6079
|
-
*
|
|
6080
|
-
*
|
|
6081
|
-
*
|
|
6082
|
-
*
|
|
6083
|
-
*
|
|
6084
|
-
*
|
|
6085
|
-
*
|
|
6086
|
-
*
|
|
6026
|
+
* name: 'name',
|
|
6027
|
+
* portraitUri: 'portraitUri',
|
|
6028
|
+
* email: 'email',
|
|
6029
|
+
* birthday: 'birthday',
|
|
6030
|
+
* gender: 1,
|
|
6031
|
+
* location: 'location',
|
|
6032
|
+
* role: 1,
|
|
6033
|
+
* level: 1,
|
|
6034
|
+
* extraProfile: {
|
|
6035
|
+
* key1: 'value1',
|
|
6036
|
+
* key2: 'value2',
|
|
6037
|
+
* },
|
|
6087
6038
|
* }
|
|
6088
6039
|
* const res = await RongIMLib.updateMyUserProfile(profile);
|
|
6089
6040
|
* console.log('User profile update result:', res);
|
|
@@ -6094,35 +6045,33 @@ declare function getSubscribeUserStatus(subscribeType: SubscribeType, userIds: s
|
|
|
6094
6045
|
* @category 用户资料
|
|
6095
6046
|
* @description 此方法用于更新当前用户的资料信息
|
|
6096
6047
|
* @param profile 用户资料信息
|
|
6097
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 { errorKey: string } 类型
|
|
6098
6048
|
* @since 5.10.1
|
|
6099
6049
|
* @example 更新用户资料示例:
|
|
6100
6050
|
* ```ts
|
|
6101
6051
|
* const profile = {
|
|
6102
|
-
*
|
|
6103
|
-
*
|
|
6104
|
-
*
|
|
6105
|
-
*
|
|
6106
|
-
*
|
|
6107
|
-
*
|
|
6108
|
-
*
|
|
6109
|
-
*
|
|
6110
|
-
*
|
|
6111
|
-
*
|
|
6112
|
-
*
|
|
6113
|
-
*
|
|
6052
|
+
* name: 'name',
|
|
6053
|
+
* portraitUri: 'portraitUri',
|
|
6054
|
+
* email: 'email',
|
|
6055
|
+
* birthday: 'birthday',
|
|
6056
|
+
* gender: 1,
|
|
6057
|
+
* location: 'location',
|
|
6058
|
+
* role: 1,
|
|
6059
|
+
* level: 1,
|
|
6060
|
+
* extraProfile: {
|
|
6061
|
+
* key1: 'value1',
|
|
6062
|
+
* key2: 'value2',
|
|
6063
|
+
* },
|
|
6114
6064
|
* }
|
|
6115
6065
|
* const res = await RongIMLib.updateMyUserProfile(profile);
|
|
6116
6066
|
* console.log('更新用户资料结果:', res);
|
|
6117
6067
|
* ```
|
|
6118
6068
|
*/
|
|
6119
|
-
declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<
|
|
6069
|
+
declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
|
|
6120
6070
|
/** [EN]
|
|
6121
6071
|
* Batch get user profiles
|
|
6122
6072
|
* @category User profiles
|
|
6123
6073
|
* @description This method is used to batch retrieve user profile information.
|
|
6124
6074
|
* @param userIds List of user IDs, with a maximum of 100 IDs per request
|
|
6125
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of type {@link IUserProfileInfo}
|
|
6126
6075
|
* @since 5.10.1
|
|
6127
6076
|
* @example Example of batch retrieving user profiles:
|
|
6128
6077
|
* ```ts
|
|
@@ -6136,7 +6085,6 @@ declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncR
|
|
|
6136
6085
|
* @category 用户资料
|
|
6137
6086
|
* @description 此方法用于批量获取用户的资料信息
|
|
6138
6087
|
* @param userIds 用户 ID 列表,一次最多获取 100 个
|
|
6139
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link IUserProfileInfo} 类型数组
|
|
6140
6088
|
* @since 5.10.1
|
|
6141
6089
|
* @example 批量获取用户资料示例:
|
|
6142
6090
|
* ```ts
|
|
@@ -6145,12 +6093,11 @@ declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncR
|
|
|
6145
6093
|
* console.log('批量获取用户资料结果:', res);
|
|
6146
6094
|
* ```
|
|
6147
6095
|
*/
|
|
6148
|
-
declare function getUserProfiles(userIds: string[]): Promise<
|
|
6096
|
+
declare function getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfileInfo[]>>;
|
|
6149
6097
|
/** [EN]
|
|
6150
6098
|
* Get current user profile
|
|
6151
6099
|
* @category User profile
|
|
6152
6100
|
* @description This method is used to retrieve the profile information of the current user.
|
|
6153
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IUserProfileInfo}.
|
|
6154
6101
|
* @since 5.10.1
|
|
6155
6102
|
* @example Example of getting the current user profile:
|
|
6156
6103
|
* ```ts
|
|
@@ -6162,7 +6109,6 @@ declare function getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProf
|
|
|
6162
6109
|
* 获取当前用户资料
|
|
6163
6110
|
* @category 用户资料
|
|
6164
6111
|
* @description 此方法用于获取当前用户的资料信息
|
|
6165
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link IUserProfileInfo} 类型
|
|
6166
6112
|
* @since 5.10.1
|
|
6167
6113
|
* @example 获取当前用户资料示例:
|
|
6168
6114
|
* ```ts
|
|
@@ -6170,13 +6116,12 @@ declare function getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProf
|
|
|
6170
6116
|
* console.log('获取当前用户资料结果:', res);
|
|
6171
6117
|
* ```
|
|
6172
6118
|
*/
|
|
6173
|
-
declare function getMyUserProfile(): Promise<
|
|
6119
|
+
declare function getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
|
|
6174
6120
|
/** [EN]
|
|
6175
6121
|
* User permission settings
|
|
6176
6122
|
* @category User profile
|
|
6177
6123
|
* @description This method is used to set user information permissions.
|
|
6178
6124
|
* @param Visibility User information permissions
|
|
6179
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where data is of type void
|
|
6180
6125
|
* @since 5.10.1
|
|
6181
6126
|
* @example Example of user permission settings:
|
|
6182
6127
|
* ```ts
|
|
@@ -6190,7 +6135,6 @@ declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
|
6190
6135
|
* @category 用户资料
|
|
6191
6136
|
* @description 此方法用于设置用户信息权限
|
|
6192
6137
|
* @param Visibility 用户信息权限
|
|
6193
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 void 类型
|
|
6194
6138
|
* @since 5.10.1
|
|
6195
6139
|
* @example 用户权限设置示例:
|
|
6196
6140
|
* ```ts
|
|
@@ -6199,12 +6143,11 @@ declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
|
|
|
6199
6143
|
* console.log('用户权限设置结果:', res);
|
|
6200
6144
|
* ```
|
|
6201
6145
|
*/
|
|
6202
|
-
declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<
|
|
6146
|
+
declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
|
|
6203
6147
|
/** [EN]
|
|
6204
6148
|
* User permission acquisition
|
|
6205
6149
|
* @category User profile
|
|
6206
6150
|
* @description This method is used to acquire user information permissions.
|
|
6207
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link UserProfileVisibility}.
|
|
6208
6151
|
* @since 5.10.1
|
|
6209
6152
|
* @example Example of user permission acquisition:
|
|
6210
6153
|
* ```ts
|
|
@@ -6216,7 +6159,6 @@ declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility
|
|
|
6216
6159
|
* 用户权限获取
|
|
6217
6160
|
* @category 用户资料
|
|
6218
6161
|
* @description 此方法用于获取用户信息权限
|
|
6219
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link UserProfileVisibility} 类型
|
|
6220
6162
|
* @since 5.10.1
|
|
6221
6163
|
* @example 用户权限获取示例:
|
|
6222
6164
|
* ```ts
|
|
@@ -6224,13 +6166,12 @@ declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility
|
|
|
6224
6166
|
* console.log('用户权限获取结果:', res);
|
|
6225
6167
|
* ```
|
|
6226
6168
|
*/
|
|
6227
|
-
declare function getMyUserProfileVisibility(): Promise<
|
|
6169
|
+
declare function getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
|
|
6228
6170
|
/** [EN]
|
|
6229
6171
|
* Search for user information by unique application ID
|
|
6230
6172
|
* @category User profile
|
|
6231
6173
|
* @description This method is used to search for user information by unique application ID.
|
|
6232
6174
|
* @param uniqueId The user's unique application ID
|
|
6233
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IUserProfileInfo}
|
|
6234
6175
|
* @since 5.10.1
|
|
6235
6176
|
* @example Example of searching for user information by unique application ID:
|
|
6236
6177
|
* ```ts
|
|
@@ -6244,7 +6185,6 @@ declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisi
|
|
|
6244
6185
|
* @category 用户资料
|
|
6245
6186
|
* @description 此方法用于按用户应用号精确搜索用户信息
|
|
6246
6187
|
* @param uniqueId 用户应用号
|
|
6247
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link IUserProfileInfo} 类型
|
|
6248
6188
|
* @since 5.10.1
|
|
6249
6189
|
* @example 按用户应用号精确搜索用户信息示例:
|
|
6250
6190
|
* ```ts
|
|
@@ -6253,7 +6193,7 @@ declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisi
|
|
|
6253
6193
|
* console.log('按用户应用号精确搜索用户信息结果:', res);
|
|
6254
6194
|
* ```
|
|
6255
6195
|
*/
|
|
6256
|
-
declare function searchUserProfileByUniqueId(uniqueId: string): Promise<
|
|
6196
|
+
declare function searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
|
|
6257
6197
|
/**
|
|
6258
6198
|
* 获取订阅用户在线状态
|
|
6259
6199
|
* @param userIds
|
|
@@ -6268,10 +6208,9 @@ declare function getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCRes
|
|
|
6268
6208
|
* <strong>Note: <br>
|
|
6269
6209
|
* Group ID (id) and group name (name) are required fields; otherwise, the API call will fail.
|
|
6270
6210
|
* @param groupInfo Group information. {$link IGroupInfoOption}
|
|
6271
|
-
* @param inviteeUserIds An array of user IDs to be added to the group. A maximum of
|
|
6211
|
+
* @param inviteeUserIds An array of user IDs to be added to the group. A maximum of 30 users can be added at once. (Optional)
|
|
6272
6212
|
* @category Group
|
|
6273
6213
|
* @since 5.12.0
|
|
6274
|
-
|
|
6275
6214
|
*/
|
|
6276
6215
|
/**
|
|
6277
6216
|
* 创建群组
|
|
@@ -6280,18 +6219,17 @@ declare function getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCRes
|
|
|
6280
6219
|
* <strong>注意:<br>
|
|
6281
6220
|
* 群 ID(id)、群名称(name)必填,否则接口调用失败。
|
|
6282
6221
|
* @param groupInfo 群信息。{$link IGroupInfoOption}
|
|
6283
|
-
* @param inviteeUserIds 加入群组的用户 ID
|
|
6222
|
+
* @param inviteeUserIds 加入群组的用户 ID 数组,最大有效长度为 30。(非必填)
|
|
6284
6223
|
* @category 群组
|
|
6285
6224
|
* @since 5.12.0
|
|
6286
6225
|
*/
|
|
6287
|
-
declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<
|
|
6226
|
+
declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
|
|
6288
6227
|
/** [EN]
|
|
6289
6228
|
* Set group information
|
|
6290
6229
|
* @description To create a group via the client, you need to enable the `User Profile Hosting` and `Allow SDK to Create, Set Group Information and Permissions` services. This feature is not supported if these services are not enabled.
|
|
6291
6230
|
* @param groupInfo {@link IGroupInfoOption} Configuration for setting group information
|
|
6292
6231
|
* @category Group
|
|
6293
6232
|
* @since 5.12.0
|
|
6294
|
-
|
|
6295
6233
|
*/
|
|
6296
6234
|
/**
|
|
6297
6235
|
* 设置群资料
|
|
@@ -6300,25 +6238,22 @@ declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: strin
|
|
|
6300
6238
|
* @category 群组
|
|
6301
6239
|
* @since 5.12.0
|
|
6302
6240
|
*/
|
|
6303
|
-
declare function updateGroupInfo(groupInfo: IGroupInfoOption): Promise<
|
|
6241
|
+
declare function updateGroupInfo(groupInfo: IGroupInfoOption): Promise<RCResult<IErrorKeys>>;
|
|
6304
6242
|
/** [EN]
|
|
6305
6243
|
* Batch get group information
|
|
6306
6244
|
* @description To create a group, the client must have the `User Profile Hosting` feature enabled. This feature is not supported if the feature is not enabled. It supports retrieving information for all existing groups.
|
|
6307
6245
|
* @param groupIds An array of group IDs. A single query supports up to 20 groups.
|
|
6308
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IGroupInfoOption}.
|
|
6309
6246
|
* @category Group
|
|
6310
6247
|
* @since 5.12.0
|
|
6311
|
-
|
|
6312
6248
|
*/
|
|
6313
6249
|
/**
|
|
6314
6250
|
* 批量获取群组信息
|
|
6315
6251
|
* @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能,支持获取已存在的所有群组信息
|
|
6316
6252
|
* @param groupIds 群 ID 数组,单次查询最多支持 20 个群组。
|
|
6317
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupInfoOption} 类型
|
|
6318
6253
|
* @category 群组
|
|
6319
6254
|
* @since 5.12.0
|
|
6320
6255
|
*/
|
|
6321
|
-
declare function getGroupsInfo(groupIds: string[]): Promise<
|
|
6256
|
+
declare function getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
6322
6257
|
/** [EN]
|
|
6323
6258
|
* Remove group members
|
|
6324
6259
|
* @description Requires enabling `User Profile Hosting` and `Allow Removing Group Members via SDK` features. Otherwise, this feature is not supported.
|
|
@@ -6327,18 +6262,17 @@ declare function getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo
|
|
|
6327
6262
|
* @param config Configuration for removing group members. Refer to {@link IQuitGroupConfig}.
|
|
6328
6263
|
* @category Group
|
|
6329
6264
|
* @since 5.12.0
|
|
6330
|
-
|
|
6331
6265
|
*/
|
|
6332
6266
|
/**
|
|
6333
6267
|
* 踢出群组成员
|
|
6334
|
-
* @description 需要开启 `信息托管功能` 和 `允许通过 SDK
|
|
6268
|
+
* @description 需要开启 `信息托管功能` 和 `允许通过 SDK 踢出群成员` 功能,否则不支持此功能
|
|
6335
6269
|
* @param groupId 群组 Id。
|
|
6336
6270
|
* @param userIds 群成员 Id 数组。支持批量操作,单次上限为 100 个。
|
|
6337
6271
|
* @param config 踢出群组配置。参照{@link IQuitGroupConfig}
|
|
6338
6272
|
* @category 群组
|
|
6339
6273
|
* @since 5.12.0
|
|
6340
6274
|
*/
|
|
6341
|
-
declare function kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<
|
|
6275
|
+
declare function kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<RCResult>;
|
|
6342
6276
|
/** [EN]
|
|
6343
6277
|
* Quit group
|
|
6344
6278
|
* @description To create a group, the client must have the `User Profile Hosting` feature enabled. If this feature is not enabled, the functionality is not supported. After a user quits the group, the group conversation information is retained, but the user will no longer receive messages from this group. Local historical messages are not deleted.
|
|
@@ -6361,7 +6295,7 @@ declare function kickGroupMembers(groupId: string, userIds: string[], config?: I
|
|
|
6361
6295
|
* @category 群组
|
|
6362
6296
|
* @since 5.12.0
|
|
6363
6297
|
*/
|
|
6364
|
-
declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<
|
|
6298
|
+
declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
6365
6299
|
/** [EN]
|
|
6366
6300
|
* Dismiss group
|
|
6367
6301
|
* @description To create a group, the client must enable the `Group Information Hosting` feature. This feature is not supported if not enabled. Only the group owner can dismiss the group they created. After dismissal, the group conversation information is retained, and local historical messages are not deleted.
|
|
@@ -6376,7 +6310,7 @@ declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<
|
|
|
6376
6310
|
* @category 群组
|
|
6377
6311
|
* @since 5.12.0
|
|
6378
6312
|
*/
|
|
6379
|
-
declare function dismissGroup(groupId: string): Promise<
|
|
6313
|
+
declare function dismissGroup(groupId: string): Promise<RCResult>;
|
|
6380
6314
|
/** [EN]
|
|
6381
6315
|
* Transfer group ownership
|
|
6382
6316
|
* @description Requires enabling `User Profile Hosting` and `Allow Group Ownership Transfer via SDK` features. Otherwise, this feature is not supported.
|
|
@@ -6399,7 +6333,7 @@ declare function dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
|
|
|
6399
6333
|
* @category 群组
|
|
6400
6334
|
* @since 5.12.0
|
|
6401
6335
|
*/
|
|
6402
|
-
declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGroup?: boolean, config?: IQuitGroupConfig): Promise<
|
|
6336
|
+
declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGroup?: boolean, config?: IQuitGroupConfig): Promise<RCResult>;
|
|
6403
6337
|
/** [EN]
|
|
6404
6338
|
* Set group administrators
|
|
6405
6339
|
* @description Requires enabling the `User Profile Hosting` and `Allow SDK to Manage Group Administrators` features; otherwise, this feature is not supported.
|
|
@@ -6418,7 +6352,7 @@ declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGro
|
|
|
6418
6352
|
* @category 群组
|
|
6419
6353
|
* @since 5.12.0
|
|
6420
6354
|
*/
|
|
6421
|
-
declare function addGroupManagers(groupId: string, userIds: string[]): Promise<
|
|
6355
|
+
declare function addGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
6422
6356
|
/** [EN]
|
|
6423
6357
|
* Remove group administrators
|
|
6424
6358
|
* @description Requires enabling the `User Profile Hosting` and `Allow SDK to Manage Group Administrators` features. Otherwise, this feature is not supported.
|
|
@@ -6435,14 +6369,14 @@ declare function addGroupManagers(groupId: string, userIds: string[]): Promise<I
|
|
|
6435
6369
|
* @category 群组
|
|
6436
6370
|
* @since 5.12.0
|
|
6437
6371
|
*/
|
|
6438
|
-
declare function removeGroupManagers(groupId: string, userIds: string[]): Promise<
|
|
6372
|
+
declare function removeGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
6439
6373
|
/** [EN]
|
|
6440
6374
|
* Paginate to get group member information
|
|
6441
6375
|
* @description Requires the `User Profile Hosting` feature to be enabled; otherwise, this feature is not supported.
|
|
6442
6376
|
* @param groupId The group ID.
|
|
6443
6377
|
* @param role An array of group member roles. Refer to {@link GroupMemberRole}. 0: Fetch all group members regardless of role or position.
|
|
6444
6378
|
* @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 100 records can be queried per page.
|
|
6445
|
-
* @returns Returns a Promise of type {@link
|
|
6379
|
+
* @returns Returns a Promise of type {@link RCResult}. The data contains the total number of group members and group member information, where the group member information is of type {@link IGroupMemberInfo}.
|
|
6446
6380
|
* @category Group
|
|
6447
6381
|
* @since 5.12.0
|
|
6448
6382
|
*/
|
|
@@ -6452,18 +6386,18 @@ declare function removeGroupManagers(groupId: string, userIds: string[]): Promis
|
|
|
6452
6386
|
* @param groupId 群组 Id。
|
|
6453
6387
|
* @param role 群成员角色数组。参照{@link GroupMemberRole} 0:不区分角色或位置角色获取所有群成员
|
|
6454
6388
|
* @param option 分页拉取参数。参照{@link IPagingQueryOption}, 一页最多查询 100 条数据
|
|
6455
|
-
* @returns 返回一个 {@link
|
|
6389
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 为包含群成员总数和群成员信息,群成员信息为 {@link IGroupMemberInfo} 类型
|
|
6456
6390
|
* @category 群组
|
|
6457
6391
|
* @since 5.12.0
|
|
6458
6392
|
*/
|
|
6459
|
-
declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, option:
|
|
6393
|
+
declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IGetGroupMembersOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
6460
6394
|
/** [EN]
|
|
6461
6395
|
* Get information of specified group members
|
|
6462
6396
|
* @description Requires `User Profile Hosting` to be enabled; otherwise, this feature is not supported
|
|
6463
6397
|
* - Note: The current user must be in the group; otherwise, group member information cannot be retrieved
|
|
6464
6398
|
* @param groupId Group ID
|
|
6465
6399
|
* @param userIds Array of user IDs, with a maximum of 100 users
|
|
6466
|
-
* @returns Returns a Promise of type {@link
|
|
6400
|
+
* @returns Returns a Promise of type {@link RCResult}, where the data is of type {@link IGroupMemberInfo}
|
|
6467
6401
|
* @category Group
|
|
6468
6402
|
* @since 5.12.0
|
|
6469
6403
|
*/
|
|
@@ -6473,11 +6407,11 @@ declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, o
|
|
|
6473
6407
|
* - 注意:当前用户未在群组中不支持获取群成员信息
|
|
6474
6408
|
* @param groupId 群组 ID
|
|
6475
6409
|
* @param userIds 用户 ID 数组,最多不超过 100 个
|
|
6476
|
-
* @returns 返回一个 {@link
|
|
6410
|
+
* @returns 返回一个 {@link RCResult} 类型 Promise,data 为 {@link IGroupMemberInfo} 类型
|
|
6477
6411
|
* @category 群组
|
|
6478
6412
|
* @since 5.12.0
|
|
6479
6413
|
*/
|
|
6480
|
-
declare function getGroupMembers(groupId: string, userIds: string[]): Promise<
|
|
6414
|
+
declare function getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
|
|
6481
6415
|
/** [EN]
|
|
6482
6416
|
* Set group member profile
|
|
6483
6417
|
* @description This feature requires the `User Profile Hosting` feature to be enabled; otherwise, it is not supported.
|
|
@@ -6498,7 +6432,7 @@ declare function getGroupMembers(groupId: string, userIds: string[]): Promise<IA
|
|
|
6498
6432
|
* @category 群组
|
|
6499
6433
|
* @since 5.12.0
|
|
6500
6434
|
*/
|
|
6501
|
-
declare function setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<
|
|
6435
|
+
declare function setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
|
|
6502
6436
|
/** [EN]
|
|
6503
6437
|
* Search group member information by nickname
|
|
6504
6438
|
* @description Requires the `User Profile Hosting` feature to be enabled; otherwise, this feature is not supported. The Web platform does not currently support this feature.
|
|
@@ -6506,7 +6440,6 @@ declare function setGroupMemberInfo(groupId: string, userId: string, nickname: s
|
|
|
6506
6440
|
* @param groupId The group ID.
|
|
6507
6441
|
* @param name The keyword for searching group member nicknames. Note: Cannot be empty and must not exceed 64 characters; supports fuzzy search; if the nickname is empty, it defaults to searching by username. The search field cannot contain only spaces.
|
|
6508
6442
|
* @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
|
|
6509
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IGroupMemberInfo}.
|
|
6510
6443
|
* @category Group
|
|
6511
6444
|
* @since 5.12.0
|
|
6512
6445
|
*/
|
|
@@ -6517,11 +6450,10 @@ declare function setGroupMemberInfo(groupId: string, userId: string, nickname: s
|
|
|
6517
6450
|
* @param groupId 群组 Id。
|
|
6518
6451
|
* @param name 群成员昵称搜索关键字。注意:不能为空最长不超过 64 个字符;支持模糊搜索查询;昵称为空时,默认搜索用户名。搜索字段不可以传递纯空格。
|
|
6519
6452
|
* @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
|
|
6520
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupMemberInfo} 类型
|
|
6521
6453
|
* @category 群组
|
|
6522
6454
|
* @since 5.12.0
|
|
6523
6455
|
*/
|
|
6524
|
-
declare function searchGroupMembers(groupId: string, name: string, option: IPagingQueryOption): Promise<
|
|
6456
|
+
declare function searchGroupMembers(groupId: string, name: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
|
|
6525
6457
|
/** [EN]
|
|
6526
6458
|
* Join group
|
|
6527
6459
|
* @description To create a group, the client must enable the `Group Information Hosting` and `Allow Joining Groups via SDK` features. This functionality is not supported if these features are not enabled.
|
|
@@ -6552,7 +6484,7 @@ declare function searchGroupMembers(groupId: string, name: string, option: IPagi
|
|
|
6552
6484
|
* @category 群组
|
|
6553
6485
|
* @since 5.12.0
|
|
6554
6486
|
*/
|
|
6555
|
-
declare function joinGroup(groupId: string): Promise<
|
|
6487
|
+
declare function joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
|
|
6556
6488
|
/** [EN]
|
|
6557
6489
|
* Invite users to join a group
|
|
6558
6490
|
* @description The client needs to enable the `User Profile Hosting` feature to create a group. This feature is not supported if the feature is not enabled. Users can be directly added to the group through an invitation without requiring approval from the group owner or administrator.
|
|
@@ -6569,7 +6501,7 @@ declare function joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
|
|
|
6569
6501
|
* @category 群组
|
|
6570
6502
|
* @since 5.12.0
|
|
6571
6503
|
*/
|
|
6572
|
-
declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise<
|
|
6504
|
+
declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
|
|
6573
6505
|
/** [EN]
|
|
6574
6506
|
* User agrees to join a group
|
|
6575
6507
|
* @description The client needs to enable the `User Profile Hosting` feature to create a group. This feature is not supported if the feature is not enabled.
|
|
@@ -6586,7 +6518,7 @@ declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise
|
|
|
6586
6518
|
* @category 群组
|
|
6587
6519
|
* @since 5.12.0
|
|
6588
6520
|
*/
|
|
6589
|
-
declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<
|
|
6521
|
+
declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<RCResult>;
|
|
6590
6522
|
/** [EN]
|
|
6591
6523
|
* User rejects group invitation
|
|
6592
6524
|
* @description The client requires the `User Profile Hosting` feature to create a group. This feature is not supported if the feature is not enabled.
|
|
@@ -6605,7 +6537,7 @@ declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<
|
|
|
6605
6537
|
* @category 群组
|
|
6606
6538
|
* @since 5.12.0
|
|
6607
6539
|
*/
|
|
6608
|
-
declare function refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<
|
|
6540
|
+
declare function refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<RCResult>;
|
|
6609
6541
|
/** [EN]
|
|
6610
6542
|
* Group owner or administrator approves user to join the group
|
|
6611
6543
|
* @description The client must enable the `User Profile Hosting` feature to create a group. This feature is not supported if the feature is not enabled. After receiving a user's request to join the group, the group owner or administrator can approve the user to join the group.
|
|
@@ -6624,7 +6556,7 @@ declare function refuseGroupInvite(groupId: string, inviterId: string, reason?:
|
|
|
6624
6556
|
* @category 群组
|
|
6625
6557
|
* @since 5.12.0
|
|
6626
6558
|
*/
|
|
6627
|
-
declare function acceptGroupApplication(groupId: string, applicantId: string, inviterId?: string): Promise<
|
|
6559
|
+
declare function acceptGroupApplication(groupId: string, applicantId: string, inviterId?: string): Promise<RCResult<IProcessCode>>;
|
|
6628
6560
|
/** [EN]
|
|
6629
6561
|
* Group owner or administrator rejects user's request to join the group
|
|
6630
6562
|
* @description The client must enable the `Group Information Hosting` feature to create a group. This feature is not supported if the feature is not enabled. The group owner or administrator rejects the user's request to join the group after receiving the application.
|
|
@@ -6645,7 +6577,7 @@ declare function acceptGroupApplication(groupId: string, applicantId: string, in
|
|
|
6645
6577
|
* @category 群组
|
|
6646
6578
|
* @since 5.12.0
|
|
6647
6579
|
*/
|
|
6648
|
-
declare function refuseGroupApplication(groupId: string, applicantId: string, inviterId?: string, reason?: string): Promise<
|
|
6580
|
+
declare function refuseGroupApplication(groupId: string, applicantId: string, inviterId?: string, reason?: string): Promise<RCResult>;
|
|
6649
6581
|
/** [EN]
|
|
6650
6582
|
* Get group requests
|
|
6651
6583
|
* @description To create a group, the client must have the `User Profile Hosting` feature enabled. This functionality is not supported if the feature is not enabled. Administrators can view group operation requests related to themselves.<br>
|
|
@@ -6653,7 +6585,6 @@ declare function refuseGroupApplication(groupId: string, applicantId: string, in
|
|
|
6653
6585
|
* @param option Pagination parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
|
|
6654
6586
|
* @param status Array of group request statuses. This parameter is only supported in Electron and is mandatory for Electron. Passing this parameter in Web is invalid.
|
|
6655
6587
|
* @param directions Array of group request directions. Refer to {@link GroupApplicationDirection}. This parameter is only supported in Electron and is mandatory for Electron. Passing this parameter in Web is invalid.
|
|
6656
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data contains an array of type {@link IGroupApplicationInfo}.
|
|
6657
6588
|
* @category Group
|
|
6658
6589
|
* @since 5.12.0
|
|
6659
6590
|
*/
|
|
@@ -6664,17 +6595,15 @@ declare function refuseGroupApplication(groupId: string, applicantId: string, in
|
|
|
6664
6595
|
* @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
|
|
6665
6596
|
* @param status 群组请求状态数组,参数仅 Electron 支持,且 Electron 为必填项,Web 传递无效
|
|
6666
6597
|
* @param directions 群组请求方向数组,参照{@link GroupApplicationDirection},参数仅 Electron 支持,且 Electron 为必填项,Web 传递无效
|
|
6667
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 中包含 {@link IGroupApplicationInfo} 类型数组
|
|
6668
6598
|
* @category 群组
|
|
6669
6599
|
* @since 5.12.0
|
|
6670
6600
|
*/
|
|
6671
|
-
declare function getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<
|
|
6601
|
+
declare function getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
|
|
6672
6602
|
/** [EN]
|
|
6673
6603
|
* Get the groups a user belongs to
|
|
6674
6604
|
* @description The client must have the `User Profile Hosting` feature enabled to create groups. This feature is not supported if the feature is not enabled.
|
|
6675
6605
|
* @param roles An array of group roles.
|
|
6676
6606
|
* @param option Pagination query parameters {@link IPagingQueryOption}, with a maximum of 100 records per page.
|
|
6677
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of type {@link IGroupInfoOption}.
|
|
6678
6607
|
* @category Group
|
|
6679
6608
|
* @since 5.12.0
|
|
6680
6609
|
*/
|
|
@@ -6683,17 +6612,15 @@ declare function getGroupApplications(option: IPagingQueryOption, directions?: G
|
|
|
6683
6612
|
* @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能
|
|
6684
6613
|
* @param roles 群组身份数组。
|
|
6685
6614
|
* @param option 分页拉取参数 {@link IPagingQueryOption},一页最多查询 100 条数据
|
|
6686
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupInfoOption} 类型数组
|
|
6687
6615
|
* @category 群组
|
|
6688
6616
|
* @since 5.12.0
|
|
6689
6617
|
*/
|
|
6690
|
-
declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMemberRole): Promise<
|
|
6618
|
+
declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMemberRole): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
6691
6619
|
/** [EN]
|
|
6692
6620
|
* Search for groups I have joined by group name
|
|
6693
6621
|
* @description Client-side group creation requires the `User Profile Hosting` feature to be enabled. This feature is not supported if the feature is not enabled. The Web platform currently does not support this feature.
|
|
6694
6622
|
* @param groupName The search keyword for the group name. Cannot be empty and must not exceed 64 characters. Supports fuzzy search. Trim leading and trailing spaces before querying.
|
|
6695
6623
|
* @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
|
|
6696
|
-
* @returns Returns a Promise of type {@link IAsyncRes}, with data of type {@link void}.
|
|
6697
6624
|
* @category Group
|
|
6698
6625
|
* @since 5.12.0
|
|
6699
6626
|
*/
|
|
@@ -6702,11 +6629,10 @@ declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMe
|
|
|
6702
6629
|
* @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能,Web 平台暂不支持
|
|
6703
6630
|
* @param groupName 群名称搜索关键字。不能为空最长不超过 64 个字符,支持模糊搜索查询时需要去掉前后空格。
|
|
6704
6631
|
* @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
|
|
6705
|
-
* @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link void} 类型
|
|
6706
6632
|
* @category 群组
|
|
6707
6633
|
* @since 5.12.0
|
|
6708
6634
|
*/
|
|
6709
|
-
declare function searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<
|
|
6635
|
+
declare function searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
|
|
6710
6636
|
/** [EN]
|
|
6711
6637
|
* Batch get group information
|
|
6712
6638
|
* @description To create a group, the client must have the `Group Information Hosting` feature enabled. This feature is not supported if the feature is not enabled. Supports retrieving information for all existing groups.
|
|
@@ -6721,7 +6647,7 @@ declare function searchJoinedGroups(groupName: string, option: IPagingQueryOptio
|
|
|
6721
6647
|
* @category 群组
|
|
6722
6648
|
* @since 5.12.0
|
|
6723
6649
|
*/
|
|
6724
|
-
declare function getJoinedGroups(groupIds: string[]): Promise<
|
|
6650
|
+
declare function getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
|
|
6725
6651
|
/** [EN]
|
|
6726
6652
|
* Set group name
|
|
6727
6653
|
* @description The client must enable the `User Profile Hosting` feature to create a group. This feature is not supported if the feature is not enabled.
|
|
@@ -6738,7 +6664,7 @@ declare function getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupIn
|
|
|
6738
6664
|
* @category 群组
|
|
6739
6665
|
* @since 5.12.0
|
|
6740
6666
|
*/
|
|
6741
|
-
declare function setGroupRemark(groupId: string, remark: string): Promise<
|
|
6667
|
+
declare function setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
|
|
6742
6668
|
/** [EN]
|
|
6743
6669
|
* Set group member follow
|
|
6744
6670
|
* @param groupId The group ID
|
|
@@ -6753,7 +6679,7 @@ declare function setGroupRemark(groupId: string, remark: string): Promise<IAsync
|
|
|
6753
6679
|
* @category 群组
|
|
6754
6680
|
* @since 5.12.0
|
|
6755
6681
|
*/
|
|
6756
|
-
declare function addGroupFollows(groupId: string, userIds: string[]): Promise<
|
|
6682
|
+
declare function addGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
6757
6683
|
/** [EN]
|
|
6758
6684
|
* Remove group member follow
|
|
6759
6685
|
* @param groupId Group ID
|
|
@@ -6768,7 +6694,7 @@ declare function addGroupFollows(groupId: string, userIds: string[]): Promise<IA
|
|
|
6768
6694
|
* @category 群组
|
|
6769
6695
|
* @since 5.12.0
|
|
6770
6696
|
*/
|
|
6771
|
-
declare function removeGroupFollows(groupId: string, userIds: string[]): Promise<
|
|
6697
|
+
declare function removeGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
|
|
6772
6698
|
/** [EN]
|
|
6773
6699
|
* Get group members I follow
|
|
6774
6700
|
* @param groupId The group ID, only supports regular groups.
|
|
@@ -6781,7 +6707,7 @@ declare function removeGroupFollows(groupId: string, userIds: string[]): Promise
|
|
|
6781
6707
|
* @category 群组
|
|
6782
6708
|
* @since 5.12.0
|
|
6783
6709
|
*/
|
|
6784
|
-
declare function getGroupFollows(groupId: string): Promise<
|
|
6710
|
+
declare function getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
|
|
6785
6711
|
|
|
6786
6712
|
/** [EN]
|
|
6787
6713
|
* Add friend
|
|
@@ -6799,7 +6725,7 @@ declare function getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInf
|
|
|
6799
6725
|
* @category 好友
|
|
6800
6726
|
* @since 5.12.0
|
|
6801
6727
|
*/
|
|
6802
|
-
declare function addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<
|
|
6728
|
+
declare function addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<RCResult<IProcessCode>>;
|
|
6803
6729
|
/** [EN]
|
|
6804
6730
|
* Remove friend
|
|
6805
6731
|
* @param userIds List of user IDs to remove from the friend relationship. A maximum of 100 users can be removed at once.
|
|
@@ -6807,7 +6733,6 @@ declare function addFriend(userId: string, directionType: DirectionType, extra?:
|
|
|
6807
6733
|
* @description Note: One-way friend removal: Only removes the friend from the operator's friend list. Two-way friend removal: Removes the friend from both parties' friend lists.
|
|
6808
6734
|
* @category Friend
|
|
6809
6735
|
* @since 5.12.0
|
|
6810
|
-
|
|
6811
6736
|
*/
|
|
6812
6737
|
/**
|
|
6813
6738
|
* 解除好友
|
|
@@ -6817,7 +6742,7 @@ declare function addFriend(userId: string, directionType: DirectionType, extra?:
|
|
|
6817
6742
|
* @category 好友
|
|
6818
6743
|
* @since 5.12.0
|
|
6819
6744
|
*/
|
|
6820
|
-
declare function deleteFriends(userIds: string[], directionType: DirectionType): Promise<
|
|
6745
|
+
declare function deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<void>>;
|
|
6821
6746
|
/** [EN]
|
|
6822
6747
|
* Agree to add as a friend
|
|
6823
6748
|
* @param userId The user ID of the user who agrees to become a friend
|
|
@@ -6830,22 +6755,20 @@ declare function deleteFriends(userIds: string[], directionType: DirectionType):
|
|
|
6830
6755
|
* @category 好友
|
|
6831
6756
|
* @since 5.12.0
|
|
6832
6757
|
*/
|
|
6833
|
-
declare function acceptFriendApplication(userId: string): Promise<
|
|
6758
|
+
declare function acceptFriendApplication(userId: string): Promise<RCResult>;
|
|
6834
6759
|
/** [EN]
|
|
6835
6760
|
* Reject friend request
|
|
6836
|
-
* @param userId The user ID of the user to reject as a friend
|
|
6837
|
-
* // * @param reason The reason for rejection. Optional, with a maximum length of 128 characters.
|
|
6761
|
+
* @param userId The user ID of the user to reject as a friend.
|
|
6838
6762
|
* @category Friend
|
|
6839
6763
|
* @since 5.12.0
|
|
6840
|
-
|
|
6841
6764
|
*/
|
|
6842
6765
|
/**
|
|
6843
6766
|
* 拒绝加为好友
|
|
6844
|
-
* @param userId
|
|
6767
|
+
* @param userId 用户 ID
|
|
6845
6768
|
* @category 好友
|
|
6846
6769
|
* @since 5.12.0
|
|
6847
6770
|
*/
|
|
6848
|
-
declare function refuseFriendApplication(userId: string): Promise<
|
|
6771
|
+
declare function refuseFriendApplication(userId: string): Promise<RCResult>;
|
|
6849
6772
|
/** [EN]
|
|
6850
6773
|
* Set friend information
|
|
6851
6774
|
* @param userId The user ID of the friend
|
|
@@ -6862,9 +6785,7 @@ declare function refuseFriendApplication(userId: string): Promise<IAsyncRes<void
|
|
|
6862
6785
|
* @category 好友
|
|
6863
6786
|
* @since 5.12.0
|
|
6864
6787
|
*/
|
|
6865
|
-
declare function setFriendInfo(userId: string, remark?: string, extProfile?:
|
|
6866
|
-
[key: string]: string;
|
|
6867
|
-
}): Promise<IAsyncRes<IErrorKeys>>;
|
|
6788
|
+
declare function setFriendInfo(userId: string, remark?: string, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
|
|
6868
6789
|
/** [EN]
|
|
6869
6790
|
* Check friend relationship
|
|
6870
6791
|
*
|
|
@@ -6887,7 +6808,6 @@ declare function setFriendInfo(userId: string, remark?: string, extProfile?: {
|
|
|
6887
6808
|
* @param directionType Type of friend relationship to check: unidirectional, bidirectional.
|
|
6888
6809
|
* @category Friend
|
|
6889
6810
|
* @since 5.12.0
|
|
6890
|
-
|
|
6891
6811
|
*/
|
|
6892
6812
|
/**
|
|
6893
6813
|
* 检查好友关系
|
|
@@ -6912,31 +6832,27 @@ declare function setFriendInfo(userId: string, remark?: string, extProfile?: {
|
|
|
6912
6832
|
* @category 好友
|
|
6913
6833
|
* @since 5.12.0
|
|
6914
6834
|
*/
|
|
6915
|
-
declare function checkFriends(userIds: string[], directionType: DirectionType): Promise<
|
|
6835
|
+
declare function checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
|
|
6916
6836
|
/** [EN]
|
|
6917
6837
|
* Get friend list
|
|
6918
|
-
* @description The
|
|
6919
|
-
*
|
|
6920
|
-
* @param
|
|
6921
|
-
* @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. This parameter is only valid for the web platform. The default `Count` is 50, and a maximum of 100 records can be queried per page.
|
|
6838
|
+
* @description The paging parameters are invalid for the Electron platform. The Electron platform defaults to obtaining all friend data at once.
|
|
6839
|
+
* @param directionType Specifies the friend direction types: one-way friend, two-way friend. Refer to {@link QueryFriendsDirectionType}.
|
|
6840
|
+
* @param option Pagination query parameters. Reference {@link IPagingQueryOption}, a maximum of 100 records can be queried per page.
|
|
6922
6841
|
* @category Friends
|
|
6923
6842
|
* @since 5.12.0
|
|
6924
|
-
|
|
6925
6843
|
*/
|
|
6926
6844
|
/**
|
|
6927
6845
|
* 获取好友列表
|
|
6928
|
-
* @
|
|
6929
|
-
*
|
|
6930
|
-
* @param directionTypes 好友方向类型:单向好友、双向好友。参照 {@link QueryFriendsDirectionType}
|
|
6931
|
-
* @param option 分页拉取参数,参照 {@link IPagingQueryOption}, 仅 web 有效,Count 默认 50,一页最多查询 100 条数据,
|
|
6846
|
+
* @param directionType 好友方向类型:单向好友、双向好友。参照 {@link QueryFriendsDirectionType}
|
|
6847
|
+
* @param option 分页拉取参数,参考 {@link IPagingQueryOption};该参数对 Electron 平台无效,Electron 平台默认一次性获取全量好友数据。
|
|
6932
6848
|
* @category 好友
|
|
6933
6849
|
* @since 5.12.0
|
|
6934
6850
|
*/
|
|
6935
|
-
declare function getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<
|
|
6851
|
+
declare function getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
|
|
6936
6852
|
/** [EN]
|
|
6937
6853
|
* Fetch friend request list with pagination
|
|
6938
|
-
* @param types Request types. Multiple types can be selected. Refer to {@link FriendApplicationType}
|
|
6939
6854
|
* @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 100 records can be queried per page.
|
|
6855
|
+
* @param types Request types. Multiple types can be selected. Refer to {@link FriendApplicationType}
|
|
6940
6856
|
* @param status Request status. Multiple statuses can be selected, including friend request pending, accepted, rejected, and expired. This field is only supported on the Electron platform. Refer to {@link FriendApplicationStatus}
|
|
6941
6857
|
* @category Friend
|
|
6942
6858
|
* @since 5.12.0
|
|
@@ -6944,13 +6860,13 @@ declare function getFriends(directionType: QueryFriendsDirectionType, option?: I
|
|
|
6944
6860
|
/**
|
|
6945
6861
|
* 分页获取好友请求列表
|
|
6946
6862
|
*
|
|
6947
|
-
* @param types 请求类型。可选择多个。参照 {@link FriendApplicationType}
|
|
6948
6863
|
* @param option 分页拉取参数,参照 {@link IPagingQueryOption}, 一页最多查询 100 条数据,
|
|
6949
|
-
* @param
|
|
6864
|
+
* @param types 请求类型列表,参照 {@link FriendApplicationType};该参数仅 Electron 平台有效。
|
|
6865
|
+
* @param status 请求状态列表,参照 {@link FriendApplicationStatus};该参数仅 Electron 平台有效。
|
|
6950
6866
|
* @category 好友
|
|
6951
6867
|
* @since 5.12.0
|
|
6952
6868
|
*/
|
|
6953
|
-
declare function getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<
|
|
6869
|
+
declare function getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
|
|
6954
6870
|
/** [EN]
|
|
6955
6871
|
* Get friend information based on user IDs
|
|
6956
6872
|
* @param userIds List of user IDs, with a maximum of 100 friends' information retrievable at once
|
|
@@ -6964,22 +6880,20 @@ declare function getFriendApplications(option?: IPagingQueryOption, types?: Frie
|
|
|
6964
6880
|
* @category 好友
|
|
6965
6881
|
* @since 5.12.0
|
|
6966
6882
|
*/
|
|
6967
|
-
declare function getFriendsInfo(userIds: string[]): Promise<
|
|
6883
|
+
declare function getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
|
|
6968
6884
|
/** [EN]
|
|
6969
|
-
* Search for friend information based on nickname
|
|
6970
|
-
* This API is only supported on the Electron platform
|
|
6885
|
+
* Search for friend information based on nickname. This API is only supported on the Electron platform.
|
|
6971
6886
|
* @param name The keyword for the user's nickname. It cannot be empty and must not exceed 64 characters.
|
|
6972
6887
|
* @category Friend
|
|
6973
6888
|
* @since 5.12.0
|
|
6974
6889
|
*/
|
|
6975
6890
|
/**
|
|
6976
|
-
*
|
|
6977
|
-
* 此接口仅 Electron 平台支持
|
|
6891
|
+
* 根据好友昵称搜索好友信息,此接口仅 Electron 平台支持
|
|
6978
6892
|
* @param name 用户昵称关键字,不能为空最长不超过 64 个字符。
|
|
6979
6893
|
* @category 好友
|
|
6980
6894
|
* @since 5.12.0
|
|
6981
6895
|
*/
|
|
6982
|
-
declare function searchFriendsInfo(name: string): Promise<
|
|
6896
|
+
declare function searchFriendsInfo(name: string): Promise<RCResult<IFriendInfo[]>>;
|
|
6983
6897
|
/** [EN]
|
|
6984
6898
|
* Set the current user's friend request permission
|
|
6985
6899
|
* @param permission Friend request permission. Refer to {@link IAddFriendPermission}
|
|
@@ -6993,7 +6907,7 @@ declare function searchFriendsInfo(name: string): Promise<IAsyncRes<IFriendInfo[
|
|
|
6993
6907
|
* @category 好友
|
|
6994
6908
|
* @since 5.12.0
|
|
6995
6909
|
*/
|
|
6996
|
-
declare function setFriendAddPermission(permission: FriendAddPermission): Promise<
|
|
6910
|
+
declare function setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
|
|
6997
6911
|
/** [EN]
|
|
6998
6912
|
* Get the current user's friend request permissions
|
|
6999
6913
|
* @category Friend
|
|
@@ -7004,7 +6918,7 @@ declare function setFriendAddPermission(permission: FriendAddPermission): Promis
|
|
|
7004
6918
|
* @category 好友
|
|
7005
6919
|
* @since 5.12.0
|
|
7006
6920
|
*/
|
|
7007
|
-
declare function getFriendAddPermission(): Promise<
|
|
6921
|
+
declare function getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
|
|
7008
6922
|
|
|
7009
6923
|
/** [EN]
|
|
7010
6924
|
* Initialization
|
|
@@ -7503,7 +7417,6 @@ declare function saveTextMessageDraft(options: IConversationOption, draft: strin
|
|
|
7503
7417
|
* const conversation = await RongIMLib.clearTextMessageDraft(options);
|
|
7504
7418
|
* console.info('Result of deleting conversation text draft:', conversation);
|
|
7505
7419
|
* ```
|
|
7506
|
-
|
|
7507
7420
|
*/
|
|
7508
7421
|
/**
|
|
7509
7422
|
* 删除会话文本草稿
|
|
@@ -7614,7 +7527,6 @@ declare function getTotalUnreadCountByLevels(conversationTypes: ConversationType
|
|
|
7614
7527
|
* const totalUnreadCount = await RongIMLib.getTotalUnreadMentionedCountByLevels(conversationTypes, levels);
|
|
7615
7528
|
* console.info('Result of getting the total unread mention count for specified Do Not Disturb levels:', totalUnreadCount);
|
|
7616
7529
|
* ```
|
|
7617
|
-
|
|
7618
7530
|
*/
|
|
7619
7531
|
/**
|
|
7620
7532
|
* 获取会话指定免打扰级别未读 @ 消息数
|
|
@@ -7688,7 +7600,6 @@ declare function getUnreadCount(options: IConversationOption): Promise<RCResult<
|
|
|
7688
7600
|
* const clearRes = await RongIMLib.clearMessagesUnreadStatus(options);
|
|
7689
7601
|
* console.info('Result of clearing the unread count for the specified conversation:', clearRes);
|
|
7690
7602
|
* ```
|
|
7691
|
-
|
|
7692
7603
|
*/
|
|
7693
7604
|
/**
|
|
7694
7605
|
* 清除指定会话未读数
|
|
@@ -8791,8 +8702,7 @@ declare function getChatroomHistoryMessages(targetId: string, options: GetHistor
|
|
|
8791
8702
|
* };
|
|
8792
8703
|
* const res = await RongIMLib.bindRTCRoomForChatroom(option);
|
|
8793
8704
|
* console.log('RTC room binding result:', res);
|
|
8794
|
-
* ```
|
|
8795
|
-
|
|
8705
|
+
* ```
|
|
8796
8706
|
*/
|
|
8797
8707
|
/**
|
|
8798
8708
|
* 绑定音视频房间
|
|
@@ -8956,4 +8866,4 @@ declare function getAutoTranslateEnabled(): Promise<RCResult<boolean>>;
|
|
|
8956
8866
|
|
|
8957
8867
|
declare type IStreamMessageResponseEventData = IStreamMessageResponseEventData$1<IAReceivedMessage>;
|
|
8958
8868
|
|
|
8959
|
-
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, 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 };
|
|
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 };
|