easemob-websdk 4.10.0 → 4.11.0

package/message/audio.d.ts

@@ -97,6 +97,10 @@ export interface AudioMsgBody extends AudioMsgSetParameters {
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
 	receiverList?: string[];
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateAudioMsgParameters {
 	/** The message type. */

package/message/cmd.d.ts

@@ -82,6 +82,10 @@ export interface CmdMsgBody {
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
 	receiverList?: string[];
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateCmdMsgParameters {
 	/** The message type. */

package/message/combine.d.ts

@@ -8,153 +8,111 @@ import {
 } from '../types/message';
 export interface CombineParameters {
 	/** The message type. */
-	/** 消息类型。 */
 	type: 'combine';
 	/** The message ID. */
-	/** 消息 ID。*/
 	id: string;
 }
 export interface CombineMsgBody {
 	/** The message ID. */
-	/** 消息 ID。*/
 	id: string;
 	/** The conversation type. */
-	/** 会话类型。 */
 	chatType: ChatType;
 	/** The message type. */
-	/** 消息类型。 */
 	type: 'combine';
 	/** The recipient. */
-	/** 消息接收方。 */
 	to: string;
 	/** The sender, which can only be the current user and can not be changed.*/
-	/** 消息发送方，只能是当前用户，无法修改。*/
 	from?: string;
 	/** @deprecated Whether the conversation type is chat room. */
-	/** @deprecated 会话类型是否是聊天室。 */
 	roomType?: boolean;
 	/** @deprecated Whether the conversation type is group. */
-	/** @deprecated 会话类型是否是群组。 */
 	group?: string;
 	/** Message extension. */
-	/** 消息扩展。 */
 	ext?: {
 		[key: string]: any;
 	};
 	/** Whether read receipts are required during a group conversation. */
-	/** 群组会话时是否需返回已读回执。*/
 	msgConfig?: {
 		allowGroupAck?: boolean;
 		languages?: string[];
 	};
 	/** Time. */
-	/** 时间。 */
 	time: number;
 	/** Whether the message is a threaded message. */
-	/** 消息是否为子区消息 */
 	isChatThread?: boolean;
 	/** The message priority. */
-	/** 消息优先级 */
 	priority?: MessagePriority;
 	/** Whether global notify message or not. */
-	/** 判断是否是全局广播消息。 */
 	broadcast?: boolean;
 	/** Whether the message content is replaced. This property is valid only when `useReplacedMessageContent` is set to `true` during initialization. */
-	/** 消息内容是否已被替换。该属性仅在初始化时开启 `useReplacedMessageContent` 后有效。*/
 	isContentReplaced?: boolean;
 	/** Whether the message is delivered only when the recipient(s) is/are online:
 	 *  - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
 	 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 	 */
-	/** 消息是否只投递给在线用户：
-	 * - `true`: 只有消息接收方在线时才能投递成功。若接收方离线，则消息会被丢弃。
-	 * - （默认）`false`: 如果用户在线，则直接投递；如果用户离线，消息会在用户上线时投递。
-	 */
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
-	/** 消息接收方列表。 */
 	receiverList?: string[];
 	/** The compatibility information for combining message. */
-	/** 合并消息的兼容信息。 */
 	compatibleText: string;
 	/** The title of the combined message. */
-	/** 合并消息的标题。 */
 	title: string;
 	/** The summary list of the combined message. */
-	/** 合并消息的摘要列表。 */
 	summary: string;
 	/** The message list of the combined message. */
-	/** 合并消息列表。 */
 	messageList: MessagesType[];
 	/** The callback of a file upload error. */
-	/** 文件上传错误的回调。 */
 	onFileUploadError?: (error: any) => void;
 	/** The callback of file upload completion. */
-	/** 文件上传完成的回调。 */
 	onFileUploadComplete?: (data: { url: string; secret: string }) => void;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateCombineMsgParameters {
 	/** The conversation type. */
-	/** 会话类型。 */
 	chatType: ChatType;
 	/** The message type. */
-	/** 消息类型。 */
 	type: 'combine';
 	/** The recipient. */
-	/** 消息接收方。 */
 	to: string;
 	/** The sender, which can only be the current user and can not be changed. */
-	/** 消息发送方，只能是当前用户，无法修改。*/
 	from?: string;
 	/** The message extension. */
-	/** 消息扩展。 */
 	ext?: {
 		[key: string]: any;
 	};
 	/** Whether read receipts are required during a group conversation. */
-	/** 群组会话时是否需返回已读回执。*/
 	msgConfig?: {
 		allowGroupAck?: boolean;
 		languages?: string[];
 	};
 	/** Whether the message is a threaded message. */
-	/** 消息是否为子区消息。  */
 	isChatThread?: boolean;
 	/** Message priority. */
-	/** 消息优先级 */
 	priority?: MessagePriority;
 	/** Whether the message is delivered only when the recipient(s) is/are online:
 	 *  - `true`: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
 	 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 	 */
-	/** 消息是否只投递给在线用户：
-	 * - `true`: 只有消息接收方在线时才能投递成功。若接收方离线，则消息会被丢弃。
-	 * - （默认）`false`: 如果用户在线，则直接投递；如果用户离线，消息会在用户上线时投递。
-	 */
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
-	/** 消息接收方列表。 */
 	receiverList?: string[];
 	/** The compatible text of the combined message. */
-	/** 合并消息的兼容信息。 */
 	compatibleText: string;
 	/** The title of the combined message. */
-	/** 合并消息的标题。 */
 	title: string;
 	/** The summary list of the combined message. */
-	/** 合并消息摘要列表。 */
 	summary: string;
 	/** The message list of the combined message. */
-	/** 合并消息的消息列表。 */
 	messageList: Exclude<
 		MessagesType,
 		DeliveryMsgBody | ReadMsgBody | ChannelMsgBody
 	>[];
 	/** The callback of a file upload error. */
-	/** 文件上传错误的回调。 */
 	onFileUploadError?: (error: any) => void;
 	/** The callback of file upload completion. */
-	/** 文件上传完成的回调。 */
 	onFileUploadComplete?: (data: { url: string; secret: string }) => void;
 }
 export declare class Combine {

package/message/custom.d.ts

@@ -70,6 +70,10 @@ export interface CustomMsgBody extends CreateCustomMsgParameters {
 	deliverOnlineOnly?: boolean;
 	/** Message modified info. */
 	modifiedInfo?: ModifiedMsgInfo;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateCustomMsgParameters {
 	/** The message type. */

package/message/file.d.ts

@@ -92,6 +92,10 @@ export interface FileMsgBody extends CreateFileMsgParameters {
 	 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 	 */
 	deliverOnlineOnly?: boolean;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateFileMsgParameters {
 	/** The message type. */

package/message/img.d.ts

@@ -105,6 +105,10 @@ export interface ImgMsgBody extends CreateImgMsgParameters {
 	 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 	 */
 	deliverOnlineOnly?: boolean;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateImgMsgParameters {
 	/** The message type. */

package/message/index.d.ts

@@ -64,6 +64,7 @@ import {
 	FileMsgSetParameters,
 	FileParameters,
 } from './file';
+import { DownloadParams } from '../types/utils';
 export type MessageType =
 	| 'read'
 	| 'delivery'
@@ -144,18 +145,17 @@ declare class Message {
 	/** @hidden */
 	static createOldMsg(options: NewMessageParamters): any;
 	/** Creates a message. */
-	/** 创建消息。*/
 	static create(options: CreateMsgType): MessageBody;
 	/** When sending attachment messages, use this method to obtain the file path. */
 	static getFileUrl: (fileInputId: string | HTMLInputElement) => FileObj;
+	/** Download file. */
+	static download: (params: DownloadParams) => void;
+	/** Convert the downloaded object into an object URL. */
+	static parseDownloadResponse: (res: any) => string;
 	/**
 	 * @hidden
 	 * Set the message body.
 	 */
-	/**
-	 * @hidden
-	 * 设置消息体。
-	 */
 	set(options: MessageSetParameters): void;
 }
 export { Message };

package/message/location.d.ts

@@ -68,6 +68,10 @@ export interface LocationMsgBody extends CreateLocationMsgParameters {
 	 *  - (Default) `false`: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.
 	 */
 	deliverOnlineOnly?: boolean;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateLocationMsgParameters {
 	/** The message type. */

package/message/text.d.ts

@@ -86,6 +86,10 @@ export interface TextMsgBody {
 	receiverList?: string[];
 	/** Message modified info. */
 	modifiedInfo?: ModifiedMsgInfo;
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateTextMsgParameters {
 	/** The session type. */

package/message/video.d.ts

@@ -95,6 +95,10 @@ export interface VideoMsgBody extends VideoMsgSetParameters {
 	deliverOnlineOnly?: boolean;
 	/** The list of message recipients. */
 	receiverList?: string[];
+	/** Has the message been read (only single chat messages have this field). */
+	isRead?: boolean;
+	/** Has the message been delivered (only single chat messages have this field). */
+	isDelivered?: boolean;
 }
 export interface CreateVideoMsgParameters {
 	/** The message type. */