@rongcloud/imlib-next 5.30.0 → 5.32.0-c-rtc-alpha.2

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.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { FileType, APIContext, IAsyncRes, 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, RCResult, IUltraGroupConversation, NotificationLevel, IUltraGroupOption, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUltraGroupUnreadInfo, ICombineMessageContent, ICombineV2MessageContent, ICommandMessageContent, IFileMessageContent, IGIFMessageContent, IGroupNotificationMessageContent, IImageMessageContent, IInformationNotificationMessageContent, ILocationMessageContent, IReferenceMessageContent, IRichContentMessageContent, ISightMessageContent, IStreamMessageContent, ITextMessageContent, IHQVoiceMessageContent, IVoiceMessageContent, IUserExtraKeyInMessage, IExtraDataKeyInMessage, IMentionedInfoKeyInMessage, IMessageReadReceiptV4Response, IGroupReadReceiptData, MessageDirection, IClearMessageOption, IMessageReaderResponse, IFirstUnreadMessageInfo, ConversationType, ReadReceiptInfoV5, IMessageIdentifier, ReadReceiptUsersOption, ReadReceiptUsersResult, IConvertSpeechToTextOption, TranslateMessagesParams, TranslateTextsParams, IModifyMessageParams, ITagParam, ITagInfo, IConversationTag, IUploadAuth, IDownloadAuth, UploadMethod, IConversationIdentifier, IEditedMessageDraft, IGetHistoryMessagesByTypesOption, ReceivedStatus, IReceivedStatusInfo, SentStatus, IInsertMessage, ISearchMessageParams, IProxy, IPromiseResult, IResponse, IUpdateMyProfileFail, UserProfileVisibility, ISubscribeUserOnlineStatus, IGroupInfoOption, ICreateGroupFail, IErrorKeys, IGroupInfo, IQuitGroupConfig, GroupMemberRole, IPagingQueryOption, IPagingQueryResult, IGroupMemberInfo, 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, GroupOperationType, 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, 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, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IReceivedStatusInfo, IReferContentInMessage, IReferContentKeyInMessage, IReferenceMessageContent, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IResponse, IRichContentMessageContent, ISearchMessageParams, ISearchMessagesResult, ISightMessageContent, ISpeechToTextInfo, ISpeechToTextResponse, IStreamMessageContent, IStreamMessageResponseChunkData, ISubscribeRelationInfo, ISubscribeStatusDetail, ISubscribeUserOnlineStatus, ISubscribeUserStatusInfo, ISyncReadStatusData, ITagInfo, ITagParam, ITextMessageContent, ITimeRange, ITypingMessage, ITypingUser, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUltraGroupConversation, IUltraGroupOption, IUltraGroupUnreadInfo, IUltraGroupUnreadMentionedOption, IUltraUnreadMsg, IUpdateItem, IUpdateMyProfileFail, IUpdatedExpansion, IUploadAuth, IUserExtraKeyInMessage, IUserExtraValueInMessage, IUserGroupChangeData, IUserGroupStatusInfo, IUserProfile, IUserProfileInfo, IUserSettingsChangedEvent, IVoiceMessageContent, IiOSPushConfig, InterruptionLevel, LogDBProxy, LogL, LogLevel, MentionedInfo, MentionedType, MessageAuditType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NotificationLevel, NotificationStatus, OnlineStatus, OperateStatus, Platform, Platform as PlatformInfo, PushImportanceHonor, PushNotificationQuietHoursLevel, QueryFriendsDirectionType, RCConnectionStatus, RCResult, ReadReceiptInfoV5, ReadReceiptResponseV5, ReadReceiptUser, ReadReceiptUsersOption, ReadReceiptUsersResult, ReceivedStatus, ReferenceMessageStatus, SentStatus, SpeechToTextStatus, StreamMessageResponseEventType, SubscribeOperationType, SubscribeType, TranslateInfo, TranslateItem, TranslateMessageParam, TranslateMessagesParams, TranslateMode, TranslateStatus, TranslateStrategy, TranslateTextParam, TranslateTextsParams, UltraGroupChannelChangeType, UltraGroupChannelType, UploadMethod, UserProfileVisibility, UserSettingsChangedKey, UserType, createLogDBProxy, fail, ok } from '@rongcloud/engine';
1
+ import { FileType, APIContext, RCResult, IPluginGenerator, MessageTypeDescription, LogLevel, EnableLogL, AreaCode, LogDBProxy, IReceivedMessage, IGetHistoryMessageOption, IReceivedConversation, IPushConfig, IAuditInfoKeyInMessage, IRecallMsgOptions, IConversationOption, ITypingMessage, IUpdateItem, ErrorCode, IChatroomListenerData, IExpansionListenerData, IUserSettingsChangedEvent, IBlockedMessageInfo, IOperateStatusNotify, IUltraChannelChangeInfo, IUltraChannelDeleteInfo, IUltraChannelUserKickedInfo, IUserGroupStatusInfo, IReadReceiptData, ISyncReadStatusData, ISubscribeUserStatusInfo, ISubscribeRelationInfo, SubscribeType, IUserProfileInfo, IGroupOperationInfo, IGroupInfoChanged, IGroupMemberInfoChanged, IGroupApplicationInfo, IGroupRemarkChangedSync, IGroupFollowsChangedSync, IFriendAdd, IFriendDelete, IFriendApplicationStatusChange, IFriendInfoChangedSync, IStreamMessageResponseEventData as IStreamMessageResponseEventData$1, ReadReceiptResponseV5, ISpeechToTextResponse, TranslateItem, 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<IAsyncRes<IUploadResult>>;
119
+ awaitResult(): Promise<RCResult<IUploadResult>>;
120
120
  }
121
121
 
122
122
  /** [EN]
@@ -198,7 +198,7 @@ declare function removeMonitor(id: number): void;
198
198
  * console.info('建立 IM 连接结果:', res);
199
199
  * ```
200
200
  */
201
- declare function connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{
201
+ declare function connect(token: string, reconnectKickEnable?: boolean): Promise<RCResult<{
202
202
  userId: string;
203
203
  }>>;
204
204
  /** [EN]
@@ -2306,7 +2306,7 @@ declare function getUltraGroupUnreadInfoList(targetIds: string[]): Promise<RCRes
2306
2306
  * console.log('加入黑名单结果:', res);
2307
2307
  * ```
2308
2308
  */
2309
- declare function addToBlacklist(userId: string): Promise<IAsyncRes<void>>;
2309
+ declare function addToBlacklist(userId: string): Promise<RCResult>;
2310
2310
  /** [EN]
2311
2311
  * Remove from blacklist
2312
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.
@@ -2335,7 +2335,7 @@ declare function addToBlacklist(userId: string): Promise<IAsyncRes<void>>;
2335
2335
  * console.log('移出黑名单结果:', res);
2336
2336
  * ```
2337
2337
  */
2338
- declare function removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>;
2338
+ declare function removeFromBlacklist(userId: string): Promise<RCResult>;
2339
2339
  /** [EN]
2340
2340
  * Get blacklist
2341
2341
  * @description This feature is currently only available in the Electron solution for retrieving the blacklist.
@@ -2362,7 +2362,7 @@ declare function removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>;
2362
2362
  * console.log('获取黑名单列表结果:', res);
2363
2363
  * ```
2364
2364
  */
2365
- declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
2365
+ declare function getBlacklist(): Promise<RCResult<string[]>>;
2366
2366
  /** [EN]
2367
2367
  * Check if a user is in the blacklist
2368
2368
  * @description This feature is currently limited to the Electron solution and is used to check if a user is in the blacklist.
@@ -2391,253 +2391,7 @@ declare function getBlacklist(): Promise<IAsyncRes<string[]>>;
2391
2391
  * console.log('获取黑名单列表结果:', res);
2392
2392
  * ```
2393
2393
  */
2394
- declare function getBlacklistStatus(userId: string): Promise<IAsyncRes<boolean>>;
2395
-
2396
- /** [EN]
2397
- * TODO(Translation)
2398
- * @category Interface
2399
- */
2400
- /**
2401
- * @deprecated - 已废弃,请使用 `ICombineMessageContent` 替代
2402
- * @category Interface
2403
- */
2404
- declare type ICombineMessageBody = ICombineMessageContent;
2405
-
2406
- /** [EN]
2407
- * TODO(Translation)
2408
- */
2409
- /**
2410
- * 合并转发消息类型
2411
- */
2412
- declare class CombineMessage extends BuiltinMessage<ICombineMessageContent> {
2413
- constructor(content: ICombineMessageContent);
2414
- }
2415
-
2416
- /**
2417
- * 合并转发消息 v2 版本 Content 结构
2418
- * @category Type
2419
- * @hidden
2420
- * @deprecated - 已废弃,请使用 `ICombineV2MessageContent` 替代
2421
- */
2422
- declare type CombineV2MessageContent = ICombineV2MessageContent;
2423
-
2424
- /**
2425
- * 合并转发消息 v2 版本
2426
- * @since 5.22.0
2427
- */
2428
- declare class CombineV2Message extends BuiltinMessage<ICombineV2MessageContent> {
2429
- constructor(content: ICombineV2MessageContent);
2430
- }
2431
-
2432
- /** [EN]
2433
- * TODO(Translation)
2434
- */
2435
- /**
2436
- * 命令消息
2437
- * @category Interface
2438
- * @deprecated - 已废弃,请使用 `ICommandMessageContent` 替代
2439
- */
2440
- declare type ICommandMessageBody = ICommandMessageContent;
2441
-
2442
- /** [EN]
2443
- * TODO(Translation)
2444
- */
2445
- /**
2446
- * 命令消息类型
2447
- */
2448
- declare class CommandMessage extends BuiltinMessage<ICommandMessageContent> {
2449
- constructor(content: ICommandMessageContent);
2450
- }
2451
-
2452
- /** [EN]
2453
- * TODO(Translation)
2454
- */
2455
- /**
2456
- * 文件消息
2457
- * @category Interface
2458
- * @deprecated - 已废弃,请使用 `IFileMessageContent` 替代
2459
- */
2460
- declare type IFileMessageBody = IFileMessageContent;
2461
-
2462
- declare class FileMessage extends BuiltinMessage<IFileMessageContent> {
2463
- constructor(content: IFileMessageContent);
2464
- }
2465
-
2466
- /** [EN]
2467
- * @category Interface
2468
- * @deprecated Please use `IGIFMessageContent` instead.
2469
- */
2470
- /**
2471
- * @category Interface
2472
- * @deprecated - 已废弃,请使用 `IGIFMessageContent` 替代
2473
- */
2474
- declare type IGIFMessageBody = IGIFMessageContent;
2475
-
2476
- declare class GIFMessage extends BuiltinMessage<IGIFMessageContent> {
2477
- constructor(content: IGIFMessageContent);
2478
- }
2479
-
2480
- /** [EN]
2481
- * @category Interface
2482
- * @deprecated Please use `IGroupNotificationMessageContent` instead.
2483
- */
2484
- /**
2485
- * 群组通知消息
2486
- * @category Interface
2487
- * @deprecated - 已废弃,请使用 `IGroupNotificationMessageContent` 替代
2488
- */
2489
- declare type IGroupNotificationMessageBody = IGroupNotificationMessageContent;
2490
-
2491
- declare class GroupNotificationMessage extends BuiltinMessage<IGroupNotificationMessageBody> {
2492
- constructor(content: IGroupNotificationMessageBody);
2493
- }
2494
-
2495
- /** [EN]
2496
- * Image message
2497
- * @category Interface
2498
- */
2499
- /**
2500
- * 图片消息
2501
- * @category Interface
2502
- * @deprecated - 已废弃,请使用 `IImageMessageContent` 替代
2503
- */
2504
- declare type IImageMessageBody = IImageMessageContent;
2505
-
2506
- declare class ImageMessage extends BuiltinMessage<IImageMessageContent> {
2507
- constructor(content: IImageMessageContent);
2508
- }
2509
-
2510
- /** [EN]
2511
- * Gray bar message
2512
- * @category Interface
2513
- */
2514
- /**
2515
- * 小灰条消息
2516
- * @category Interface
2517
- * @deprecated - 已废弃,请使用 `IInformationNotificationMessageContent` 替代
2518
- */
2519
- declare type IInformationNotificationMessageBody = IInformationNotificationMessageContent;
2520
-
2521
- declare class InformationNotificationMessage extends BuiltinMessage<IInformationNotificationMessageContent> {
2522
- constructor(content: IInformationNotificationMessageContent);
2523
- }
2524
-
2525
- /** [EN]
2526
- * Local message content data
2527
- * @category Interface
2528
- */
2529
- /**
2530
- * 位置消息数据
2531
- * @category Interface
2532
- * @deprecated - 已废弃,请使用 `ILocationMessageContent` 替代
2533
- */
2534
- declare type ILocationMessageBody = ILocationMessageContent;
2535
-
2536
- /**
2537
- * 位置消息
2538
- */
2539
- declare class LocationMessage extends BuiltinMessage<ILocationMessageContent> {
2540
- constructor(content: ILocationMessageContent);
2541
- }
2542
-
2543
- /** [EN]
2544
- * Quote message content data
2545
- * @category Interface
2546
- */
2547
- /**
2548
- * 引用消息
2549
- * @category Interface
2550
- * @deprecated - 已废弃,请使用 `IReferenceMessageContent` 替代
2551
- */
2552
- declare type IReferenceMessageBody = IReferenceMessageContent;
2553
-
2554
- declare class ReferenceMessage extends BuiltinMessage<IReferenceMessageContent> {
2555
- constructor(content: IReferenceMessageContent);
2556
- }
2557
-
2558
- /** [EN]
2559
- * Rich text message
2560
- * @category Interface
2561
- */
2562
- /**
2563
- * 富文本消息
2564
- * @category Interface
2565
- * @deprecated - 已废弃,请使用 `IRichContentMessageContent` 替代
2566
- */
2567
- declare type IRichContentMessageBody = IRichContentMessageContent;
2568
-
2569
- declare class RichContentMessage extends BuiltinMessage<IRichContentMessageContent> {
2570
- constructor(content: IRichContentMessageContent);
2571
- }
2572
-
2573
- /** [EN]
2574
- * Short video message content data
2575
- * @category Interface
2576
- */
2577
- /**
2578
- * 短视频消息 content 数据
2579
- * @deprecated - 已废弃,请使用 `ISightMessageContent` 替代
2580
- * @category Interface
2581
- */
2582
- declare type ISightMessageBody = ISightMessageContent;
2583
-
2584
- /** [EN]
2585
- * Short video message
2586
- */
2587
- /**
2588
- * 短视频消息
2589
- */
2590
- declare class SightMessage extends BuiltinMessage<ISightMessageBody> {
2591
- constructor(content: ISightMessageBody);
2592
- }
2593
-
2594
- /**
2595
- * 流式消息内容结构
2596
- * @category Interface
2597
- * @deprecated - 已废弃,请使用 `IStreamMessageContent` 替代
2598
- */
2599
- declare type IStreamMessageBody = IStreamMessageContent;
2600
-
2601
- /** [EN]
2602
- * Text message content data
2603
- * @category Interface
2604
- */
2605
- /**
2606
- * 文本消息 content 数据
2607
- * @deprecated - 已废弃,请使用 `ITextMessageContent` 替代
2608
- * @category Interface
2609
- */
2610
- declare type ITextMessageBody = ITextMessageContent;
2611
-
2612
- declare class TextMessage extends BuiltinMessage<ITextMessageContent> {
2613
- constructor(content: ITextMessageContent);
2614
- }
2615
-
2616
- /** [EN]
2617
- * Voice Message content data
2618
- * @category Interface
2619
- */
2620
- /**
2621
- * 高清语音消息 content 数据
2622
- * @category Interface
2623
- * @deprecated - 已废弃,使用 IHQVoiceMessageContent 代替
2624
- */
2625
- declare type IHQVoiceMessageBody = IHQVoiceMessageContent;
2626
- /**
2627
- * 高清语音消息类型
2628
- */
2629
- declare class HQVoiceMessage extends BuiltinMessage<IHQVoiceMessageContent> {
2630
- constructor(content: IHQVoiceMessageContent);
2631
- }
2632
- /**
2633
- * 语音消息 content 数据
2634
- * @category Interface
2635
- * @deprecated - 已废弃,使用 IVoiceMessageContent 代替
2636
- */
2637
- declare type IVoiceMessageBody = IVoiceMessageContent;
2638
- declare class VoiceMessage extends BuiltinMessage<IVoiceMessageContent> {
2639
- constructor(content: IVoiceMessageContent);
2640
- }
2394
+ declare function getBlacklistStatus(userId: string): Promise<RCResult<boolean>>;
2641
2395
 
2642
2396
  /**
2643
2397
  * 获取本地消息
@@ -2651,7 +2405,7 @@ declare const getMessage: typeof getLocalMessage;
2651
2405
  * @param conversation Conversation information
2652
2406
  * @param message The message body, which is a subclass of BaseMessage, such as TextMessage, ImageMessage, obtained via new TextMessage()
2653
2407
  * @param options Configuration options for sending messages
2654
- * @returns Returns a Promise of type {@link IAsyncRes}, with the data structure being {@link IAReceivedMessage}
2408
+ * @returns Returns a Promise of type {@link RCResult}, with the data structure being {@link IAReceivedMessage}
2655
2409
  * @example
2656
2410
  * Example of sending a text message:
2657
2411
  * ```ts
@@ -2673,7 +2427,7 @@ declare const getMessage: typeof getLocalMessage;
2673
2427
  * @param message 消息体,类型为 BaseMessage 的子类,如 TextMessage、ImageMessage,通过 new TextMessage() 获取
2674
2428
  * @param options 发送消息配置项
2675
2429
  *
2676
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2430
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2677
2431
  *
2678
2432
  * @example
2679
2433
  * 发送文本消息示例:
@@ -2688,7 +2442,7 @@ declare const getMessage: typeof getLocalMessage;
2688
2442
  * console.info('消息发送结果:', sendRes);
2689
2443
  * ```
2690
2444
  */
2691
- declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, message: BaseMessage, options?: ISendMessageOptions | undefined) => Promise<IAsyncRes<IAReceivedMessage>>>;
2445
+ declare const sendMessage: MonitorableAPI<(conversation: IConversationIdentifier, message: BaseMessage, options?: ISendMessageOptions | undefined) => Promise<RCResult<IAReceivedMessage>>>;
2692
2446
  /** [EN]
2693
2447
  * Send text message
2694
2448
  * @description A shortcut for sending text messages, equivalent to creating a message body using `new TextMessage()` and then calling the `sendMessage()` method.
@@ -2696,7 +2450,6 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
2696
2450
  * @param conversation Conversation information
2697
2451
  * @param messageBody Message body
2698
2452
  * @param options Message sending configuration options
2699
- * @returns Returns a Promise of type {@link IAsyncRes}, with the data structure of type {@link IAReceivedMessage}
2700
2453
  * @example
2701
2454
  * Example of sending a text message:
2702
2455
  * ```ts
@@ -2716,9 +2469,6 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
2716
2469
  * @param conversation 会话信息
2717
2470
  * @param messageBody 消息体
2718
2471
  * @param options 发送消息配置项
2719
- *
2720
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2721
- *
2722
2472
  * @example
2723
2473
  * 发送文本消息示例:
2724
2474
  * ```ts
@@ -2731,7 +2481,7 @@ declare const sendMessage: MonitorableAPI<(conversation: IConversationOption, me
2731
2481
  * console.info('消息发送结果:', sendRes);
2732
2482
  * ```
2733
2483
  */
2734
- declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>;
2484
+ declare function sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageContent, options?: ISendMessageOptions): Promise<RCResult<IAReceivedMessage>>;
2735
2485
  /** [EN]
2736
2486
  * Basic message types
2737
2487
  * @category Type
@@ -2763,9 +2513,6 @@ declare type ISendFileMessageOptions = ISendBody;
2763
2513
  * @param msgBody 消息体,其中 file 为待上传文件引用
2764
2514
  * @param hooks 上传文件过程中的回调钩子,类型为 {@link IUploadHooks} 可选
2765
2515
  * @param sendOptions 文件消息配置项,类型为 {@link IUploadMessageOption} 可选
2766
- *
2767
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2768
- *
2769
2516
  * @example
2770
2517
  * 发送文本消息示例:
2771
2518
  * ```ts
@@ -2778,7 +2525,7 @@ declare type ISendFileMessageOptions = ISendBody;
2778
2525
  * console.info('消息发送结果:', sendRes);
2779
2526
  * ```
2780
2527
  */
2781
- declare const sendFileMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
2528
+ declare const sendFileMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
2782
2529
  /** [EN]
2783
2530
  * Image message sending configuration
2784
2531
  * @category Type
@@ -2796,8 +2543,6 @@ declare type ISendImageMessageOptions = ISendBody;
2796
2543
  * @param msgBody Message body, where file is the reference to the image to be uploaded
2797
2544
  * @param hooks Callback hooks during the image upload process, of type {@link IUploadHooks} (optional)
2798
2545
  * @param sendOptions Image message configuration options, of type {@link IImageMessageOption} (optional)
2799
- * *
2800
- * @returns Returns a Promise of type {@link IAsyncRes}, with data structured as {@link IAReceivedMessage}
2801
2546
  * @example
2802
2547
  * Example of sending an image message:
2803
2548
  * ```ts
@@ -2818,8 +2563,6 @@ declare type ISendImageMessageOptions = ISendBody;
2818
2563
  * @param msgBody 消息体,其中 file 为待上传图片引用
2819
2564
  * @param hooks 上传图片过程中的回调钩子,类型为 {@link IUploadHooks} 可选
2820
2565
  * @param sendOptions 图片消息配置项,类型为 {@link IImageMessageOption} 可选
2821
- *
2822
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2823
2566
  * @example
2824
2567
  * 发送图片消息示例:
2825
2568
  * ```ts
@@ -2832,7 +2575,7 @@ declare type ISendImageMessageOptions = ISendBody;
2832
2575
  * console.info('消息发送结果:', sendRes);
2833
2576
  * ```
2834
2577
  */
2835
- declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IImageMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
2578
+ declare const sendImageMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IImageMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
2836
2579
  /** [EN]
2837
2580
  * Send a GIF image message
2838
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.
@@ -2841,8 +2584,6 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
2841
2584
  * @param msgBody Message body, where 'file' is the reference to the GIF image to be uploaded
2842
2585
  * @param hooks Callback hooks during the GIF image upload process, of type {@link IUploadHooks} (optional)
2843
2586
  * @param sendOptions Configuration options for the GIF image message, of type {@link IGIFMessageOption} (optional)
2844
- * *
2845
- * @returns Returns a Promise of type {@link IAsyncRes}, where the 'data' structure is of type {@link IAReceivedMessage}
2846
2587
  * @example
2847
2588
  * Example of sending a GIF image message:
2848
2589
  * ```ts
@@ -2863,8 +2604,6 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
2863
2604
  * @param msgBody 消息体,其中 file 为待上传 GIF 图片引用
2864
2605
  * @param hooks 上传 GIF 图片过程中的回调钩子,类型为 {@link IUploadHooks} 可选
2865
2606
  * @param sendOptions GIF 图片消息配置项,类型为 {@link IGIFMessageOption} 可选
2866
- *
2867
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2868
2607
  * @example
2869
2608
  * 发送 GIF 图片消息示例:
2870
2609
  * ```ts
@@ -2877,7 +2616,7 @@ declare const sendImageMessage: (conversation: IConversationOption, msgBody: ISe
2877
2616
  * console.info('消息发送结果:', sendRes);
2878
2617
  * ```
2879
2618
  */
2880
- declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
2619
+ declare const sendGIFMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
2881
2620
  /** [EN]
2882
2621
  * Send high-quality voice message
2883
2622
  * @description The file to be sent must be an AAC audio file.
@@ -2887,7 +2626,6 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
2887
2626
  * @param msgBody Message body, where `file` is the reference to the high-quality voice file to be uploaded
2888
2627
  * @param hooks Callback hooks during the high-quality voice upload process, of type {@link IUploadHooks} (optional)
2889
2628
  * @param sendOptions Configuration options for high-quality voice messages, of type {@link ISendHQVoiceMessageOptions} (optional)
2890
- * @returns Returns a Promise of type {@link IAsyncRes}, where the `data` structure is of type {@link IAReceivedMessage}
2891
2629
  * @example
2892
2630
  * Example of sending a high-quality voice message:
2893
2631
  * ```ts
@@ -2909,7 +2647,6 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
2909
2647
  * @param msgBody 消息体,其中 file 为待上传高清语音引用
2910
2648
  * @param hooks 上传高清语音过程中的回调钩子,类型为 {@link IUploadHooks} 可选
2911
2649
  * @param sendOptions 高清语音消息配置项,类型为 {@link ISendHQVoiceMessageOptions} 可选
2912
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2913
2650
  * @example
2914
2651
  * 发送高清语音消息示例:
2915
2652
  * ```ts
@@ -2922,7 +2659,7 @@ declare const sendGIFMessage: (conversation: IConversationOption, msgBody: ISend
2922
2659
  * console.info('消息发送结果:', sendRes);
2923
2660
  * ```
2924
2661
  */
2925
- declare const sendHQVoiceMessage: (conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
2662
+ declare const sendHQVoiceMessage: (conversation: IConversationIdentifier, msgBody: ISendBody, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
2926
2663
  /** [EN]
2927
2664
  * Configuration options for sending short video messages
2928
2665
  * @category Type
@@ -2945,7 +2682,6 @@ declare type ISendSightMessageOptions = {
2945
2682
  * @param msgBody Message body, where file is the reference to the short video to be uploaded
2946
2683
  * @param hooks Callback hooks during the short video upload process, of type {@link IUploadHooks} (optional)
2947
2684
  * @param sendOptions Configuration options for the short video message, of type {@link ISendSightMessageOptions} (optional)
2948
- * @returns Returns a Promise of type {@link IAsyncRes}, with the data structure of type {@link IAReceivedMessage}
2949
2685
  * @example
2950
2686
  * Example of sending a short video message:
2951
2687
  * ```ts
@@ -2967,7 +2703,6 @@ declare type ISendSightMessageOptions = {
2967
2703
  * @param msgBody 消息体,其中 file 为待上传小视频引用
2968
2704
  * @param hooks 上传小视频过程中的回调钩子,类型为 {@link IUploadHooks} 可选
2969
2705
  * @param sendOptions 小视频消息配置项,类型为 {@link ISendSightMessageOptions} 可选
2970
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
2971
2706
  * @example
2972
2707
  * 发送小视频消息示例:
2973
2708
  * ```ts
@@ -2980,7 +2715,7 @@ declare type ISendSightMessageOptions = {
2980
2715
  * console.info('消息发送结果:', sendRes);
2981
2716
  * ```
2982
2717
  */
2983
- declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<IAsyncRes<IAReceivedMessage>>;
2718
+ declare const sendSightMessage: (conversation: IConversationIdentifier, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks | undefined, sendOptions?: IUploadMessageOption | undefined) => Promise<RCResult<IAReceivedMessage>>;
2984
2719
  /** [EN]
2985
2720
  * Get history messages
2986
2721
  * @category Message
@@ -2994,8 +2729,6 @@ declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISe
2994
2729
  * @param conversation Conversation information
2995
2730
  * @param options Configuration for retrieving historical messages, of type {@link GetHistoryMessageOption} (optional)
2996
2731
  * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
2997
- * @returns Returns a Promise of type {@link IAsyncRes}, where the `data` structure is of type {@link GetHistoryMessageResult}
2998
- * *
2999
2732
  * @example
3000
2733
  * Example of retrieving historical messages:
3001
2734
  * ```ts
@@ -3020,8 +2753,6 @@ declare const sendSightMessage: (conversation: IConversationOption, msgBody: ISe
3020
2753
  * @param conversation 会话信息
3021
2754
  * @param options 获取历史消息配置项,类型为 {@link GetHistoryMessageOption} 可选
3022
2755
  * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
3023
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link GetHistoryMessageResult} 类型
3024
- *
3025
2756
  * @example
3026
2757
  * 获取历史消息示例:
3027
2758
  * ```ts
@@ -3044,7 +2775,6 @@ declare function getHistoryMessages(conversation: IConversationOption, options?:
3044
2775
  * @param conversation Conversation information
3045
2776
  * @param options Configuration options for retrieving history messages, of type {@link GetHistoryMessageOption} (optional)
3046
2777
  * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
3047
- * @returns Returns a Promise of type {@link IAsyncRes}, with the data structure being {@link GetHistoryMessageResult}
3048
2778
  * @example
3049
2779
  * Example of retrieving remote history messages:
3050
2780
  * ```ts
@@ -3068,8 +2798,6 @@ declare function getHistoryMessages(conversation: IConversationOption, options?:
3068
2798
  * @param conversation 会话信息
3069
2799
  * @param options 获取历史消息配置项,类型为 {@link GetHistoryMessageOption} 可选
3070
2800
  * @defaultValue options = { timestamp: 0, count: 20, order: 0 }
3071
- *
3072
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link GetHistoryMessageResult} 类型
3073
2801
  * @example
3074
2802
  * 获取远程历史消息示例:
3075
2803
  * ```ts
@@ -3138,7 +2866,7 @@ declare function getRemoteHistoryMessages(conversation: IConversationOption, opt
3138
2866
  * console.info('单聊消息回执:', readReceiptRes)
3139
2867
  * ```
3140
2868
  */
3141
- declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<void>>;
2869
+ declare function sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<RCResult>;
3142
2870
  /** [EN]
3143
2871
  * Send group read receipt request
3144
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.
@@ -3173,7 +2901,7 @@ declare function sendReadReceiptMessage(targetId: string, messageUId: string, ti
3173
2901
  * console.info('群已读回执请求:', readReceiptRes)
3174
2902
  * ```
3175
2903
  */
3176
- declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<void>>;
2904
+ declare function sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<RCResult>;
3177
2905
  /** [EN]
3178
2906
  * @category Message
3179
2907
  * @deprecated since version 5.1.1. Please use {@link sendReadReceiptResponseV2} instead.
@@ -3270,7 +2998,7 @@ declare function sendReadReceiptResponseV2(targetId: string, messageList: Record
3270
2998
  * console.info('多端同步阅读状态:', syncReadStatusRes);
3271
2999
  * ```
3272
3000
  */
3273
- declare function sendSyncReadStatusMessage(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
3001
+ declare function sendSyncReadStatusMessage(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
3274
3002
  /** [EN]
3275
3003
  * Send read receipt (V4 version)
3276
3004
  * After calling this interface, the message sender will receive the EVENTS.MESSAGE_READ_RECEIPT_V4 event notification.
@@ -3283,15 +3011,15 @@ declare function sendSyncReadStatusMessage(conversation: IConversationOption, ti
3283
3011
  * @example
3284
3012
  * ```js
3285
3013
  * const con = {
3286
- * conversationType: ConversationType.Group,
3287
- * targetId: 'targetId'
3014
+ * conversationType: ConversationType.Group,
3015
+ * targetId: 'targetId'
3288
3016
  * }
3289
3017
  * sendReadReceiptMessageV4(con, 'endMsgUId', 'startMsgUId').then(res => {
3290
- * if (res.code === ErrorCode.success) {
3291
- * console.log('Send success')
3292
- * } else {
3293
- * console.log('Send error', res.msg)
3294
- * }
3018
+ * if (res.code === ErrorCode.success) {
3019
+ * console.log('Send success')
3020
+ * } else {
3021
+ * console.log('Send error', res.msg)
3022
+ * }
3295
3023
  * })
3296
3024
  * ```
3297
3025
  */
@@ -3321,7 +3049,7 @@ declare function sendSyncReadStatusMessage(conversation: IConversationOption, ti
3321
3049
  * })
3322
3050
  * ```
3323
3051
  */
3324
- declare function sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<IAsyncRes<void>>;
3052
+ declare function sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<RCResult>;
3325
3053
  /** [EN]
3326
3054
  * Get the read receipt list for a message
3327
3055
  * This API requires enabling the service in the developer console
@@ -3332,15 +3060,15 @@ declare function sendReadReceiptMessageV4(conversation: IConversationOption, end
3332
3060
  * @example
3333
3061
  * ```js
3334
3062
  * const con = {
3335
- * conversationType: ConversationType.Group,
3336
- * targetId: 'targetId'
3063
+ * conversationType: ConversationType.Group,
3064
+ * targetId: 'targetId'
3337
3065
  * }
3338
3066
  * getMessageReadReceiptV4(con, 'MsgUId').then(res => {
3339
- * if (res.code === ErrorCode.success) {
3340
- * console.log('send success', res.data)
3341
- * } else {
3342
- * console.log('send error', res.msg)
3343
- * }
3067
+ * if (res.code === ErrorCode.success) {
3068
+ * console.log('send success', res.data)
3069
+ * } else {
3070
+ * console.log('send error', res.msg)
3071
+ * }
3344
3072
  * })
3345
3073
  * ```
3346
3074
  */
@@ -3367,7 +3095,7 @@ declare function sendReadReceiptMessageV4(conversation: IConversationOption, end
3367
3095
  * })
3368
3096
  * ```
3369
3097
  */
3370
- declare function getMessageReadReceiptV4(conversation: IConversationOption, messageUId: string): Promise<IAsyncRes<IMessageReadReceiptV4Response>>;
3098
+ declare function getMessageReadReceiptV4(conversation: IConversationIdentifier, messageUId: string): Promise<RCResult<IMessageReadReceiptV4Response>>;
3371
3099
  /** [EN]
3372
3100
  * Get the read receipt list for messages
3373
3101
  * This API requires the service to be enabled in the developer console
@@ -3378,15 +3106,15 @@ declare function getMessageReadReceiptV4(conversation: IConversationOption, mess
3378
3106
  * @example
3379
3107
  * ```js
3380
3108
  * const con = {
3381
- * conversationType: ConversationType.Group,
3109
+ * conversationType: ConversationType.Group,
3382
3110
  * targetId: 'targetId'
3383
3111
  * }
3384
3112
  * batchGetMessageReadReceiptInfoV4(con, ['MsgUId']).then(res => {
3385
- * if (res.code === ErrorCode.success) {
3386
- * console.log('send success', res.data)
3387
- * } else {
3388
- * console.log('send error', res.msg)
3389
- * }
3113
+ * if (res.code === ErrorCode.success) {
3114
+ * console.log('send success', res.data)
3115
+ * } else {
3116
+ * console.log('send error', res.msg)
3117
+ * }
3390
3118
  * })
3391
3119
  * ```
3392
3120
  */
@@ -3413,7 +3141,7 @@ declare function getMessageReadReceiptV4(conversation: IConversationOption, mess
3413
3141
  * })
3414
3142
  * ```
3415
3143
  */
3416
- declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): Promise<IAsyncRes<IGroupReadReceiptData[]>>;
3144
+ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationIdentifier, messageUIds: string[]): Promise<RCResult<IGroupReadReceiptData[]>>;
3417
3145
  /** [EN]
3418
3146
  * Recall message
3419
3147
  * @description RC does not impose restrictions on who can recall messages.
@@ -3435,7 +3163,6 @@ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOpt
3435
3163
  * const recallRes = await RongIMLib.recallMessage(conversation, options);
3436
3164
  * console.info('Recall message result:', recallRes);
3437
3165
  * ```
3438
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IAReceivedMessage}
3439
3166
  */
3440
3167
  /**
3441
3168
  * 撤回消息
@@ -3458,7 +3185,6 @@ declare function batchGetMessageReadReceiptInfoV4(conversation: IConversationOpt
3458
3185
  * const recallRes = await RongIMLib.recallMessage(conversation, options);
3459
3186
  * console.info('撤回消息结果:', recallRes);
3460
3187
  * ```
3461
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
3462
3188
  */
3463
3189
  declare const recallMessage: MonitorableAPI<(conversation: IConversationOption, options: IRecallMessageOptions) => Promise<RCResult<IAReceivedMessage>>>;
3464
3190
  /** [EN]
@@ -3697,14 +3423,13 @@ declare function removeMessageExpansionForKey(keys: string[], message: IAReceive
3697
3423
  * @category Message
3698
3424
  * @param conversation Conversation information
3699
3425
  * @param typingContentType Typing status message type
3700
- * @returns Returns a Promise of type {@link IAsyncRes}, with data structured as {@link IAReceivedMessage}
3701
- * *
3426
+ * @returns Returns a Promise of type {@link RCResult}, with data structured as {@link IAReceivedMessage}
3702
3427
  * @example
3703
3428
  * Example of sending a typing status message:
3704
3429
  * ```ts
3705
3430
  * const conversation = {
3706
- * conversationType: RongIMLib.ConversationType.PRIVATE,
3707
- * targetId: 'targetId',
3431
+ * conversationType: RongIMLib.ConversationType.PRIVATE,
3432
+ * targetId: 'targetId',
3708
3433
  * }
3709
3434
  * const typingContentType = RongIMLib.MessageType.TEXT;
3710
3435
  * const typingRes = await RongIMLib.sendTypingStatusMessage(conversation, typingContentType);
@@ -3717,27 +3442,26 @@ declare function removeMessageExpansionForKey(keys: string[], message: IAReceive
3717
3442
  * @category 消息
3718
3443
  * @param conversation 会话信息
3719
3444
  * @param typingContentType 输入状态消息类型
3720
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
3721
- *
3445
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
3722
3446
  * @example
3723
3447
  * 发送输入状态消息示例:
3724
3448
  * ```ts
3725
3449
  * const conversation = {
3726
- * conversationType: RongIMLib.ConversationType.PRIVATE,
3727
- * targetId: 'targetId',
3450
+ * conversationType: RongIMLib.ConversationType.PRIVATE,
3451
+ * targetId: 'targetId',
3728
3452
  * }
3729
3453
  * const typingContentType = RongIMLib.MessageType.TEXT;
3730
3454
  * const typingRes = await RongIMLib.sendTypingStatusMessage(conversation, typingContentType);
3731
3455
  * console.info('发送 typing 消息结果:', typingRes);
3732
3456
  * ```
3733
3457
  */
3734
- declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<IAsyncRes<IAReceivedMessage>>;
3458
+ declare function sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<RCResult<IAReceivedMessage>>;
3735
3459
  /** [EN]
3736
- * Get group read list
3460
+ * Get group read list, need to enable group read receipt service V2 version, otherwise it cannot be used.
3737
3461
  * @category Message
3738
3462
  * @param targetId Group ID
3739
3463
  * @param messageUId Message UID
3740
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IMessageReaderResponse}
3464
+ * @returns Returns a Promise of type {@link RCResult}, where the data structure is of type {@link IMessageReaderResponse}
3741
3465
  * @example
3742
3466
  * ```ts
3743
3467
  * const messageUId = 'messageUId';
@@ -3747,11 +3471,11 @@ declare function sendTypingStatusMessage(conversation: IConversationOption, typi
3747
3471
  * ```
3748
3472
  */
3749
3473
  /**
3750
- * 获取群已读列表
3474
+ * 获取群已读列表,需开通群已读回执服务 V2 版本,否则无法使用
3751
3475
  * @category 消息
3752
3476
  * @param targetId 群 ID
3753
3477
  * @param messageUId 消息 UID
3754
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IMessageReaderResponse} 类型
3478
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 结构为 {@link IMessageReaderResponse} 类型
3755
3479
  * @example
3756
3480
  * ```ts
3757
3481
  * const messageUId = 'messageUId';
@@ -3760,7 +3484,7 @@ declare function sendTypingStatusMessage(conversation: IConversationOption, typi
3760
3484
  * console.info('获取群已读列表结果:', getReaderRes);
3761
3485
  * ```
3762
3486
  */
3763
- declare function getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<IMessageReaderResponse>>;
3487
+ declare function getMessageReader(targetId: string, messageUId: string, channelId?: string): Promise<RCResult<IMessageReaderResponse>>;
3764
3488
  /** [EN]
3765
3489
  * Register custom message
3766
3490
  * @description Registers a custom message type, which affects the sending and receiving of custom messages.
@@ -3819,8 +3543,6 @@ declare function registerMessageType<T>(messageType: string, isPersited: boolean
3819
3543
  * @description Retrieves the first unread message in the specified conversation. This feature is only supported on the Electron platform.
3820
3544
  * @category Message
3821
3545
  * @param conversation
3822
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IAReceivedMessage}.
3823
- *
3824
3546
  * @example
3825
3547
  * Example of getting the first unread message:
3826
3548
  * ```ts
@@ -3837,7 +3559,6 @@ declare function registerMessageType<T>(messageType: string, isPersited: boolean
3837
3559
  * @description 获取指定会话中的第一条未读消息,仅支持 Electron 平台
3838
3560
  * @category 消息
3839
3561
  * @param conversation
3840
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IAReceivedMessage} 类型
3841
3562
  * @example
3842
3563
  * 获取第一条未读消息示例:
3843
3564
  * ```ts
@@ -3859,7 +3580,6 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
3859
3580
  * **Note**:
3860
3581
  * 1. When there are no unread messages, the returned data is null
3861
3582
  * 2. When the first unread message is recalled, this information will not be updated
3862
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data structure is of type {@link IFirstUnreadMessageInfo}
3863
3583
  * @example
3864
3584
  * Example of getting the first unread message information:
3865
3585
  * ```ts
@@ -3880,7 +3600,6 @@ declare function getFirstUnreadMessage(conversation: IConversationOption): Promi
3880
3600
  * **注意**:
3881
3601
  * 1. 当没有未读消息时,返回的 data 为 null
3882
3602
  * 2. 当第一条未读消息被撤回时,此信息不会更新
3883
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 结构为 {@link IFirstUnreadMessageInfo} 类型
3884
3603
  * @example
3885
3604
  * 获取第一条未读消息信息示例:
3886
3605
  * ```ts
@@ -3903,7 +3622,7 @@ declare function getFirstUnreadMessageInfo(conversation: IConversationOption): P
3903
3622
  * @category 消息
3904
3623
  * @deprecated 请使用 {@link electronExtension.insertMessage} 代替
3905
3624
  */
3906
- declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>;
3625
+ declare function insertMessage$1(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<RCResult<IAReceivedMessage>>;
3907
3626
  /** [EN]
3908
3627
  * Get unread mentioned messages
3909
3628
  * @deprecated This method is deprecated since version 5.28.0. Please use {@link electronExtension.getUnreadMentionedMessages} instead.
@@ -3934,7 +3653,7 @@ declare function searchMessages$1(conversation: IConversationOption, keyword: st
3934
3653
  * @category 消息
3935
3654
  * @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.deleteMessagesByTimestamp} 方法
3936
3655
  */
3937
- declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>;
3656
+ declare function deleteLocalMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<RCResult>;
3938
3657
  /** [EN]
3939
3658
  * Clear historical messages in a conversation
3940
3659
  * @category Message
@@ -3945,7 +3664,7 @@ declare function deleteLocalMessagesByTimestamp(conversation: IConversationOptio
3945
3664
  * @category 消息
3946
3665
  * @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.clearMessages} 方法
3947
3666
  */
3948
- declare function clearMessages$1(conversation: IConversationOption): Promise<IAsyncRes<void>>;
3667
+ declare function clearMessages$1(conversation: IConversationOption): Promise<RCResult>;
3949
3668
  /** [EN]
3950
3669
  * Search conversations by content
3951
3670
  * @category Message
@@ -3956,10 +3675,10 @@ declare function clearMessages$1(conversation: IConversationOption): Promise<IAs
3956
3675
  * @category 消息
3957
3676
  * @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.searchConversationByContent} 方法
3958
3677
  */
3959
- declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[] | undefined>>;
3678
+ declare function searchConversationByContent$1(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<RCResult<IAReceivedConversation[] | undefined>>;
3960
3679
  /** [EN]
3961
3680
  * Clear unread count before timestamp
3962
- * @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.
3963
3682
  * @category Message
3964
3683
  * @param conversation Conversation information
3965
3684
  * @param timestamp Timestamp for clearing unread count
@@ -3978,7 +3697,7 @@ declare function searchConversationByContent$1(keyword: string, conversationType
3978
3697
  */
3979
3698
  /**
3980
3699
  * 清除时间戳前的未读数
3981
- * @description 清除时间戳前的未读数,仅支持 Electron 平台。
3700
+ * @description 清除时间戳前的未读数,仅支持 Electron 平台,不支持清理超级群会话
3982
3701
  * @category 消息
3983
3702
  * @param conversation 会话信息
3984
3703
  * @param timestamp 清理未读时间戳
@@ -3995,7 +3714,7 @@ declare function searchConversationByContent$1(keyword: string, conversationType
3995
3714
  * console.info('清除时间戳前的未读数结果:', clearRes);
3996
3715
  * ```
3997
3716
  */
3998
- declare function clearUnreadCountByTimestamp(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>;
3717
+ declare function clearUnreadCountByTimestamp(conversation: IConversationIdentifier, timestamp: number): Promise<RCResult>;
3999
3718
  /** [EN]
4000
3719
  * Set message receiving status
4001
3720
  * @category Message
@@ -4006,7 +3725,7 @@ declare function clearUnreadCountByTimestamp(conversation: IConversationOption,
4006
3725
  * @category 消息
4007
3726
  * @deprecated 已废弃,@since 5.4.0。请替换使用 {@link electronExtension.setMessageReceivedStatusInfo} 方法
4008
3727
  */
4009
- declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<IAsyncRes<void>>;
3728
+ declare function setMessageReceivedStatus$1(messageId: number, receivedStatus: number): Promise<RCResult>;
4010
3729
  /**
4011
3730
  * 请求流式消息内容;请求成功后,数据将通过 `Events.STREAM_MESSAGE_RESPONSE` 事件通知
4012
3731
  * @param messageUId
@@ -4280,7 +3999,7 @@ declare function updateTag(tag: ITagParam): Promise<RCResult>;
4280
3999
  * Get tag list
4281
4000
  * @category Tag
4282
4001
  * @description Retrieves the tag list of the current user
4283
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is the tag list of type {@link ITagInfo} array or undefined
4002
+ * @returns Returns a Promise of type {@link RCResult}, where the data is the tag list of type {@link ITagInfo} array or undefined
4284
4003
  * @example Example of getting the tag list:
4285
4004
  * ```ts
4286
4005
  * const res = await RongIMLib.getTags();
@@ -4304,7 +4023,7 @@ declare function getTags(): Promise<RCResult<ITagInfo[]>>;
4304
4023
  * @description Retrieves the list of tags for a specific conversation based on conversation information
4305
4024
  * @category Tags
4306
4025
  * @param conversation Conversation information, including conversation type, conversation ID, and channelId, of type {@link IConversationOption}
4307
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of tags of type {@link IConversationTag} or undefined
4026
+ * @returns Returns a Promise of type {@link RCResult}, where the data is an array of tags of type {@link IConversationTag} or undefined
4308
4027
  * @example Example of getting tags for a conversation:
4309
4028
  * ```ts
4310
4029
  * const conversation = {
@@ -4486,7 +4205,7 @@ declare function removeTagFromConversations(tagId: string, conversations: IConve
4486
4205
  * @param tagId The ID of the tag
4487
4206
  * @param count The number of conversations to retrieve
4488
4207
  * @param timestamp The timestamp of the message in the conversation
4489
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of conversations of type {@link IAReceivedConversationByTag} or undefined
4208
+ * @returns Returns a Promise of type {@link RCResult}, where the data is an array of conversations of type {@link IAReceivedConversationByTag} or undefined
4490
4209
  * Starting from SDK version @since 5.7.0, the return data type of this interface has changed from {@link IReceivedConversationByTag} to {@link IAReceivedConversationByTag}
4491
4210
  * @example Example of paginating conversations under a tag:
4492
4211
  * ```ts
@@ -4582,25 +4301,271 @@ declare function getUnreadCountByTag(tagId: string, containMuted: boolean): Prom
4582
4301
  */
4583
4302
  declare function setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<RCResult>;
4584
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` 替代
4474
+ */
4475
+ declare type IRichContentMessageBody = IRichContentMessageContent;
4476
+
4477
+ declare class RichContentMessage extends BuiltinMessage<IRichContentMessageContent> {
4478
+ constructor(content: IRichContentMessageContent);
4479
+ }
4480
+
4481
+ /** [EN]
4482
+ * Short video message content data
4483
+ * @category Interface
4484
+ */
4485
+ /**
4486
+ * 短视频消息 content 数据
4487
+ * @deprecated - 已废弃,请使用 `ISightMessageContent` 替代
4488
+ * @category Interface
4489
+ */
4490
+ declare type ISightMessageBody = ISightMessageContent;
4491
+
4492
+ /** [EN]
4493
+ * Short video message
4494
+ */
4495
+ /**
4496
+ * 短视频消息
4497
+ */
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
+
4509
+ /** [EN]
4510
+ * Text message content data
4511
+ * @category Interface
4512
+ */
4513
+ /**
4514
+ * 文本消息 content 数据
4515
+ * @deprecated - 已废弃,请使用 `ITextMessageContent` 替代
4516
+ * @category Interface
4517
+ */
4518
+ declare type ITextMessageBody = ITextMessageContent;
4519
+
4520
+ declare class TextMessage extends BuiltinMessage<ITextMessageContent> {
4521
+ constructor(content: ITextMessageContent);
4522
+ }
4523
+
4524
+ /** [EN]
4525
+ * Voice Message content data
4526
+ * @category Interface
4527
+ */
4528
+ /**
4529
+ * 高清语音消息 content 数据
4530
+ * @category Interface
4531
+ * @deprecated - 已废弃,使用 IHQVoiceMessageContent 代替
4532
+ */
4533
+ declare type IHQVoiceMessageBody = IHQVoiceMessageContent;
4534
+ /**
4535
+ * 高清语音消息类型
4536
+ */
4537
+ declare class HQVoiceMessage extends BuiltinMessage<IHQVoiceMessageContent> {
4538
+ constructor(content: IHQVoiceMessageContent);
4539
+ }
4540
+ /**
4541
+ * 语音消息 content 数据
4542
+ * @category Interface
4543
+ * @deprecated - 已废弃,使用 IVoiceMessageContent 代替
4544
+ */
4545
+ declare type IVoiceMessageBody = IVoiceMessageContent;
4546
+ declare class VoiceMessage extends BuiltinMessage<IVoiceMessageContent> {
4547
+ constructor(content: IVoiceMessageContent);
4548
+ }
4549
+
4585
4550
  /**
4586
4551
  * 创建文件上传任务
4587
4552
  * @param uploadInfo
4588
4553
  * @hidden
4589
4554
  * @returns
4590
4555
  */
4591
- declare function createUploadTask(uploadInfo: IUploadInfo): Promise<IAsyncRes<UploadTask>>;
4556
+ declare function createUploadTask(uploadInfo: IUploadInfo): Promise<RCResult<UploadTask>>;
4592
4557
  /**
4593
4558
  * 停止文件上传任务
4594
4559
  * @hidden
4595
4560
  * @param taskId
4596
4561
  * @returns
4597
4562
  */
4598
- declare function stopUploadTask(taskId: number): Promise<IAsyncRes<boolean>>;
4563
+ declare function stopUploadTask(taskId: number): Promise<RCResult<boolean>>;
4599
4564
  /**
4600
4565
  * 上传文件
4601
4566
  * @hidden
4602
4567
  */
4603
- declare function upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResult>>;
4568
+ declare function upload(uploadInfo: IUploadInfo): Promise<RCResult<IUploadResult>>;
4604
4569
  /**
4605
4570
  * 获取文件 token
4606
4571
  * @description 上传文件时,获取文件 token
@@ -4615,7 +4580,7 @@ declare function upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResul
4615
4580
  * filename 为第一个步骤生成的 filename
4616
4581
  * 3. 上传结束前调用,此时 `httpMethod` 值应为 `POST`,`queryString` 值为 `uploadId={uploadId}`,filename 为第一个步骤生成的 filename
4617
4582
  */
4618
- declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<IAsyncRes<IUploadAuth & {
4583
+ declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?: 'POST' | 'PUT', queryString?: string): Promise<RCResult<IUploadAuth & {
4619
4584
  qiniu: string;
4620
4585
  ossConfig: string;
4621
4586
  }>>;
@@ -4627,7 +4592,7 @@ declare function getFileToken(fileType: FileType, fileName?: string, httpMethod?
4627
4592
  * token: 原 RCX 存储鉴权 token,优先使用
4628
4593
  * downloadAuthInfo: RCX 升级后,公有云私有化部署的下载鉴权信息
4629
4594
  */
4630
- declare function getDownloadAuth(url: string): Promise<IAsyncRes<{
4595
+ declare function getDownloadAuth(url: string): Promise<RCResult<{
4631
4596
  deadline: number;
4632
4597
  token?: string;
4633
4598
  downloadAuthInfo?: IDownloadAuth;
@@ -4645,7 +4610,7 @@ declare function getDownloadAuth(url: string): Promise<IAsyncRes<{
4645
4610
  declare function getFileUrl(fileType: FileType, filename: string, saveName?: string, _?: {
4646
4611
  isBosRes: boolean;
4647
4612
  downloadUrl: string;
4648
- }, serverType?: UploadMethod): Promise<IAsyncRes<{
4613
+ }, serverType?: UploadMethod): Promise<RCResult<{
4649
4614
  downloadUrl: string;
4650
4615
  }>>;
4651
4616
 
@@ -5167,7 +5132,7 @@ declare function setMessageStatusToRead(conversation: IConversationOption, times
5167
5132
  * @since 5.4.0
5168
5133
  * @deprecated @since 5.9.3 MLib SDK 版本 ≧ 5.9.3,建议使用 {@link setMessageReceivedStatusInfo} 接口替换
5169
5134
  */
5170
- declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes<void>>;
5135
+ declare function setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<RCResult>;
5171
5136
  /** [EN]
5172
5137
  * Set the received status of a message
5173
5138
  * @category Electron Only
@@ -5208,7 +5173,7 @@ declare function setMessageReceivedStatus(messageId: number, receivedStatus: Rec
5208
5173
  * console.info('设置消息的接收状态结果:', res);
5209
5174
  * ```
5210
5175
  */
5211
- declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<IAsyncRes<void>>;
5176
+ declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<RCResult>;
5212
5177
  /** [EN]
5213
5178
  * Set the sending status of a message
5214
5179
  * @category Electron Only
@@ -5241,7 +5206,7 @@ declare function setMessageReceivedStatusInfo(messageId: number, receivedStatusI
5241
5206
  * console.info('设置消息的发送状态结果:', res);
5242
5207
  * ```
5243
5208
  */
5244
- declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<IAsyncRes<void>>;
5209
+ declare function setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<RCResult>;
5245
5210
  /** [EN]
5246
5211
  * Modify message content
5247
5212
  * @category Electron only
@@ -5589,7 +5554,7 @@ declare function getMessageCount(conversation: IConversationOption): Promise<RCR
5589
5554
  * console.info('设置融云消息重排开关结果:', res);
5590
5555
  * ```
5591
5556
  */
5592
- declare function setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<IAsyncRes<boolean>>;
5557
+ declare function setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<RCResult<boolean>>;
5593
5558
  /** [EN]
5594
5559
  * Set chatroom message deduplication switch
5595
5560
  * @category Electron Only
@@ -5762,7 +5727,7 @@ declare function getUnreadMentionedMessages(conversation: IConversationOption):
5762
5727
  * @description This method is used to clear local data, including message lists, conversation lists, and the timestamp of pulled messages.
5763
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.
5764
5729
  * @since 5.4.0
5765
- * @returns Returns a {@link IAsyncRes} type Promise, where data is of boolean type, indicating whether the clearing was successful.
5730
+ * @returns Returns a {@link RCResult} type Promise, where data is of boolean type, indicating whether the clearing was successful.
5766
5731
  * @example
5767
5732
  * Example of clearing local data:
5768
5733
  * ```ts
@@ -5776,7 +5741,7 @@ declare function getUnreadMentionedMessages(conversation: IConversationOption):
5776
5741
  * @description 该方法用于清除本地数据,包括消息列表、会话列表、拉取消息的时间戳
5777
5742
  * **注意**:清除后在此登录会作为新设备进行消息拉取切操作无法恢复,谨慎使用
5778
5743
  * @since 5.4.0
5779
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 boolean 类型,表示是否清除成功
5744
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 为 boolean 类型,表示是否清除成功
5780
5745
  * @example
5781
5746
  * 清除本地数据示例:
5782
5747
  * ```ts
@@ -5894,14 +5859,14 @@ declare namespace index {
5894
5859
  * @since 5.7.0
5895
5860
  * @param proxy 代理信息
5896
5861
  */
5897
- declare function setProxy(proxy: IProxy | null): IPromiseResult<IProxy>;
5862
+ declare function setProxy(proxy: IProxy | null): Promise<RCResult>;
5898
5863
  /**
5899
5864
  * 获取代理
5900
5865
  * @hidden
5901
5866
  * @since 5.7.0
5902
5867
  * @returns
5903
5868
  */
5904
- declare function getProxy(): IPromiseResult<IProxy>;
5869
+ declare function getProxy(): Promise<RCResult<IProxy>>;
5905
5870
  /**
5906
5871
  * 测试代理
5907
5872
  * @hidden
@@ -5909,7 +5874,7 @@ declare function getProxy(): IPromiseResult<IProxy>;
5909
5874
  * @param proxy 代理信息
5910
5875
  * @param testHost 测试代理地址
5911
5876
  */
5912
- declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IResponse>;
5877
+ declare function testProxy(proxy: IProxy, testHost: string): Promise<RCResult>;
5913
5878
 
5914
5879
  /** [EN]
5915
5880
  * Subscribe user status
@@ -5921,7 +5886,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
5921
5886
  * @param userIds List of user IDs to be subscribed to, with a maximum of 200 users per subscription.
5922
5887
  * @param subscribeType Subscription type.
5923
5888
  * @param expiry Subscription validity period, ranging from [60,2592000] (unit: seconds).
5924
- * @returns Returns a {@link IAsyncRes} 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).
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).
5925
5890
  * @since 5.9.8
5926
5891
  * @example Example of subscribing to user status:
5927
5892
  * ```ts
@@ -5943,7 +5908,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
5943
5908
  * @param userIds 被订阅用户 ID 列表,一次最多订阅 200 个用户
5944
5909
  * @param subscribeType 订阅类型
5945
5910
  * @param expiry 订阅有效期,取值范围为 [60,2592000](单位:秒)
5946
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,订阅错误为 26021 时返回被订阅达上限(用户最多可以被 5000 个用户订阅)的用户 ID 列表
5911
+ * @returns 返回一个 {@link RCResult} 类型 Promise,订阅错误为 26021 时返回被订阅达上限(用户最多可以被 5000 个用户订阅)的用户 ID 列表
5947
5912
  * @since 5.9.8
5948
5913
  * @example 订阅用户状态示例:
5949
5914
  * ```ts
@@ -5955,7 +5920,7 @@ declare function testProxy(proxy: IProxy, testHost: string): IPromiseResult<IRes
5955
5920
  * console.log('订阅用户状态结果:', res);
5956
5921
  * ```
5957
5922
  */
5958
- declare function subscribeUserStatus(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<IAsyncRes<string[]>>;
5923
+ declare function subscribeUserStatus(userIds: string[], subscribeType: SubscribeType, expiry: number): Promise<RCResult<string[]>>;
5959
5924
  /** [EN]
5960
5925
  * Unsubscribe user status
5961
5926
  * @category Subscription user status
@@ -5986,14 +5951,13 @@ declare function subscribeUserStatus(userIds: string[], subscribeType: Subscribe
5986
5951
  * console.log('取消订阅用户状态结果:', res);
5987
5952
  * ```
5988
5953
  */
5989
- declare function unSubscribeUserStatus(userIds: string[], subscribeType: SubscribeType): Promise<IAsyncRes<void>>;
5954
+ declare function unSubscribeUserStatus(userIds: string[], subscribeType: SubscribeType): Promise<RCResult>;
5990
5955
  /** [EN]
5991
5956
  * Paginate and query the status information of subscribed users
5992
5957
  * @category Subscription user status
5993
5958
  * @description This method is used to retrieve the status information of all currently subscribed events (only supports online status type)
5994
5959
  * @param pageSize The number of items per page
5995
5960
  * @param offset The pagination offset
5996
- * @returns Returns a Promise of type {@link IAsyncRes}, where data is an array of type {@link ISubscribeUserStatusInfo}
5997
5961
  * @since 5.9.8
5998
5962
  * @example Example of paginating and querying the status information of subscribed users:
5999
5963
  * ```ts
@@ -6010,7 +5974,6 @@ declare function unSubscribeUserStatus(userIds: string[], subscribeType: Subscri
6010
5974
  * @description 此方法用于获取当前所有订阅的事件的状态信息(仅支持在线状态类型)
6011
5975
  * @param pageSize 数量
6012
5976
  * @param offset 分页偏移量
6013
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
6014
5977
  * @since 5.9.8
6015
5978
  * @example 分页查询已订阅用户的状态信息示例:
6016
5979
  * ```ts
@@ -6021,13 +5984,12 @@ declare function unSubscribeUserStatus(userIds: string[], subscribeType: Subscri
6021
5984
  * console.log('分页查询已订阅用户的状态信息结果:', res);
6022
5985
  * ```
6023
5986
  */
6024
- declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>;
5987
+ declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: number, offset: number): Promise<RCResult<ISubscribeUserStatusInfo[]>>;
6025
5988
  /** [EN]
6026
5989
  * Query subscription status information
6027
5990
  * @category Subscription user status
6028
5991
  * @description Queries the status information of specified users and subscription types. A maximum of 200 users' status information can be queried at once.
6029
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.
6030
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of type {@link ISubscribeUserStatusInfo}.
6031
5993
  * @since 5.9.8
6032
5994
  * @example Example of querying subscription status information:
6033
5995
  * ```ts
@@ -6042,7 +6004,6 @@ declare function getSubscribeUserList(subscribeType: SubscribeType, pageSize: nu
6042
6004
  * @category 订阅用户状态
6043
6005
  * @description 查询指定用户和订阅类型的状态信息。一次最多查询 200 个用户的状态信息
6044
6006
  * @param userIds 被订阅用户 ID 列表,列表不可为空,且一次最多查询 200 个用户的状态信息
6045
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link ISubscribeUserStatusInfo} 类型数组
6046
6007
  * @since 5.9.8
6047
6008
  * @example 查询订阅状态信息示例:
6048
6009
  * ```ts
@@ -6058,23 +6019,22 @@ declare function getSubscribeUserStatus(subscribeType: SubscribeType, userIds: s
6058
6019
  * @category User profile
6059
6020
  * @description This method is used to update the profile information of the current user.
6060
6021
  * @param profile User profile information
6061
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type { errorKey: string }
6062
6022
  * @since 5.10.1
6063
6023
  * @example Example of updating user profile:
6064
6024
  * ```ts
6065
6025
  * const profile = {
6066
- * name: 'name',
6067
- * portraitUri: 'portraitUri',
6068
- * email: 'email',
6069
- * birthday: 'birthday',
6070
- * gender: 1,
6071
- * location: 'location',
6072
- * role: 1,
6073
- * level: 1,
6074
- * extraProfile: {
6075
- * key1: 'value1',
6076
- * key2: 'value2',
6077
- * },
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
+ * },
6078
6038
  * }
6079
6039
  * const res = await RongIMLib.updateMyUserProfile(profile);
6080
6040
  * console.log('User profile update result:', res);
@@ -6085,29 +6045,28 @@ declare function getSubscribeUserStatus(subscribeType: SubscribeType, userIds: s
6085
6045
  * @category 用户资料
6086
6046
  * @description 此方法用于更新当前用户的资料信息
6087
6047
  * @param profile 用户资料信息
6088
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 { errorKey: string } 类型
6089
6048
  * @since 5.10.1
6090
6049
  * @example 更新用户资料示例:
6091
6050
  * ```ts
6092
6051
  * const profile = {
6093
- * name: 'name',
6094
- * portraitUri: 'portraitUri',
6095
- * email: 'email',
6096
- * birthday: 'birthday',
6097
- * gender: 1,
6098
- * location: 'location',
6099
- * role: 1,
6100
- * level: 1,
6101
- * extraProfile: {
6102
- * key1: 'value1',
6103
- * key2: 'value2',
6104
- * },
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
+ * },
6105
6064
  * }
6106
6065
  * const res = await RongIMLib.updateMyUserProfile(profile);
6107
6066
  * console.log('更新用户资料结果:', res);
6108
6067
  * ```
6109
6068
  */
6110
- declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<IUpdateMyProfileFail>>;
6069
+ declare function updateMyUserProfile(profile: IUserProfileInfo): Promise<RCResult<IUpdateMyProfileFail>>;
6111
6070
  /** [EN]
6112
6071
  * Batch get user profiles
6113
6072
  * @category User profiles
@@ -6139,7 +6098,6 @@ declare function getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfi
6139
6098
  * Get current user profile
6140
6099
  * @category User profile
6141
6100
  * @description This method is used to retrieve the profile information of the current user.
6142
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IUserProfileInfo}.
6143
6101
  * @since 5.10.1
6144
6102
  * @example Example of getting the current user profile:
6145
6103
  * ```ts
@@ -6151,7 +6109,6 @@ declare function getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfi
6151
6109
  * 获取当前用户资料
6152
6110
  * @category 用户资料
6153
6111
  * @description 此方法用于获取当前用户的资料信息
6154
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link IUserProfileInfo} 类型
6155
6112
  * @since 5.10.1
6156
6113
  * @example 获取当前用户资料示例:
6157
6114
  * ```ts
@@ -6159,13 +6116,12 @@ declare function getUserProfiles(userIds: string[]): Promise<RCResult<IUserProfi
6159
6116
  * console.log('获取当前用户资料结果:', res);
6160
6117
  * ```
6161
6118
  */
6162
- declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
6119
+ declare function getMyUserProfile(): Promise<RCResult<IUserProfileInfo>>;
6163
6120
  /** [EN]
6164
6121
  * User permission settings
6165
6122
  * @category User profile
6166
6123
  * @description This method is used to set user information permissions.
6167
6124
  * @param Visibility User information permissions
6168
- * @returns Returns a Promise of type {@link IAsyncRes}, where data is of type void
6169
6125
  * @since 5.10.1
6170
6126
  * @example Example of user permission settings:
6171
6127
  * ```ts
@@ -6179,7 +6135,6 @@ declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
6179
6135
  * @category 用户资料
6180
6136
  * @description 此方法用于设置用户信息权限
6181
6137
  * @param Visibility 用户信息权限
6182
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 void 类型
6183
6138
  * @since 5.10.1
6184
6139
  * @example 用户权限设置示例:
6185
6140
  * ```ts
@@ -6188,12 +6143,11 @@ declare function getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>;
6188
6143
  * console.log('用户权限设置结果:', res);
6189
6144
  * ```
6190
6145
  */
6191
- declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes<void>>;
6146
+ declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<RCResult>;
6192
6147
  /** [EN]
6193
6148
  * User permission acquisition
6194
6149
  * @category User profile
6195
6150
  * @description This method is used to acquire user information permissions.
6196
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link UserProfileVisibility}.
6197
6151
  * @since 5.10.1
6198
6152
  * @example Example of user permission acquisition:
6199
6153
  * ```ts
@@ -6205,7 +6159,6 @@ declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility
6205
6159
  * 用户权限获取
6206
6160
  * @category 用户资料
6207
6161
  * @description 此方法用于获取用户信息权限
6208
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link UserProfileVisibility} 类型
6209
6162
  * @since 5.10.1
6210
6163
  * @example 用户权限获取示例:
6211
6164
  * ```ts
@@ -6213,13 +6166,12 @@ declare function updateMyUserProfileVisibility(visibility: UserProfileVisibility
6213
6166
  * console.log('用户权限获取结果:', res);
6214
6167
  * ```
6215
6168
  */
6216
- declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>;
6169
+ declare function getMyUserProfileVisibility(): Promise<RCResult<UserProfileVisibility>>;
6217
6170
  /** [EN]
6218
6171
  * Search for user information by unique application ID
6219
6172
  * @category User profile
6220
6173
  * @description This method is used to search for user information by unique application ID.
6221
6174
  * @param uniqueId The user's unique application ID
6222
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IUserProfileInfo}
6223
6175
  * @since 5.10.1
6224
6176
  * @example Example of searching for user information by unique application ID:
6225
6177
  * ```ts
@@ -6233,7 +6185,6 @@ declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisi
6233
6185
  * @category 用户资料
6234
6186
  * @description 此方法用于按用户应用号精确搜索用户信息
6235
6187
  * @param uniqueId 用户应用号
6236
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,其中 data 为 {@link IUserProfileInfo} 类型
6237
6188
  * @since 5.10.1
6238
6189
  * @example 按用户应用号精确搜索用户信息示例:
6239
6190
  * ```ts
@@ -6242,7 +6193,7 @@ declare function getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisi
6242
6193
  * console.log('按用户应用号精确搜索用户信息结果:', res);
6243
6194
  * ```
6244
6195
  */
6245
- declare function searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>;
6196
+ declare function searchUserProfileByUniqueId(uniqueId: string): Promise<RCResult<IUserProfileInfo>>;
6246
6197
  /**
6247
6198
  * 获取订阅用户在线状态
6248
6199
  * @param userIds
@@ -6257,7 +6208,7 @@ declare function getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCRes
6257
6208
  * <strong>Note: <br>
6258
6209
  * Group ID (id) and group name (name) are required fields; otherwise, the API call will fail.
6259
6210
  * @param groupInfo Group information. {$link IGroupInfoOption}
6260
- * @param inviteeUserIds An array of user IDs to be added to the group. A maximum of 100 users can be added at once. (Optional)
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)
6261
6212
  * @category Group
6262
6213
  * @since 5.12.0
6263
6214
  */
@@ -6268,11 +6219,11 @@ declare function getSubscribeUsersOnlineStatus(userIds: string[]): Promise<RCRes
6268
6219
  * <strong>注意:<br>
6269
6220
  * 群 ID(id)、群名称(name)必填,否则接口调用失败。
6270
6221
  * @param groupInfo 群信息。{$link IGroupInfoOption}
6271
- * @param inviteeUserIds 加入群组的用户 ID 数组,一次最多允许 100 个用户加入。(非必填)
6222
+ * @param inviteeUserIds 加入群组的用户 ID 数组,最大有效长度为 30。(非必填)
6272
6223
  * @category 群组
6273
6224
  * @since 5.12.0
6274
6225
  */
6275
- declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<IAsyncRes<ICreateGroupFail>>;
6226
+ declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<RCResult<ICreateGroupFail>>;
6276
6227
  /** [EN]
6277
6228
  * Set group information
6278
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.
@@ -6287,12 +6238,11 @@ declare function createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: strin
6287
6238
  * @category 群组
6288
6239
  * @since 5.12.0
6289
6240
  */
6290
- declare function updateGroupInfo(groupInfo: IGroupInfoOption): Promise<IAsyncRes<IErrorKeys>>;
6241
+ declare function updateGroupInfo(groupInfo: IGroupInfoOption): Promise<RCResult<IErrorKeys>>;
6291
6242
  /** [EN]
6292
6243
  * Batch get group information
6293
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.
6294
6245
  * @param groupIds An array of group IDs. A single query supports up to 20 groups.
6295
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IGroupInfoOption}.
6296
6246
  * @category Group
6297
6247
  * @since 5.12.0
6298
6248
  */
@@ -6300,11 +6250,10 @@ declare function updateGroupInfo(groupInfo: IGroupInfoOption): Promise<IAsyncRes
6300
6250
  * 批量获取群组信息
6301
6251
  * @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能,支持获取已存在的所有群组信息
6302
6252
  * @param groupIds 群 ID 数组,单次查询最多支持 20 个群组。
6303
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupInfoOption} 类型
6304
6253
  * @category 群组
6305
6254
  * @since 5.12.0
6306
6255
  */
6307
- declare function getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
6256
+ declare function getGroupsInfo(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
6308
6257
  /** [EN]
6309
6258
  * Remove group members
6310
6259
  * @description Requires enabling `User Profile Hosting` and `Allow Removing Group Members via SDK` features. Otherwise, this feature is not supported.
@@ -6316,14 +6265,14 @@ declare function getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo
6316
6265
  */
6317
6266
  /**
6318
6267
  * 踢出群组成员
6319
- * @description 需要开启 `信息托管功能` 和 `允许通过 SDK 踢出群成员 ` 功能,否则不支持此功能
6268
+ * @description 需要开启 `信息托管功能` 和 `允许通过 SDK 踢出群成员` 功能,否则不支持此功能
6320
6269
  * @param groupId 群组 Id。
6321
6270
  * @param userIds 群成员 Id 数组。支持批量操作,单次上限为 100 个。
6322
6271
  * @param config 踢出群组配置。参照{@link IQuitGroupConfig}
6323
6272
  * @category 群组
6324
6273
  * @since 5.12.0
6325
6274
  */
6326
- declare function kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<IAsyncRes<void>>;
6275
+ declare function kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<RCResult>;
6327
6276
  /** [EN]
6328
6277
  * Quit group
6329
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.
@@ -6346,7 +6295,7 @@ declare function kickGroupMembers(groupId: string, userIds: string[], config?: I
6346
6295
  * @category 群组
6347
6296
  * @since 5.12.0
6348
6297
  */
6349
- declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<IAsyncRes<void>>;
6298
+ declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<RCResult>;
6350
6299
  /** [EN]
6351
6300
  * Dismiss group
6352
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.
@@ -6361,7 +6310,7 @@ declare function quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<
6361
6310
  * @category 群组
6362
6311
  * @since 5.12.0
6363
6312
  */
6364
- declare function dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
6313
+ declare function dismissGroup(groupId: string): Promise<RCResult>;
6365
6314
  /** [EN]
6366
6315
  * Transfer group ownership
6367
6316
  * @description Requires enabling `User Profile Hosting` and `Allow Group Ownership Transfer via SDK` features. Otherwise, this feature is not supported.
@@ -6384,7 +6333,7 @@ declare function dismissGroup(groupId: string): Promise<IAsyncRes<void>>;
6384
6333
  * @category 群组
6385
6334
  * @since 5.12.0
6386
6335
  */
6387
- declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGroup?: boolean, config?: IQuitGroupConfig): Promise<IAsyncRes<void>>;
6336
+ declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGroup?: boolean, config?: IQuitGroupConfig): Promise<RCResult>;
6388
6337
  /** [EN]
6389
6338
  * Set group administrators
6390
6339
  * @description Requires enabling the `User Profile Hosting` and `Allow SDK to Manage Group Administrators` features; otherwise, this feature is not supported.
@@ -6403,7 +6352,7 @@ declare function transferGroupOwner(groupId: string, newOwnerId: string, quitGro
6403
6352
  * @category 群组
6404
6353
  * @since 5.12.0
6405
6354
  */
6406
- declare function addGroupManagers(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
6355
+ declare function addGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
6407
6356
  /** [EN]
6408
6357
  * Remove group administrators
6409
6358
  * @description Requires enabling the `User Profile Hosting` and `Allow SDK to Manage Group Administrators` features. Otherwise, this feature is not supported.
@@ -6420,14 +6369,14 @@ declare function addGroupManagers(groupId: string, userIds: string[]): Promise<I
6420
6369
  * @category 群组
6421
6370
  * @since 5.12.0
6422
6371
  */
6423
- declare function removeGroupManagers(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
6372
+ declare function removeGroupManagers(groupId: string, userIds: string[]): Promise<RCResult>;
6424
6373
  /** [EN]
6425
6374
  * Paginate to get group member information
6426
6375
  * @description Requires the `User Profile Hosting` feature to be enabled; otherwise, this feature is not supported.
6427
6376
  * @param groupId The group ID.
6428
6377
  * @param role An array of group member roles. Refer to {@link GroupMemberRole}. 0: Fetch all group members regardless of role or position.
6429
6378
  * @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 100 records can be queried per page.
6430
- * @returns Returns a Promise of type {@link IAsyncRes}. The data contains the total number of group members and group member information, where the group member information is of type {@link IGroupMemberInfo}.
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}.
6431
6380
  * @category Group
6432
6381
  * @since 5.12.0
6433
6382
  */
@@ -6437,18 +6386,18 @@ declare function removeGroupManagers(groupId: string, userIds: string[]): Promis
6437
6386
  * @param groupId 群组 Id。
6438
6387
  * @param role 群成员角色数组。参照{@link GroupMemberRole} 0:不区分角色或位置角色获取所有群成员
6439
6388
  * @param option 分页拉取参数。参照{@link IPagingQueryOption}, 一页最多查询 100 条数据
6440
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为包含群成员总数和群成员信息,群成员信息为 {@link IGroupMemberInfo} 类型
6389
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 为包含群成员总数和群成员信息,群成员信息为 {@link IGroupMemberInfo} 类型
6441
6390
  * @category 群组
6442
6391
  * @since 5.12.0
6443
6392
  */
6444
- declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
6393
+ declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IGetGroupMembersOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
6445
6394
  /** [EN]
6446
6395
  * Get information of specified group members
6447
6396
  * @description Requires `User Profile Hosting` to be enabled; otherwise, this feature is not supported
6448
6397
  * - Note: The current user must be in the group; otherwise, group member information cannot be retrieved
6449
6398
  * @param groupId Group ID
6450
6399
  * @param userIds Array of user IDs, with a maximum of 100 users
6451
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IGroupMemberInfo}
6400
+ * @returns Returns a Promise of type {@link RCResult}, where the data is of type {@link IGroupMemberInfo}
6452
6401
  * @category Group
6453
6402
  * @since 5.12.0
6454
6403
  */
@@ -6458,11 +6407,11 @@ declare function getGroupMembersByRole(groupId: string, role: GroupMemberRole, o
6458
6407
  * - 注意:当前用户未在群组中不支持获取群成员信息
6459
6408
  * @param groupId 群组 ID
6460
6409
  * @param userIds 用户 ID 数组,最多不超过 100 个
6461
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupMemberInfo} 类型
6410
+ * @returns 返回一个 {@link RCResult} 类型 Promise,data 为 {@link IGroupMemberInfo} 类型
6462
6411
  * @category 群组
6463
6412
  * @since 5.12.0
6464
6413
  */
6465
- declare function getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>;
6414
+ declare function getGroupMembers(groupId: string, userIds: string[]): Promise<RCResult<IGroupMemberInfo[]>>;
6466
6415
  /** [EN]
6467
6416
  * Set group member profile
6468
6417
  * @description This feature requires the `User Profile Hosting` feature to be enabled; otherwise, it is not supported.
@@ -6483,7 +6432,7 @@ declare function getGroupMembers(groupId: string, userIds: string[]): Promise<IA
6483
6432
  * @category 群组
6484
6433
  * @since 5.12.0
6485
6434
  */
6486
- declare function setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>;
6435
+ declare function setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<RCResult<IErrorKeys>>;
6487
6436
  /** [EN]
6488
6437
  * Search group member information by nickname
6489
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.
@@ -6491,7 +6440,6 @@ declare function setGroupMemberInfo(groupId: string, userId: string, nickname: s
6491
6440
  * @param groupId The group ID.
6492
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.
6493
6442
  * @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
6494
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is of type {@link IGroupMemberInfo}.
6495
6443
  * @category Group
6496
6444
  * @since 5.12.0
6497
6445
  */
@@ -6502,11 +6450,10 @@ declare function setGroupMemberInfo(groupId: string, userId: string, nickname: s
6502
6450
  * @param groupId 群组 Id。
6503
6451
  * @param name 群成员昵称搜索关键字。注意:不能为空最长不超过 64 个字符;支持模糊搜索查询;昵称为空时,默认搜索用户名。搜索字段不可以传递纯空格。
6504
6452
  * @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
6505
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupMemberInfo} 类型
6506
6453
  * @category 群组
6507
6454
  * @since 5.12.0
6508
6455
  */
6509
- declare function searchGroupMembers(groupId: string, name: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>;
6456
+ declare function searchGroupMembers(groupId: string, name: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupMemberInfo>>>;
6510
6457
  /** [EN]
6511
6458
  * Join group
6512
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.
@@ -6537,7 +6484,7 @@ declare function searchGroupMembers(groupId: string, name: string, option: IPagi
6537
6484
  * @category 群组
6538
6485
  * @since 5.12.0
6539
6486
  */
6540
- declare function joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
6487
+ declare function joinGroup(groupId: string): Promise<RCResult<IProcessCode>>;
6541
6488
  /** [EN]
6542
6489
  * Invite users to join a group
6543
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.
@@ -6554,7 +6501,7 @@ declare function joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>;
6554
6501
  * @category 群组
6555
6502
  * @since 5.12.0
6556
6503
  */
6557
- declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>;
6504
+ declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise<RCResult<IProcessCode>>;
6558
6505
  /** [EN]
6559
6506
  * User agrees to join a group
6560
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.
@@ -6571,7 +6518,7 @@ declare function inviteUsersToGroup(groupId: string, userIds: string[]): Promise
6571
6518
  * @category 群组
6572
6519
  * @since 5.12.0
6573
6520
  */
6574
- declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<IAsyncRes<void>>;
6521
+ declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<RCResult>;
6575
6522
  /** [EN]
6576
6523
  * User rejects group invitation
6577
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.
@@ -6590,7 +6537,7 @@ declare function acceptGroupInvite(groupId: string, inviterId: string): Promise<
6590
6537
  * @category 群组
6591
6538
  * @since 5.12.0
6592
6539
  */
6593
- declare function refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<IAsyncRes<void>>;
6540
+ declare function refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<RCResult>;
6594
6541
  /** [EN]
6595
6542
  * Group owner or administrator approves user to join the group
6596
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.
@@ -6609,7 +6556,7 @@ declare function refuseGroupInvite(groupId: string, inviterId: string, reason?:
6609
6556
  * @category 群组
6610
6557
  * @since 5.12.0
6611
6558
  */
6612
- declare function acceptGroupApplication(groupId: string, applicantId: string, inviterId?: string): Promise<IAsyncRes<IProcessCode>>;
6559
+ declare function acceptGroupApplication(groupId: string, applicantId: string, inviterId?: string): Promise<RCResult<IProcessCode>>;
6613
6560
  /** [EN]
6614
6561
  * Group owner or administrator rejects user's request to join the group
6615
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.
@@ -6630,7 +6577,7 @@ declare function acceptGroupApplication(groupId: string, applicantId: string, in
6630
6577
  * @category 群组
6631
6578
  * @since 5.12.0
6632
6579
  */
6633
- declare function refuseGroupApplication(groupId: string, applicantId: string, inviterId?: string, reason?: string): Promise<IAsyncRes<void>>;
6580
+ declare function refuseGroupApplication(groupId: string, applicantId: string, inviterId?: string, reason?: string): Promise<RCResult>;
6634
6581
  /** [EN]
6635
6582
  * Get group requests
6636
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>
@@ -6638,7 +6585,6 @@ declare function refuseGroupApplication(groupId: string, applicantId: string, in
6638
6585
  * @param option Pagination parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
6639
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.
6640
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.
6641
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data contains an array of type {@link IGroupApplicationInfo}.
6642
6588
  * @category Group
6643
6589
  * @since 5.12.0
6644
6590
  */
@@ -6649,17 +6595,15 @@ declare function refuseGroupApplication(groupId: string, applicantId: string, in
6649
6595
  * @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
6650
6596
  * @param status 群组请求状态数组,参数仅 Electron 支持,且 Electron 为必填项,Web 传递无效
6651
6597
  * @param directions 群组请求方向数组,参照{@link GroupApplicationDirection},参数仅 Electron 支持,且 Electron 为必填项,Web 传递无效
6652
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 中包含 {@link IGroupApplicationInfo} 类型数组
6653
6598
  * @category 群组
6654
6599
  * @since 5.12.0
6655
6600
  */
6656
- declare function getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>;
6601
+ declare function getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IGroupApplicationInfo>>>;
6657
6602
  /** [EN]
6658
6603
  * Get the groups a user belongs to
6659
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.
6660
6605
  * @param roles An array of group roles.
6661
6606
  * @param option Pagination query parameters {@link IPagingQueryOption}, with a maximum of 100 records per page.
6662
- * @returns Returns a Promise of type {@link IAsyncRes}, where the data is an array of type {@link IGroupInfoOption}.
6663
6607
  * @category Group
6664
6608
  * @since 5.12.0
6665
6609
  */
@@ -6668,17 +6612,15 @@ declare function getGroupApplications(option: IPagingQueryOption, directions?: G
6668
6612
  * @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能
6669
6613
  * @param roles 群组身份数组。
6670
6614
  * @param option 分页拉取参数 {@link IPagingQueryOption},一页最多查询 100 条数据
6671
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link IGroupInfoOption} 类型数组
6672
6615
  * @category 群组
6673
6616
  * @since 5.12.0
6674
6617
  */
6675
- declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMemberRole): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
6618
+ declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMemberRole): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
6676
6619
  /** [EN]
6677
6620
  * Search for groups I have joined by group name
6678
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.
6679
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.
6680
6623
  * @param option Pagination query parameters. Refer to {@link IPagingQueryOption}. A maximum of 200 records can be queried per page.
6681
- * @returns Returns a Promise of type {@link IAsyncRes}, with data of type {@link void}.
6682
6624
  * @category Group
6683
6625
  * @since 5.12.0
6684
6626
  */
@@ -6687,11 +6629,10 @@ declare function getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMe
6687
6629
  * @description 客户端创建群组需要开通 `信息托管功能`,未开通时不支持此功能,Web 平台暂不支持
6688
6630
  * @param groupName 群名称搜索关键字。不能为空最长不超过 64 个字符,支持模糊搜索查询时需要去掉前后空格。
6689
6631
  * @param option 分页拉取参数。参照{@link IPagingQueryOption},一页最多查询 200 条数据
6690
- * @returns 返回一个 {@link IAsyncRes} 类型 Promise,data 为 {@link void} 类型
6691
6632
  * @category 群组
6692
6633
  * @since 5.12.0
6693
6634
  */
6694
- declare function searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>;
6635
+ declare function searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IGroupInfo>>>;
6695
6636
  /** [EN]
6696
6637
  * Batch get group information
6697
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.
@@ -6706,7 +6647,7 @@ declare function searchJoinedGroups(groupName: string, option: IPagingQueryOptio
6706
6647
  * @category 群组
6707
6648
  * @since 5.12.0
6708
6649
  */
6709
- declare function getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>;
6650
+ declare function getJoinedGroups(groupIds: string[]): Promise<RCResult<IGroupInfo[]>>;
6710
6651
  /** [EN]
6711
6652
  * Set group name
6712
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.
@@ -6723,7 +6664,7 @@ declare function getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupIn
6723
6664
  * @category 群组
6724
6665
  * @since 5.12.0
6725
6666
  */
6726
- declare function setGroupRemark(groupId: string, remark: string): Promise<IAsyncRes<void>>;
6667
+ declare function setGroupRemark(groupId: string, remark: string): Promise<RCResult>;
6727
6668
  /** [EN]
6728
6669
  * Set group member follow
6729
6670
  * @param groupId The group ID
@@ -6738,7 +6679,7 @@ declare function setGroupRemark(groupId: string, remark: string): Promise<IAsync
6738
6679
  * @category 群组
6739
6680
  * @since 5.12.0
6740
6681
  */
6741
- declare function addGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
6682
+ declare function addGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
6742
6683
  /** [EN]
6743
6684
  * Remove group member follow
6744
6685
  * @param groupId Group ID
@@ -6753,7 +6694,7 @@ declare function addGroupFollows(groupId: string, userIds: string[]): Promise<IA
6753
6694
  * @category 群组
6754
6695
  * @since 5.12.0
6755
6696
  */
6756
- declare function removeGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>;
6697
+ declare function removeGroupFollows(groupId: string, userIds: string[]): Promise<RCResult>;
6757
6698
  /** [EN]
6758
6699
  * Get group members I follow
6759
6700
  * @param groupId The group ID, only supports regular groups.
@@ -6766,7 +6707,7 @@ declare function removeGroupFollows(groupId: string, userIds: string[]): Promise
6766
6707
  * @category 群组
6767
6708
  * @since 5.12.0
6768
6709
  */
6769
- declare function getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>;
6710
+ declare function getGroupFollows(groupId: string): Promise<RCResult<IFollowsInfo[]>>;
6770
6711
 
6771
6712
  /** [EN]
6772
6713
  * Add friend
@@ -6784,7 +6725,7 @@ declare function getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInf
6784
6725
  * @category 好友
6785
6726
  * @since 5.12.0
6786
6727
  */
6787
- declare function addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<IAsyncRes<IProcessCode>>;
6728
+ declare function addFriend(userId: string, directionType: DirectionType, extra?: string): Promise<RCResult<IProcessCode>>;
6788
6729
  /** [EN]
6789
6730
  * Remove friend
6790
6731
  * @param userIds List of user IDs to remove from the friend relationship. A maximum of 100 users can be removed at once.
@@ -6801,7 +6742,7 @@ declare function addFriend(userId: string, directionType: DirectionType, extra?:
6801
6742
  * @category 好友
6802
6743
  * @since 5.12.0
6803
6744
  */
6804
- declare function deleteFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<void>>;
6745
+ declare function deleteFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<void>>;
6805
6746
  /** [EN]
6806
6747
  * Agree to add as a friend
6807
6748
  * @param userId The user ID of the user who agrees to become a friend
@@ -6814,20 +6755,20 @@ declare function deleteFriends(userIds: string[], directionType: DirectionType):
6814
6755
  * @category 好友
6815
6756
  * @since 5.12.0
6816
6757
  */
6817
- declare function acceptFriendApplication(userId: string): Promise<IAsyncRes<void>>;
6758
+ declare function acceptFriendApplication(userId: string): Promise<RCResult>;
6818
6759
  /** [EN]
6819
6760
  * Reject friend request
6820
- * @param userId The user ID of the user to reject as a friend
6761
+ * @param userId The user ID of the user to reject as a friend.
6821
6762
  * @category Friend
6822
6763
  * @since 5.12.0
6823
6764
  */
6824
6765
  /**
6825
6766
  * 拒绝加为好友
6826
- * @param userId 拒绝成为好友的用户 ID
6767
+ * @param userId 用户 ID
6827
6768
  * @category 好友
6828
6769
  * @since 5.12.0
6829
6770
  */
6830
- declare function refuseFriendApplication(userId: string): Promise<IAsyncRes<void>>;
6771
+ declare function refuseFriendApplication(userId: string): Promise<RCResult>;
6831
6772
  /** [EN]
6832
6773
  * Set friend information
6833
6774
  * @param userId The user ID of the friend
@@ -6844,9 +6785,7 @@ declare function refuseFriendApplication(userId: string): Promise<IAsyncRes<void
6844
6785
  * @category 好友
6845
6786
  * @since 5.12.0
6846
6787
  */
6847
- declare function setFriendInfo(userId: string, remark?: string, extProfile?: {
6848
- [key: string]: string;
6849
- }): Promise<IAsyncRes<IErrorKeys>>;
6788
+ declare function setFriendInfo(userId: string, remark?: string, extProfile?: Record<string, string>): Promise<RCResult<IErrorKeys>>;
6850
6789
  /** [EN]
6851
6790
  * Check friend relationship
6852
6791
  *
@@ -6893,30 +6832,27 @@ declare function setFriendInfo(userId: string, remark?: string, extProfile?: {
6893
6832
  * @category 好友
6894
6833
  * @since 5.12.0
6895
6834
  */
6896
- declare function checkFriends(userIds: string[], directionType: DirectionType): Promise<IAsyncRes<IFriendRelationInfo[]>>;
6835
+ declare function checkFriends(userIds: string[], directionType: DirectionType): Promise<RCResult<IFriendRelationInfo[]>>;
6897
6836
  /** [EN]
6898
6837
  * Get friend list
6899
- * @description The `count` and `pageToken` parameters are only valid for the web platform. If `count` and `pageToken` are not provided on the web, the first page will be queried by default.
6900
- * *
6901
- * @param directionTypes Specifies the friend direction types: one-way friend, two-way friend. Refer to {@link QueryFriendsDirectionType}.
6902
- * @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.
6903
6841
  * @category Friends
6904
6842
  * @since 5.12.0
6905
6843
  */
6906
6844
  /**
6907
6845
  * 获取好友列表
6908
- * @description count pageToken 仅 web 有效,web 不传递 count 和 pageToken 默认查询第一页
6909
- *
6910
- * @param directionTypes 好友方向类型:单向好友、双向好友。参照 {@link QueryFriendsDirectionType}
6911
- * @param option 分页拉取参数,参照 {@link IPagingQueryOption}, 仅 web 有效,Count 默认 50,一页最多查询 100 条数据,
6846
+ * @param directionType 好友方向类型:单向好友、双向好友。参照 {@link QueryFriendsDirectionType}
6847
+ * @param option 分页拉取参数,参考 {@link IPagingQueryOption};该参数对 Electron 平台无效,Electron 平台默认一次性获取全量好友数据。
6912
6848
  * @category 好友
6913
6849
  * @since 5.12.0
6914
6850
  */
6915
- declare function getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>;
6851
+ declare function getFriends(directionType: QueryFriendsDirectionType, option?: IPagingQueryOption): Promise<RCResult<IPagingQueryResult<IFriendInfo>>>;
6916
6852
  /** [EN]
6917
6853
  * Fetch friend request list with pagination
6918
- * @param types Request types. Multiple types can be selected. Refer to {@link FriendApplicationType}
6919
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}
6920
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}
6921
6857
  * @category Friend
6922
6858
  * @since 5.12.0
@@ -6924,13 +6860,13 @@ declare function getFriends(directionType: QueryFriendsDirectionType, option?: I
6924
6860
  /**
6925
6861
  * 分页获取好友请求列表
6926
6862
  *
6927
- * @param types 请求类型。可选择多个。参照 {@link FriendApplicationType}
6928
6863
  * @param option 分页拉取参数,参照 {@link IPagingQueryOption}, 一页最多查询 100 条数据,
6929
- * @param status 请求状态。可选择多个,支持申请添加好友、已同意、已拒绝、已过期。此字段仅在 Electron 平台支持,参照 {@link FriendApplicationStatus}
6864
+ * @param types 请求类型列表,参照 {@link FriendApplicationType};该参数仅 Electron 平台有效。
6865
+ * @param status 请求状态列表,参照 {@link FriendApplicationStatus};该参数仅 Electron 平台有效。
6930
6866
  * @category 好友
6931
6867
  * @since 5.12.0
6932
6868
  */
6933
- declare function getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>;
6869
+ declare function getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<RCResult<IPagingQueryResult<IFriendApplicationInfo>>>;
6934
6870
  /** [EN]
6935
6871
  * Get friend information based on user IDs
6936
6872
  * @param userIds List of user IDs, with a maximum of 100 friends' information retrievable at once
@@ -6944,22 +6880,20 @@ declare function getFriendApplications(option?: IPagingQueryOption, types?: Frie
6944
6880
  * @category 好友
6945
6881
  * @since 5.12.0
6946
6882
  */
6947
- declare function getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>;
6883
+ declare function getFriendsInfo(userIds: string[]): Promise<RCResult<IFriendInfo[]>>;
6948
6884
  /** [EN]
6949
- * Search for friend information based on nickname
6950
- * 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.
6951
6886
  * @param name The keyword for the user's nickname. It cannot be empty and must not exceed 64 characters.
6952
6887
  * @category Friend
6953
6888
  * @since 5.12.0
6954
6889
  */
6955
6890
  /**
6956
- * 根据好友昵称搜索好友信息
6957
- * 此接口仅 Electron 平台支持
6891
+ * 根据好友昵称搜索好友信息,此接口仅 Electron 平台支持
6958
6892
  * @param name 用户昵称关键字,不能为空最长不超过 64 个字符。
6959
6893
  * @category 好友
6960
6894
  * @since 5.12.0
6961
6895
  */
6962
- declare function searchFriendsInfo(name: string): Promise<IAsyncRes<IFriendInfo[]>>;
6896
+ declare function searchFriendsInfo(name: string): Promise<RCResult<IFriendInfo[]>>;
6963
6897
  /** [EN]
6964
6898
  * Set the current user's friend request permission
6965
6899
  * @param permission Friend request permission. Refer to {@link IAddFriendPermission}
@@ -6973,7 +6907,7 @@ declare function searchFriendsInfo(name: string): Promise<IAsyncRes<IFriendInfo[
6973
6907
  * @category 好友
6974
6908
  * @since 5.12.0
6975
6909
  */
6976
- declare function setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>;
6910
+ declare function setFriendAddPermission(permission: FriendAddPermission): Promise<RCResult>;
6977
6911
  /** [EN]
6978
6912
  * Get the current user's friend request permissions
6979
6913
  * @category Friend
@@ -6984,7 +6918,7 @@ declare function setFriendAddPermission(permission: FriendAddPermission): Promis
6984
6918
  * @category 好友
6985
6919
  * @since 5.12.0
6986
6920
  */
6987
- declare function getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>;
6921
+ declare function getFriendAddPermission(): Promise<RCResult<FriendAddPermission>>;
6988
6922
 
6989
6923
  /** [EN]
6990
6924
  * Initialization