@tencentcloud/chat-uikit-engine 2.4.4 → 3.0.0-beta.0

package/index.d.ts

@@ -1,4 +1,4 @@
-import TencentCloudChat, { Conversation, Message, ChatSDK } from '@tencentcloud/chat';
+import TencentCloudChat, { Conversation, Message, Profile, Group, ChatSDK } from '@tencentcloud/lite-chat';
 
 interface IConversationModel {
     conversationID: string;
@@ -238,15 +238,89 @@ interface ConvertVoiceToTextParams {
     message: IMessageModel;
     language?: string;
 }
-interface SearchCloudMessagesParams {
+declare enum ISearchType {
+    MESSAGE = "message",
+    CHAT_MESSAGE = "chat_message",
+    USER = "user",
+    GROUP = "group"
+}
+declare enum MessageType {
+    MSG_TEXT = "TIMTextElem",
+    MSG_IMAGE = "TIMImageElem",
+    MSG_SOUND = "TIMSoundElem",
+    MSG_FILE = "TIMFileElem",
+    MSG_VIDEO = "TIMVideoFileElem",
+    MSG_LOCATION = "TIMLocationElem",
+    MSG_CUSTOM = "TIMCustomElem",
+    MSG_MERGER = "TIMRelayElem"
+}
+declare enum GroupType {
+    GRP_WORK = "Private",
+    GRP_PUBLIC = "Public",
+    GRP_MEETING = "ChatRoom",
+    GRP_COMMUNITY = "Community"
+}
+interface ISearchCloudMessagesResultBase<T extends ISearchType> {
+    totalCount: number;
+    params: ISearchParamsMap[T];
+}
+interface ISearchCloudMessagesResultItem extends ISearchCloudMessagesResultBase<ISearchType.MESSAGE> {
+    messageList: IMessageModel[];
+    messageCount: number;
+    conversation: IConversationModel;
+}
+interface ISearchCloudUsersResultItem extends ISearchCloudMessagesResultBase<ISearchType.USER> {
+    profile: Profile;
+    relation: TencentCloudChat.TYPES.SNS_TYPE_NO_RELATION | TencentCloudChat.TYPES.SNS_TYPE_A_WITH_B | TencentCloudChat.TYPES.SNS_TYPE_B_WITH_A | TencentCloudChat.TYPES.SNS_TYPE_BOTH_WAY;
+}
+interface ISearchCloudGroupsResultItem extends ISearchCloudMessagesResultBase<ISearchType.USER> {
+    groupInfo: Group;
+    conversation: IConversationModel;
+}
+interface IResultMap {
+    [ISearchType.MESSAGE]: ISearchCloudMessagesResultItem[];
+    [ISearchType.CHAT_MESSAGE]: ISearchCloudMessagesResultItem[];
+    [ISearchType.USER]: ISearchCloudUsersResultItem[];
+    [ISearchType.GROUP]: ISearchCloudGroupsResultItem[];
+}
+interface ISearchResult<T extends ISearchType> {
+    resultList: IResultMap[T] | [];
+    hasMore: boolean;
+    cursor: string;
+    params?: ISearchParamsMap[T];
+    totalCount: number;
+}
+interface ISearchParamsMap {
+    [ISearchType.MESSAGE]: SearchCloudMessagesParams;
+    [ISearchType.CHAT_MESSAGE]: SearchCloudMessagesParams;
+    [ISearchType.USER]: SearchCloudUsersParams;
+    [ISearchType.GROUP]: SearchCloudGroupsParams;
+}
+interface BaseSearchCloudParams {
+    keyword?: string;
     keywordList?: string[];
     keywordListMatchType?: 'or' | 'and';
+    cursor?: string;
+    count?: number;
+}
+interface SearchCloudMessagesParams extends BaseSearchCloudParams {
     senderUserIDList?: string[];
-    messageTypeList?: string[];
+    messageTypeList?: any[];
     conversationID?: string;
     timePosition?: number;
     timePeriod?: number;
-    cursor?: string;
+}
+interface SearchCloudUsersParams extends BaseSearchCloudParams {
+    gender?: string;
+    miniBirthday?: number;
+    maxBirthday?: number;
+}
+interface SearchCloudGroupsParams extends BaseSearchCloudParams {
+    groupTypeList?: any[];
+}
+interface SearchCloudGroupMembersParams extends BaseSearchCloudParams {
+    groupTypeList?: string[];
+    groupIDList?: string[];
 }
 interface ForwardMessageParams {
     to: string;
@@ -477,7 +551,8 @@ declare enum MountedList {
     TUIGroup = "TUIGroup",
     TUIUser = "TUIUser",
     TUIFriend = "TUIFriend",
-    TUIReport = "TUIReport"
+    TUIReport = "TUIReport",
+    TUISearch = "TUISearch"
 }
 
 declare enum StoreName {
@@ -521,6 +596,7 @@ declare class ChatEngine implements ITUIChatEngine {
     TUIUser: ITUIUserService;
     TUIFriend: ITUIFriendService;
     TUIReport: ITUIReportService;
+    TUISearch: ITUISearchService;
     private loginStatusPromise;
     private userID;
     constructor();
@@ -669,6 +745,12 @@ interface ITUIReportService {
     reportFeature(code: number, feature?: string): void;
 }
 
+interface ITUISearchService {
+    searchCloudMessages(options: SearchCloudMessagesParams): Promise<any>;
+    searchCloudUsers(options: SearchCloudUsersParams): Promise<any>;
+    searchCloudGroups(options: SearchCloudGroupsParams): Promise<any>;
+}
+
 interface ITUIChatEngine {
     isInited: boolean;
     chat: ChatSDK;
@@ -708,5 +790,6 @@ declare const tuiChat: ITUIChatService;
 declare const tuiGroup: ITUIGroupService;
 declare const tuiFriend: ITUIFriendService;
 declare const tuiReport: ITUIReportService;
+declare const tuiSearch: ITUISearchService;
 
-export { AcceptFriendApplicationParams, AddFriendParams, AddMemberParams, ChangGroupOwnerParams, CheckFriendParams, ConvertVoiceToTextParams, CountersParams, CreateGroupParams, DeleteFriendApplicationParams, DeleteFriendParams, DeleteMemberParams, ForwardMessageParams, Friend, FriendApplication, GetAllUserListOfMessageReactionParams, GetFriendProfileParams, GetGroupMessageReadParams, GetGroupProfileParams, GetMemberListParams, GetMemberProfileParams, GetMessageListHoppingParams, GetMessageListParams, GetMessageReactionsParams, GroupAttrParams, GroupServiceBasicParams, IConversationModel, IGroupModel, IMessageModel, JoinGroupParams, KeyListParams, LoginParams, MarkMemberParams, MessageControlInfo, ModifyMessageParams, MuteConversationParams, OfflinePushInfo, PinConversationParams, ReactionInfo, SEARCH_TYPE, SearchCloudMessagesParams, SendForwardMessageMergeInfo, SendForwardMessageOptions, SendMessageOptions, SendMessageParams, SetConversationDraftParams, SetCountersParams, SetMemberCustomFiledParams, SetMemberMuteParams, SetMemberNameCardParams, SetMemberRoleParams, StoreName, SwitchUserStatusParams, TUIChatEngine, tuiChat as TUIChatService, tuiConversation as TUIConversationService, tuiFriend as TUIFriendService, tuiGlobal as TUIGlobal, tuiGroup as TUIGroupService, tuiReport as TUIReportService, tuiStore as TUIStore, tuiTranslate as TUITranslateService, tuiUser as TUIUserService, TranslateTextParams, UpdateFriendParams, UpdateGroupParams, UpdateMyProfileParams, UserIDListParams, TUIChatEngine as default, func, handleGroupApplicationParams };
+export { AcceptFriendApplicationParams, AddFriendParams, AddMemberParams, ChangGroupOwnerParams, CheckFriendParams, ConvertVoiceToTextParams, CountersParams, CreateGroupParams, DeleteFriendApplicationParams, DeleteFriendParams, DeleteMemberParams, ForwardMessageParams, Friend, FriendApplication, GetAllUserListOfMessageReactionParams, GetFriendProfileParams, GetGroupMessageReadParams, GetGroupProfileParams, GetMemberListParams, GetMemberProfileParams, GetMessageListHoppingParams, GetMessageListParams, GetMessageReactionsParams, GroupAttrParams, GroupServiceBasicParams, GroupType, IConversationModel, IGroupModel, IMessageModel, IResultMap, ISearchCloudGroupsResultItem, ISearchCloudMessagesResultItem, ISearchCloudUsersResultItem, ISearchParamsMap, ISearchResult, ISearchType, JoinGroupParams, KeyListParams, LoginParams, MarkMemberParams, MessageControlInfo, MessageType, ModifyMessageParams, MuteConversationParams, OfflinePushInfo, PinConversationParams, ReactionInfo, SEARCH_TYPE, SearchCloudGroupMembersParams, SearchCloudGroupsParams, SearchCloudMessagesParams, SearchCloudUsersParams, SendForwardMessageMergeInfo, SendForwardMessageOptions, SendMessageOptions, SendMessageParams, SetConversationDraftParams, SetCountersParams, SetMemberCustomFiledParams, SetMemberMuteParams, SetMemberNameCardParams, SetMemberRoleParams, StoreName, SwitchUserStatusParams, TUIChatEngine, tuiChat as TUIChatService, tuiConversation as TUIConversationService, tuiFriend as TUIFriendService, tuiGlobal as TUIGlobal, tuiGroup as TUIGroupService, tuiReport as TUIReportService, tuiSearch as TUISearchService, tuiStore as TUIStore, tuiTranslate as TUITranslateService, tuiUser as TUIUserService, TranslateTextParams, UpdateFriendParams, UpdateGroupParams, UpdateMyProfileParams, UserIDListParams, TUIChatEngine as default, func, handleGroupApplicationParams };