jiuyiUniapp/jiuyi2/node_modules/@tencentcloud/tui-core/index.d.ts

456 lines
13 KiB
TypeScript
Raw Normal View History

2024-12-18 15:46:27 +08:00
import { ChatSDK } from '@tencentcloud/chat';
/**
* TUILogin login ()
* @interface LoginParams
* @property {number} SDKAppID SDKAppID
* @property {string} userID ID
* @property {string} userSig IM UserID <br/>{@link https://cloud.tencent.com/document/product/269/32688 生成 UserSig}
* @property {any} [TIMPush] uniapp undefined
* @property {any} [pushConfig] uniapp undefined
* @property {any} [TUIOfflinePush] uniapp 线 undefined(使 TIMPush)
* @property {any} [offlinePushConfig] uniapp 线 undefined(使 TIMPush pushConfig )
* @property {boolean} [useUploadPlugin] 使 false
* @property {string} [fileUploadProxy]
* @property {string} [fileDownloadProxy]
* @property {string} [proxyServer] IM
* @property {string} [framework] 使 vue2 vue3 badcase
*/
interface LoginParams {
SDKAppID: number;
userID: string;
userSig: string;
TIMPush?: any;
pushConfig?: any;
TUIOfflinePush?: any;
offlinePushConfig?: any;
useUploadPlugin?: boolean;
useProfanityFilterPlugin?: boolean;
unlimitedAVChatRoom?: boolean;
scene?: string;
fileUploadProxy?: string;
fileDownloadProxy?: string;
proxyServer?: string;
devMode?: boolean;
framework?: string;
}
type func = (...args: any[]) => any;
/**
*
* @interface CallServiceParams
* @property {string} serviceName
* @property {string} method
* @property {any} params
* @property {func} [callback]
*/
interface CallServiceParams {
serviceName: string;
method: string;
params: Record<string, any>;
callback?: func;
}
/**
*
* @interface ExtensionInfo
* @property {number} weight weight
* @property {string} text
* @property {string} icon url
* @property {object} data
* @property {object} listener
* @property {func} [listener.onClicked]
* @property {func} [listener.onLongPressed]
* @property {func} [listener.onTouched]
* @property {func} [listener.onSwiped]
*/
interface ExtensionInfo {
weight: number;
text: string;
icon: string;
data: Record<string, any>;
listener: {
onClicked?: func;
onLongPressed?: func;
onTouched?: func;
onSwiped?: func;
};
}
interface ITUIService {
onCall(method: string, params: object, callback?: func): void;
}
/**
* @interface TUICore
*/
interface ITUICore {
/**
*
* @function
* @param {string} serviceName
* @param {ITUIService} service
* @example
* TUICore.registerService(TUIConstants.TUICall.SERVICE.NAME, this);
*/
registerService(serviceName: string, service: any): void;
/**
*
* @function
* @param {string} serviceName
* @example
* TUICore.unregisterService(TUIConstants.TUICall.SERVICE.NAME);
*/
unregisterService(serviceName: string): void;
/**
*
* @function
* @param {string} serviceName
* @example
* TUICore.getService(TUIConstants.TUICall.SERVICE.NAME);
*/
getService(serviceName: string): ITUIService;
/**
*
* @function
* @param {CallServiceParams} options
* @example
* TUICore.callService({
* serviceName: TUIConstants.TUICall.SERVICE.NAME,
* method: TUIConstants.TUICall.SERVICE.METHOD.CALL,
* params: {
* callType: 1,
* mediaType: 2
* },
* callback: (result) => {
* // todo
* },
* });
*/
callService(options: CallServiceParams): void;
/**
*
* @function
* @param {string} extensionID ID
* @param {ITUIExtension} extension
* @example
* TUICore.registerExtension(TUIConstants.TUIChat.EXTENSION.INPUT_TOOLBAR, this);
*/
registerExtension(extensionID: string, extension: any): void;
/**
*
* @function
* @param {string} extensionID ID
* @param {ITUIExtension} extension
* @example
* TUICore.unregisterExtension(TUIConstants.TUIChat.EXTENSION.INPUT_TOOLBAR, this);
*/
unregisterExtension(extensionID: string, extension: any): void;
/**
*
* @function
* @param {string} extensionID ID
* @param {object} [params]
* @example
* TUICore.getExtension(TUIConstants.TUIChat.EXTENSION.INPUT_TOOLBAR, { filterVoice: true });
*/
getExtensionList(extensionID: string, params?: object): Array<ExtensionInfo>;
/**
* 广
* @function
* @param {string} eventName
* @param {string} subKey
* @param {ITUINotification} notification
* @example
* TUICore.registerEvent(TUIConstants.TUILogin.EVENT.LOGIN_STATE_CHANGED, this);
*/
registerEvent(eventName: string, subKey: string, notification: any): void;
/**
* 广
* @function
* @param {string} eventName
* @param {string} subKey
* @param {ITUINotification} notification
* @example
* TUICore.unregisterEvent(TUIConstants.TUILogin.EVENT.LOGIN_STATE_CHANGED, this);
*/
unregisterEvent(eventName: string, subKey: string, notification: any): void;
/**
* 广
* @function
* @param {string} eventName
* @param {string} subKey
* @param {object} [params]
* @example
* TUICore.notifyEvent(TUIConstants.TUILogin.EVENT.LOGIN_STATE_CHANGED, TUIConstants.TUILogin.EVENT_SUB_KEY.USER_LOGIN_SUCCESS);
*/
notifyEvent(eventName: string, subKey: string, params?: object): void;
}
interface GetContextResult {
chat: ChatSDK;
SDKAppID: number;
userID: string;
userSig: string;
}
/**
* @interface TUILogin
*/
interface ITUILogin {
/**
* Chat SDK
* @function
* @param {LoginParams} options
* @example
* TUILogin.login({
* SDKAppID: xxx,
* userID: 'xxx',
* userSig: 'xxx',
* useUploadPlugin: true, // 使用文件上传插件
* });
*/
login(options: LoginParams): Promise<any>;
/**
* Chat SDK
* @function
* @example
* let promise = TUILogin.logout();
* promise.then(() => {
* // 登出成功后进行相关业务逻辑处理
* })
*/
logout(): Promise<any>;
/**
* Chat SDK SDK logout WebSocket
* @function
* @example
* let promise = TUILogin.destroy();
*/
destroy(): Promise<any>;
/**
* Chat SDK
* @function
* @param {number} level
* - 0 使
* - 1 release级别SDK 使
* - 2 SDK
* - 3 SDK
* - 4 SDK
* @example
* TUILogin.setLogLevel(0)
*/
setLogLevel(level: number): void;
/**
* TUILogin
* @function
* @example
* const { chat, SDKAppID, userID, userSig } = TUILogin.getContext();
* // chat - Chat SDK 实例
* // SDKAppID - 即时通信应用 AppID
* // userID - 用户 ID
* // userSig - 用户登录前面
*/
getContext(): GetContextResult;
}
declare const TUIConstants: {
TUILogin: {
EVENT: {
LOGIN_STATE_CHANGED: string;
};
EVENT_SUB_KEY: {
USER_LOGIN_SUCCESS: string;
USER_LOGOUT_SUCCESS: string;
USER_KICKED_OFFLINE: string;
USER_SIG_EXPIRED: string;
};
};
TUIConversation: {
SERVICE: {
NAME: string;
METHOD: {
CREATE_CONVERSATION: string;
HIDE_CONVERSATION_HEADER: string;
};
};
EXTENSION: {
CONV_POP_MENU: {
EXT_ID: string;
};
CONV_GROUP: {
EXT_ID: string;
};
};
};
TUIChat: {
SERVICE: {
NAME: string;
METHOD: {
UPDATE_MESSAGE_LIST: string;
CLOSE_MESSAGE_POP_MENU: string;
SEND_CUSTOM_MESSAGE: string;
SEND_TEXT_MESSAGE: string;
SET_CHAT_TYPE: string;
UPDATE_MESSAGE_INFO: string;
};
};
EXTENSION: {
INPUT_MORE: {
EXT_ID: string;
};
MSG_POP_MENU: {
EXT_ID: string;
};
CHAT_HEADER: {
EXT_ID: string;
};
};
TYPE: {
C2C: string;
GROUP: string;
CUSTOMER_SERVICE: string;
ROOM: string;
};
EVENT: {
CHAT_STATE_CHANGED: string;
CHAT_TYPE_CHANGED: string;
};
EVENT_SUB_KEY: {
CHAT_OPENED: string;
CHANGE_SUCCESS: string;
};
FEATURE: {
DownloadFile: string;
CopyMessage: string;
DeleteMessage: string;
RevokeMessage: string;
QuoteMessage: string;
ForwardMessage: string;
TranslateMessage: string;
VoiceToText: string;
MultiSelection: string;
EmojiReaction: string;
InputEmoji: string;
InputStickers: string;
InputImage: string;
InputVoice: string;
InputVideo: string;
InputFile: string;
InputEvaluation: string;
InputQuickReplies: string;
InputMention: string;
MessageSearch: string;
ReadStatus: string;
};
};
TUIGroup: {
SERVICE: {
NAME: string;
METHOD: {
CREATE_GROUP: string;
OPEN_GROUP_MANAGEMENT: string;
SELECT_GROUP_MEMBER: string;
};
};
};
TUIContact: {
SERVICE: {
NAME: string;
METHOD: {
SELECT_FRIEND: string;
};
};
EXTENSION: {
CONTACT_LIST: {
EXT_ID: string;
};
};
};
TUISearch: {
SERVICE: {
NAME: string;
METHOD: {
SEARCH_GROUP: string;
SEARCH_USER: string;
SEARCH_FRIEND: string;
SEARCH_GROUP_MEMBER: string;
};
};
EXTENSION: {
SEARCH_MORE: {
EXT_ID: string;
};
};
};
TUICalling: {
SERVICE: {
NAME: string;
METHOD: {
START_CALL: string;
};
};
};
TUIRoom: {
SERVICE: {
NAME: string;
};
};
TUIEmojiPlugin: {
SERVICE: {
NAME: string;
METHOD: {
CLOSE_EMOJI_DETAIL: string;
};
};
};
TUITranslate: {
EVENT: {
LANGUAGE_CHANGED: string;
};
EVENT_SUB_KEY: {
CHANGE_SUCCESS: string;
};
};
TUITranslatePlugin: {
SERVICE: {
NAME: string;
};
};
TUIVoiceToTextPlugin: {
SERVICE: {
NAME: string;
};
};
TUICustomerServicePlugin: {
SERVICE: {
NAME: string;
METHOD: {
ACTIVE_CONVERSATION: string;
FILTER_MESSAGE: string;
};
};
EXTENSION: {};
};
TUIPushPlugin: {
SERVICE: {
NAME: string;
};
};
TUIChatbotPlugin: {
SERVICE: {
NAME: string;
};
};
TUITheme: {
EVENT: {
THEME_CHANGED: string;
};
EVENT_SUB_KEY: {
CHANGE_SUCCESS: string;
};
};
};
declare const tuiCore: ITUICore;
declare const tuiLogin: ITUILogin;
export { CallServiceParams, ExtensionInfo, LoginParams, TUIConstants, tuiCore as TUICore, tuiLogin as TUILogin, tuiCore as default, func };