easemob-websdk 4.24.1 → 5.0.0

package/types/presenceApi.d.ts

@@ -1,61 +0,0 @@
-/**
- * presence types
- * @module TYPES
- */
-interface SubscribePresence {
-	/** The expiration time of the presence subscription. */
-	expiry: number;
-	/** The presence extension information. */
-	ext: string;
-	/** The presence update time, which is generated by the server. */
-	last_time: number;
-	/** The details of the current presence state. */
-	status: object;
-	/** The user ID of the presence publisher. */
-	uid: string;
-}
-interface SubscribePresenceResult {
-	/** The subscribe result. */
-	result: SubscribePresence[];
-}
-interface SubscribeUserListType {
-	/** The user ID of the presence publisher. */
-	uid: string;
-	/** The expiration time of the presence subscription. */
-	expiry: number;
-}
-interface GetSubscribedType {
-	/** subscribe users list */
-	sublist: SubscribeUserListType[];
-	/** The total number of subscribe users  */
-	totalnum: number;
-}
-interface GetSubscribedPresenceListResult {
-	/** Fetch all subscribe result. */
-	result: GetSubscribedType;
-}
-interface StatusDetailsType {
-	device: string;
-	status: number;
-}
-interface PresenceType {
-	/** The user ID of the presence publisher. */
-	userId: string;
-	/** The details of the current presence state. */
-	statusDetails: StatusDetailsType[];
-	/** The presence extension information. */
-	ext: string;
-	/** The presence update time, which is generated by the server. */
-	lastTime: number;
-	/** The expiration time of the presence subscription. */
-	expire: number;
-}
-export type {
-	SubscribePresence,
-	SubscribePresenceResult,
-	SubscribeUserListType,
-	GetSubscribedType,
-	GetSubscribedPresenceListResult,
-	PresenceType,
-	StatusDetailsType,
-};

package/types/reactionApi.d.ts

@@ -1,74 +0,0 @@
-import { UserId } from './common';
-interface ReactionMessage {
-	/** The message sender. */
-	from: string;
-	/** The message recipient. */
-	to: string;
-	/** The conversation type. */
-	chatType: 'singleChat' | 'groupChat';
-	/** The reaction to be added to the message. The length is limited to 128 characters. */
-	reactions: Reaction[];
-	/** The ID of the message whose reaction updated. */
-	messageId: string;
-	/** The Unix timestamp for updating the reaction. */
-	ts: number;
-}
-interface Reaction {
-	/** The content of the reaction to be added to the message. The length is limited to 128 characters. */
-	reaction: string;
-	/** The reaction count. */
-	count: number;
-	/** The reaction update operation. Once the reaction is updated, the onReactionChange callback is triggered. */
-	op?: {
-		operator: UserId;
-		reactionType: 'create' | 'delete';
-	}[];
-	/** The IDs of the users that added the reaction. */
-	userList: UserId[];
-	/** Whether the current user has added this reaction.
-	 * - `true`: Yes.
-	 * - `false`: No.
-	 */
-	isAddedBySelf?: boolean;
-}
-interface GetReactionDetailResult {
-	/** The reaction to be added to the message. The length is limited to 128 characters. */
-	reaction: string;
-	/** Whether the current user added this reaction.
-	 * - `true`: Yes;
-	 * - `false`: No.
-	 */
-	isAddedBySelf: boolean;
-	/** The number of users that added this reaction. */
-	userCount: number;
-	/** The IDs of the users who added the reaction. */
-	userList: UserId[];
-	/** The cursor that specifies where to start to get data. If there is data on the next page, this method will return the cursor to indicate where to start to get data for the next query. If it is `null`, the data of the first page will be returned.*/
-	cursor: string;
-}
-interface ReactionListItem {
-	/** The reaction added to the message. It cannot exceed 128 characters. */
-	reaction: string;
-	/** Whether the current user added this reaction.
-	 * - `true`: Yes;
-	 * - `false`: No.
-	 */
-	isAddedBySelf: boolean;
-	/** The number of users that added this reaction. */
-	userCount: number;
-	/** The IDs of the users who added the reaction. */
-	userList: UserId[];
-}
-interface GetReactionListResult {
-	/** The ID of the message to which this reaction was added. */
-	msgId: string;
-	/** The reaction list of this message. */
-	reactionList: ReactionListItem[];
-}
-export type {
-	ReactionMessage,
-	Reaction,
-	GetReactionDetailResult,
-	GetReactionListResult,
-	ReactionListItem,
-};

package/types/restApis.d.ts

@@ -1,6 +0,0 @@
-interface RosterData {
-	name: string;
-	subscription: string;
-	jid: string;
-}
-export type { RosterData };

package/types/silentModeApi.d.ts

@@ -1,109 +0,0 @@
-/**
- * improve push types
- * @module TYPES
- */
-interface SilentModeConversationType {
-	/** Silent mode type. */
-	type: string;
-	/** Silent mode duration, duration of Unix timestamp. */
-	ignoreDuration: number;
-	/** Silent mode interval. */
-	ignoreInterval: string;
-}
-interface ConversationSilentModeType {
-	/** User push map. */
-	user: {
-		[propname: string]: SilentModeConversationType;
-	};
-	/** Group push map. */
-	group: {
-		[propname: string]: SilentModeConversationType;
-	};
-}
-interface TranslationLanguageType {
-	/** Translation language. */
-	language: string;
-}
-declare enum SILENTMODETYPE {
-	/** All message. */
-	ALL = 'ALL',
-	/** @ message of myself. */
-	AT = 'AT',
-	/** None. */
-	NONE = 'NONE',
-}
-declare enum CONVERSATIONTYPE {
-	/** Single chat. */
-	SINGLECHAT = 'singleChat',
-	/** Group chat. */
-	GROUPCHAT = 'groupChat',
-	/** Chat room. */
-	CHATROOM = 'chatRoom',
-}
-declare type ConversationListType = {
-	/** Conversation id. */
-	id: string;
-	/** Conversation type. */
-	type: string;
-};
-interface SilentModeRemindType {
-	/** Silent mode type. */
-	paramType: 0;
-	/** Silent mode type. */
-	remindType: SILENTMODETYPE;
-}
-interface SilentModeDuration {
-	/** Silent mode type. */
-	paramType: 1;
-	/** Silent mode duration, duration of Unix timestamp. */
-	duration: number;
-}
-interface SilentModeInterval {
-	/** Silent mode type. */
-	paramType: 2;
-	/** Start time interval. */
-	startTime: Interval;
-	/** End time interval. */
-	endTime: Interval;
-}
-
-interface ConversationWithRemindType {
-	/** Conversation id. */
-	conversationId: string;
-	/** Conversation type. */
-	type: 'singleChat' | 'groupChat';
-	/** Silent mode type. */
-	remindType: SILENTMODETYPE;
-}
-
-interface GetSilentModeRemindTypeConversationsResult {
-	/** The cursor that specifies where to start to get data. */
-	cursor: string;
-	/** conversations with remind type. */
-	conversations: ConversationWithRemindType[];
-}
-
-export declare type Interval = {
-	/** Hours. */
-	hours: number;
-	/** Minutes. */
-	minutes: number;
-};
-declare type SilentModeParamType =
-	| SilentModeRemindType
-	| SilentModeDuration
-	| SilentModeInterval;
-export type {
-	SilentModeConversationType,
-	ConversationSilentModeType,
-	TranslationLanguageType,
-	SILENTMODETYPE,
-	CONVERSATIONTYPE,
-	ConversationListType,
-	SilentModeParamType,
-	SilentModeRemindType,
-	SilentModeDuration,
-	SilentModeInterval,
-	GetSilentModeRemindTypeConversationsResult,
-	ConversationWithRemindType,
-};

package/types/threadApi.d.ts

@@ -1,175 +0,0 @@
-/**
- * The threading types.
- * @module TYPES
- */
-import { UserId } from './common';
-import { MessageBody } from './message';
-/** The message thread interface. */
-interface ChatThread {
-	/** The ID of the parent message in the message thread. */
-	messageId: string;
-	/** The group ID to which the message thread belongs. */
-	parentId: string;
-	/** The message thread name. */
-	chatThreadName: SVGStringList;
-}
-/** The message thread overview interface. */
-interface ChatThreadOverview {
-	/** The message thread ID. */
-	id: string;
-	/** The group ID to which the message thread belongs. */
-	parentId: string;
-	/** The message thread name. */
-	name: string;
-	/** The last threaded reply. */
-	lastMessage: LastMessage;
-	/** The Unix timestamp when the message thread is created. The unit is millisecond. */
-	createTimestamp: number;
-	/** The Unix timestamp when the message thread overview is updated. The unit is millisecond. */
-	updateTimestamp: number;
-	/** The number of threaded replies. */
-	messageCount: number;
-}
-/** The interface for the last threaded reply. */
-interface LastMessage {
-	/** The message ID. */
-	id: string;
-	/** The user ID of the sender. */
-	from: string;
-	/** The user ID of the recipient. */
-	to: string;
-	/** The Unix timestamp when the message is sent. The unit is millisecond. */
-	timestamp: number;
-	/** The message content. */
-	payload: any;
-}
-export declare type Operation = 'create' | 'update' | 'delete' | 'update_msg';
-/** The interface for message thread events. */
-interface ThreadNotifyServerMsg {
-	/** The event type. */
-	operation: Operation;
-	/** The ID of the parent message in the message thread. */
-	msg_parent_id?: string;
-	/** The message thread ID. */
-	id: string;
-	/** The group ID to which the message thread belongs. */
-	muc_parent_id: string;
-	/** The message thread name. */
-	name: string;
-	/** The Unix timestamp when an event occurs. The unit is millisecond. */
-	timestamp: number;
-	/** The operator. */
-	from?: string;
-	/** The last threaded reply. */
-	last_message?: LastMessage;
-	/** The number of threaded replies. */
-	message_count?: number;
-}
-/** The interface for the message thread creation result. */
-interface CreateChatThreadResult {
-	/** The message thread ID. */
-	chatThreadId: string;
-}
-/** The interface for the message thread name changes. */
-interface ChangeChatThreadName {
-	/** The message thread name. */
-	name: string;
-}
-/** The interface for the message thread member list. */
-interface ChatThreadMembers {
-	/** The list of members in a message thread. */
-	affiliations: string[];
-}
-/** The definition for the result of removing a member from the message thread. */
-declare type RemoveMemberResult = {
-	/** Whether the member is successfully removed from the message thread.
-	 * - `true`: Yes.
-	 * - `false`: No.
-	 */
-	result: boolean;
-	/** The ID of the removed message thread member. */
-	user: UserId;
-};
-/** The interface for the message thread details. */
-interface ChatThreadDetail {
-	/** The message thread ID. */
-	id: string;
-	/** The message thread name. */
-	name: string;
-	/** The message thread creator. */
-	owner: string;
-	/** The Unix timestamp when the message thread is created. The unit is millisecond. */
-	created: number;
-	/** The member count of the message thread. */
-	affiliationsCount?: number;
-	/** The group ID to which the message thread belongs. */
-	parentId: string;
-	/** The ID of the parent message. */
-	messageId: string;
-}
-/** The interface for the result of joining the message thread. */
-interface JoinChatThreadResult {
-	/** Whether the current user successfully joins the message thread. The value is `OK`, indicating that the user successfully joins the message thread.*/
-	status: string;
-	/** The message thread details. */
-	detail: ChatThreadDetail;
-}
-/** The interface for the last threaded reply. */
-interface ChatThreadLastMessage {
-	/** The message thread ID. */
-	chatThreadId: string;
-	/** The last threaded reply. */
-	lastMessage: MessageBody;
-}
-/**
- * The definition of the message thread event types: <br/>
- * create: Occurs when creating a chat thread.<br/>
- * update: Occurs when there is a new message in the chat thread.<br/>
- * destroy: Occurs when a chat thread is deleted.<br/>
- * userRemove: Occurs when you were kicked out of chat thread.<br/>
- */
-declare type onChatThreadChangeType =
-	| 'create'
-	| 'update'
-	| 'destroy'
-	| 'userRemove';
-/** The interface for the message thread event details. */
-interface ThreadChangeInfo {
-	/** The message thread ID. */
-	id: string;
-	/** The message thread name. */
-	name: string;
-	/** The operator. */
-	operator: string;
-	/** The event type. */
-	operation: onChatThreadChangeType;
-	/** The group ID to which the message thread belongs. */
-	parentId: string;
-	/** The ID of the parent message. */
-	messageId?: string;
-	/** The number of threaded replies. */
-	messageCount?: number;
-	/** The last threaded reply. */
-	lastMessage?: MessageBody | {};
-	/** The operation object. */
-	userName?: string;
-	/** The Unix timestamp when the event occurs. The unit is millisecond. */
-	timestamp?: number;
-	/** The Unix timestamp when the message thread is created. The unit is millisecond.*/
-	createTimestamp?: number;
-}
-export type {
-	ChatThread,
-	ThreadNotifyServerMsg,
-	LastMessage,
-	ChatThreadOverview,
-	CreateChatThreadResult,
-	ChangeChatThreadName,
-	ChatThreadMembers,
-	RemoveMemberResult,
-	ChatThreadDetail,
-	JoinChatThreadResult,
-	ChatThreadLastMessage,
-	ThreadChangeInfo,
-	onChatThreadChangeType,
-};

package/types/translation.d.ts

@@ -1,25 +0,0 @@
-interface TranslationResult {
-	/** The translation results body. */
-	translations: {
-		/** The translation. */
-		text: string;
-		/** The target language of translation. */
-		to: string;
-	}[];
-	/** The original text language detection result. */
-	detectedLanguage: {
-		/** The original text language. */
-		language: string;
-		/** The test result score (0-1). */
-		score: number;
-	};
-}
-interface SupportLanguage {
-	/** The codes of the target languages. For example, the code for simplified Chinese is "zh-Hans". */
-	code: string;
-	/** The language name. For example, the code for simplified Chinese is "Chinese Simplified". */
-	name: string;
-	/** The native name of the language. For example, the native name of simplified Chinese is "Chinese (Simplified)".*/
-	nativeName: string;
-}
-export type { TranslationResult, SupportLanguage };

package/types/utils.d.ts

@@ -1,90 +0,0 @@
-import { Code } from '../status';
-interface AsyncResult<T = any> {
-	/** Status of the request. */
-	type: Code;
-	/** Data returned by successful request. */
-	data?: T;
-	/** message. */
-	message?: string;
-	[key: string]: any;
-}
-interface uri {
-	url: string;
-	filename: string;
-	filetype: string;
-	data: File | null;
-}
-interface KVString {
-	[key: string]: string;
-}
-interface AjaxOptions {
-	url: string;
-	dataType?: string;
-	type?: string;
-	data?: any;
-	headers?: KVString;
-	responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
-	mimeType?: string;
-	success?: (res: any) => void;
-	error?: (res: any) => void;
-}
-interface UploadFileOptions {
-	onFileUploadProgress?: (msg: any) => void;
-	onFileUploadComplete?: (msg: any) => void;
-	onFileUploadError?: (msg: any) => void;
-	onFileUploadCanceled?: (msg: any) => void;
-	accessToken: string;
-	appKey: string;
-	apiUrl: string;
-	uploadUrl?: string;
-	file: any;
-}
-declare type Fns = (...args: any) => any;
-declare enum PLATFORM {
-	WEB = 'web',
-	WX = 'wx',
-	ZFB = 'zfb',
-	DD = 'dd',
-	TT = 'tt',
-	BAIDU = 'baidu',
-	QUICK_APP = 'quick_app',
-	UNI = 'uni',
-	NODE = 'node',
-}
-interface EnvInfo {
-	platform: PLATFORM;
-	global: any;
-}
-interface DownloadParams {
-	onFileDownloadComplete: (data: any) => void;
-	onFileDownloadError: (error: any) => void;
-	id: string;
-	secret: string;
-	[key: string]: any;
-}
-interface Utils {
-	/** @hidden */
-	autoIncrement: number;
-	getUniqueId: () => string;
-	/** @hidden */
-	ajax: (options: AjaxOptions) => Promise<AsyncResult<any>>;
-	getFileUrl: (fileInputId: string | HTMLInputElement) => uri;
-	uploadFile: (options: UploadFileOptions) => void;
-	/** @hidden */
-	flow: (fns: Fns[]) => any;
-	listenNetwork: (online: () => void, offline: () => void) => void;
-	getEnvInfo: () => EnvInfo;
-	/** @hidden */
-	wxRequest: (options: AjaxOptions) => Promise<AsyncResult<any>>;
-	/** @hidden */
-	parseDownloadResponse: (res: any) => string;
-	download: (params: DownloadParams) => void;
-}
-export type {
-	Utils,
-	DownloadParams,
-	EnvInfo,
-	PLATFORM,
-	UploadFileOptions,
-	uri,
-};