easemob-websdk 4.17.0 → 4.19.0

package/Easemob-chat.d.ts

@@ -278,6 +278,8 @@ export declare namespace EasemobChat {
 		customOSPlatform?: number;
 		/** Customize device name.  The device name can only be set through this parameter after configuring customOSPlatform. */
 		customDeviceName?: string;
+		/** Whether to enable auto login mode. Only supported on uniapp platform. */
+		isAutoLogin?: boolean;
 	};
 
 	interface RegisterUserResult extends AsyncResult {
@@ -1425,12 +1427,18 @@ export declare namespace EasemobChat {
 		WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE = 206,
 		/** The user was removed. */
 		WEBIM_CONNCTION_USER_REMOVED = 207,
+		/** The user is already logged in. */
+		WEBIM_USER_ALREADY_LOGIN = 208,
+		/** The number of devices the user is logged in to exceeds the limit. */
+		USER_LOGIN_TOO_MANY_DEVICES = 214,
 		/** The password is renewed. */
 		WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD = 216,
 		/** The user was kicked off from another device. */
 		WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE = 217,
 		/** Global muted. */
 		USER_MUTED_BY_ADMIN = 219,
+		/** The user device is changed. */
+		USER_DEVICE_CHANGED = 220,
 		/**
 		 * The user is not on your contact list, and you cannot send messages to him or her.
 		 * Note: You can send messages to strangers by default. This error occurs only when you enable the function of allowing to send messages only to your contacts.
@@ -1577,6 +1585,7 @@ export declare namespace EasemobChat {
 		};
 
 		eventHandler?: EventHandler;
+		/// #if !IS_LITE
 		/**
 		 * @deprecated
 		 */
@@ -1586,6 +1595,7 @@ export declare namespace EasemobChat {
 		 */
 		onPresence?: (msg: PresenceMsg) => void;
 		onTextMessage?: (msg: TextMsgBody) => void;
+		onStreamMessage?: (msg: StreamMsgBody) => void;
 		onPictureMessage?: (msg: ImgMsgBody) => void;
 		onAudioMessage?: (msg: AudioMsgBody) => void;
 		onVideoMessage?: (msg: VideoMsgBody) => void;
@@ -1608,6 +1618,7 @@ export declare namespace EasemobChat {
 		onContactAdded?: (msg: ContactMsgBody) => void;
 		onTokenWillExpire?: () => void;
 		onTokenExpired?: () => void;
+		/// #endif
 		// eslint-disable-next-line no-undef
 		[key: string]: any;
 		constructor(options: ConnectionParameters);
@@ -1651,6 +1662,7 @@ export declare namespace EasemobChat {
 		/** Updates token. */
 		renewToken(token: string): Promise<NewTokenResult>;
 
+		/// #if !IS_LITE
 		// ChatRoom API
 		/**
 		 * Gets chat room list (paging).
@@ -1717,6 +1729,7 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<CreateDeleteChatRoomResult>>;
 
+		/// #endif
 		/**
 		 * Gets specifications of the chat room.
 		 *
@@ -1736,6 +1749,7 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<Array<GetChatRoomDetailsResult>>>;
 
+		/// #if !IS_LITE
 		/**
 		 * Modifies the specifications of the chat room.
 		 *
@@ -1842,6 +1856,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<AddUsersToChatRoomResult>>;
 
+		/// #endif
+
 		/**
 		 * Joins the chat room.
 		 *
@@ -1871,6 +1887,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<JoinChatRoomResult>>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * @deprecated Use {@link leaveChatRoom} instead.
 		 * Exits the chat room.
@@ -1895,6 +1913,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<{ result: boolean }>>;
 
+		/// #endif
+
 		/**
 		 * Exits the chat room.
 		 *
@@ -1915,6 +1935,7 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<{ result: boolean }>>;
 
+		/// #if !IS_LITE
 		/** @deprecated */
 		listChatRoomMember(
 			this: Connection,
@@ -1953,6 +1974,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<{ member: string }[]>>;
 
+		/// #endif
+
 		/**
 		 * Gets the list chat room members with pagination.
 		 *
@@ -1977,6 +2000,8 @@ export declare namespace EasemobChat {
 			}>
 		>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * Gets all admins of the chat room.
 		 *
@@ -2555,6 +2580,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<boolean>>;
 
+		/// #endif
+
 		/**
 		 * Gets the announcement of the chat room.
 		 *
@@ -2574,6 +2601,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<FetchChatRoomAnnouncementResult>>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * Updates the announcement of the chat room.
 		 *
@@ -4404,6 +4433,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<DeleteSessionResult>>;
 
+		/// #endif
+
 		/**
 		 * Deletes the conversation.
 		 *
@@ -4431,6 +4462,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<DeleteSessionResult>>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * @deprecated Use {@link updateUserInfo} instead.
 		 * Updates own information.
@@ -4526,6 +4559,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<MessageBody[]>;
 
+		/// #endif
+
 		/**
 		 * Gets the message history.
 		 *
@@ -4601,6 +4636,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<void>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * Adds a friend.
 		 *
@@ -4717,6 +4754,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<void>;
 
+		/// #endif
+
 		/**
 		 * Recalls a message.
 		 *
@@ -4752,6 +4791,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<SendMsgResult>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * Modifies a message in the server.
 		 *
@@ -4788,6 +4829,8 @@ export declare namespace EasemobChat {
 		// listen @deprecated
 		listen(this: Connection, parameters: ListenParameters): void;
 
+		/// #endif
+
 		/**
 		 * Adds listening events.
 		 *
@@ -4810,6 +4853,8 @@ export declare namespace EasemobChat {
 		 */
 		removeEventHandler(id: string): void;
 
+		/// #if !IS_LITE
+
 		/** Download combined message. */
 		downloadAndParseCombineMessage(
 			options: DownloadCombineMessagesParams
@@ -5145,6 +5190,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<void>;
 
+		/// #endif
+
 		/**
 		 * Gets the list of conversations from the server with pagination.
 		 *
@@ -5171,6 +5218,9 @@ export declare namespace EasemobChat {
 				includeEmptyConversations?: boolean;
 			}
 		): Promise<AsyncResult<ServerConversations>>;
+
+		/// #if !IS_LITE
+
 		/**
 		 * Get the list of pinned conversations from the server with pagination.
 		 *
@@ -5195,6 +5245,9 @@ export declare namespace EasemobChat {
 				includeEmptyConversations?: boolean;
 			}
 		): Promise<AsyncResult<ServerConversations>>;
+
+		/// #endif
+
 		/**
 		 * Sets whether to pin a conversation.
 		 *
@@ -5217,6 +5270,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<PinConversation>>;
 
+		/// #if !IS_LITE
+
 		/**
 		 * Set contact remark.
 		 *
@@ -5855,6 +5910,8 @@ export declare namespace EasemobChat {
 			}
 		): Promise<AsyncResult<JoinedChatRoomsResult>>;
 
+		/// #endif
+
 		/** Execute this method during the onShow declaration cycle of the application, which will actively detect whether the current connection is valid. */
 		onShow(): void;
 	}
@@ -5947,6 +6004,7 @@ export declare namespace EasemobChat {
 		| 'onReadMessage'
 		| 'onRecallMessage'
 		| 'onChannelMessage'
+		| 'onStreamMessage'
 		| 'onError'
 		| 'onOffline'
 		| 'onOnline'
@@ -6151,6 +6209,8 @@ export declare namespace EasemobChat {
 		) => void;
 		/** The callback to receive a text message. */
 		onTextMessage?: (msg: TextMsgBody) => void;
+		/** The callback to receive a stream message. */
+		onStreamMessage?: (msg: StreamMsgBody) => void;
 		/** The callback to receive a image message. */
 		onImageMessage?: (msg: ImgMsgBody) => void;
 		/** The callback to receive a audio message. */
@@ -6260,6 +6320,8 @@ export declare namespace EasemobChat {
 		): void;
 	}
 
+	/// #if !IS_LITE
+
 	/**
 	 * @module listen
 	 * @deprecated
@@ -6294,6 +6356,8 @@ export declare namespace EasemobChat {
 		onPresenceStatusChange?: (msg: PresenceType[]) => void;
 	}
 
+	/// #endif
+
 	// ----- for Error -----
 
 	interface ErrorParameters {
@@ -6785,6 +6849,39 @@ export declare namespace EasemobChat {
 		receiverList?: string[];
 	}
 
+	interface StreamChunk {
+		/** The custom type. */
+		customType: string;
+		/** The sequence number. */
+		seq: number;
+		/** The status. */
+		status: StreamStatus;
+		/** The error type. */
+		errorType: number;
+		/** The text. */
+		text: string; // 增量内容
+		/** The finish reason. */
+		finishReason?: number;
+	}
+
+	enum StreamStatus {
+		/** The stream start. */
+		START = 0,
+		/** The stream start and completed. */
+		START_AND_COMPLETED = 1,
+		/** The stream in progress. */
+		IN_PROGRESS = 2,
+		/** The stream completed. */
+		COMPLETED = 3,
+		/** The stream error. */
+		ERROR = 4,
+	}
+
+	interface StreamMsgBody extends TextMsgBody {
+		/** The stream chunk. */
+		stream: Omit<StreamChunk, 'seq'>;
+	}
+
 	interface CombineMsgBody {
 		/** The message ID. */
 		id: string;
@@ -7953,7 +8050,8 @@ export declare namespace EasemobChat {
 		| VideoMsgBody
 		| FileMsgBody
 		| ReadMsgBody
-		| CombineMsgBody;
+		| CombineMsgBody
+		| StreamMsgBody;
 
 	type MessageSetParameters =
 		| ReadMsgSetParameters
@@ -7994,7 +8092,8 @@ export declare namespace EasemobChat {
 		| AudioMsgBody
 		| VideoMsgBody
 		| FileMsgBody
-		| CombineMsgBody;
+		| CombineMsgBody
+		| StreamMsgBody;
 
 	type MessagePriority = 'high' | 'normal' | 'low';
 	interface MetaExts {