node-nim 10.4.0-beta.1 → 10.6.0-beta.0

package/types/nim/sysmsg.d.ts

@@ -14,21 +14,21 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
     /** 注册全局回调 */
     initEventHandlers(): void;
     /** 发送自定义通知消息
-     * @param json_msg		消息体Json, 可以通过CreateCustomNotificationMsg方法自动创建
+     * @param json_msg    消息体Json, 可以通过CreateCustomNotificationMsg方法自动创建
      * @return void 无返回值
      */
     sendCustomNotificationMsg(msg: SysMessage): void;
     /** 查询本地系统消息
-     * @param limit_count	一次查询数量，建议20
-     * @param last_time	上次查询最后一条消息的时间戳
+     * @param limit_count  一次查询数量，建议20
+     * @param last_time  上次查询最后一条消息的时间戳
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			查询本地系统消息的回调函数
+     * @param cb      查询本地系统消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      */
     queryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback | null, jsonExtension: string): Promise<[number, number, Array<SysMessage>] | null>;
     /** 查询未读消息数
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			查询未读消息数的回调函数
+     * @param cb      查询未读消息数的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -37,10 +37,10 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
      */
     queryUnreadCount(cb: NotifySysmsgResCallback | null, jsonExtension: string): Promise<[NIMResCode, number]>;
     /** 设置消息状态
-     * @param msg_id		消息id
-     * @param status		消息状态
+     * @param msg_id    消息id
+     * @param status    消息状态
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			设置消息状态的回调函数
+     * @param cb      设置消息状态的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -50,7 +50,7 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
     setStatusAsync(msg_id: string, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): Promise<[NIMResCode, number, number] | null>;
     /** 设置全部消息为已读
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			设置全部消息为已读的回调函数
+     * @param cb      设置全部消息为已读的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -59,9 +59,9 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
      */
     readAllAsync(cb: NotifySysmsgResCallback | null, jsonExtension: string): Promise<[NIMResCode, number]>;
     /** 删除消息
-     * @param msg_id		消息id
+     * @param msg_id    消息id
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			删除消息的回调函数
+     * @param cb      删除消息的回调函数
      * @return boolean 检查参数如果不符合要求则返回失败
      * @note
      * <pre>
@@ -71,7 +71,7 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
     deleteAsync(msg_id: string, cb: NotifySingleSysmsgCallback | null, jsonExtension: string): Promise<[NIMResCode, number, number] | null>;
     /** 全部删除
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			删除消息的回调函数
+     * @param cb      删除消息的回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -83,7 +83,7 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
      * @param type 类型
      * @param status 状态
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			回调函数
+     * @param cb      回调函数
      * @return void 无返回值
      * @note
      * <pre>
@@ -94,7 +94,7 @@ export declare class NIMSysMsg extends EventEmitter<NIMSysMsgEvents> {
     /** 按类型删除系统通知
      * @param type 类型
      * @param jsonExtension json扩展参数（备用，目前不需要）
-     * @param cb			回调函数
+     * @param cb      回调函数
      * @return void 无返回值
      * @note
      * <pre>

package/types/nim/talk.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'eventemitter3';
 import { IMMessage, MessageSetting, NIMMessageType } from '../nim_def/msglog_def';
-import { BroadcastMessage, FileUpPrgCallback, IMAudio, IMFile, IMImage, IMLocation, IMVideo, MessageFilterCallback, NIMTalkAPI, RecallMsgNotify, RecallMsgsCallback, SendMessageArc, TeamNotificationFilterCallback } from '../nim_def/talk_def';
+import { BroadcastMessage, FileUpPrgCallback, IMAudio, IMFile, IMImage, IMLocation, IMMessageSendOption, IMVideo, MessageFilterCallback, NIMTalkAPI, RecallMsgNotify, RecallMsgsCallback, SendMessageArc, TeamNotificationFilterCallback } from '../nim_def/talk_def';
 import { NIMResCode } from '../nim_def/client_def';
 import { NIMSessionType } from 'ts/node-nim';
 export declare interface NIMTalkEvents {
@@ -23,15 +23,23 @@ export declare class NIMTalk extends EventEmitter<NIMTalkEvents> {
     /** 注册全局回调 */
     initEventHandlers(): void;
     /** 发送消息
-     * @param json_msg		消息体Json字符串,可以通过CreateXXXMessage方法自动创建
+     * @param json_msg    消息体Json字符串,可以通过CreateXXXMessage方法自动创建
      * @param jsonExtension json扩展参数（备用,目前不需要）
-     * @param pcb		上传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+     * @param pcb    上传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
      * @return void 无返回值
      */
     sendMsg(msg: IMMessage, jsonExtension: string, progressCb: FileUpPrgCallback | null): void;
+    /**
+     * 携带配置参数发送消息
+     * @param msg 消息体
+     * @param option 配置参数
+     * @param progressCb 上传进度的回调函数
+     * @return void 无返回值
+     */
+    sendMessageWithOption(msg: IMMessage, option: IMMessageSendOption, progressCb: FileUpPrgCallback | null): void;
     /** 停止正在发送中的消息（目前只支持发送文件消息时的终止）
-     * @param client_msg_id	停止发送的消息客户端id
-     * @param type			停止发送的消息类型
+     * @param client_msg_id  停止发送的消息客户端id
+     * @param type      停止发送的消息类型
      * @param jsonExtension json扩展参数（备用,目前不需要）
      * @return void 无返回值
      */
@@ -39,7 +47,7 @@ export declare class NIMTalk extends EventEmitter<NIMTalkEvents> {
     /** 撤回消息
      * @param msg 消息
      * @param notify_msg 自定义通知消息
-     * @param cb	回调
+     * @param cb  回调
      * @param param 额外的参数，包含apnstext、pushpayload、jsonExtension、env_config、user_data
      * @note
      * <pre>
@@ -51,6 +59,15 @@ export declare class NIMTalk extends EventEmitter<NIMTalkEvents> {
      * </pre>
      */
     recallMsg(msg: IMMessage, notify_msg: string, cb: RecallMsgsCallback | null, apnstext: string, pushpayloadconst: string, jsonExtension: string): Promise<[NIMResCode, Array<RecallMsgNotify>]>;
+    /**
+     * @brief 回复消息 thread 聊天场景，携带指定配置
+     * @param formerMsg 被回复消息的消息体
+     * @param replyMsg 回复消息的消息体,可通过各种 createxxxmessage 接口创建
+     * @param option 配置参数
+     * @param progressCb 传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+     * @return void 无返回值
+     */
+    replyMessageWithOption(formerMsg: IMMessage, replyMsg: IMMessage, option: IMMessageSendOption, progressCb: FileUpPrgCallback): void;
     /** 创建文本消息 */
     createTextMessage(receiver_id: string, session_type: NIMSessionType, client_msg_id: string, content: string, msg_setting: MessageSetting, timetag: number, sub_type: number): IMMessage;
     /** 创建文件消息 */
@@ -68,14 +85,14 @@ export declare class NIMTalk extends EventEmitter<NIMTalkEvents> {
     /** 创建转发消息 */
     createRetweetMessage(sourceMessage: IMMessage, client_msg_id: string, session_type: NIMSessionType, receiver_id: string, msg_setting: MessageSetting, timetag: number): IMMessage;
     /** 从消息体中获取附件（图片、语音、视频等）的本地路径
-     *  @param  msg	消息
-     *  @return string	消息如果有附件，不管是否已下载，返回附件的本地路径；消息如果没有附件，返回空字符串。
+     *  @param  msg  消息
+     *  @return string  消息如果有附件，不管是否已下载，返回附件的本地路径；消息如果没有附件，返回空字符串。
      */
     getAttachmentPathFromMsg(msg: IMMessage): string;
     /** 回复消息thread 聊天场景
-     * @param formerMsg	    被回复消息的消息体
-     * @param replyMsg	    回复消息的消息体,可通过各种createxxxmessage接口创建
-     * @param progressCb		传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+     * @param formerMsg      被回复消息的消息体
+     * @param replyMsg      回复消息的消息体,可通过各种createxxxmessage接口创建
+     * @param progressCb    传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
      * @return void 无返回值
      */
     replyMessage(formerMsg: IMMessage, replyMsg: IMMessage, progressCb: FileUpPrgCallback): void;

package/types/nim/talkex.d.ts

@@ -21,74 +21,74 @@ export declare class NIMTalkEx extends EventEmitter<NIMTalkExEvents> {
     initEventHandlers(): void;
     /** Collect */
     /** 添加收藏
-     * @param collect_info	收藏内容
-     * @param cb		执行结果回调函数
+     * @param collect_info  收藏内容
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     addCollect(collect_info: CollectInfo, cb: AddCollectCallback | null): Promise<[NIMResCode, CollectInfo]>;
     /** 批量删除收藏
-     * @param collect_list	要删除的收藏列表
-     * @param cb		执行结果回调函数
+     * @param collect_list  要删除的收藏列表
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     removeCollects(collect_list: RemoveCollectsParm, cb: RemoveCollectsCallback | null): Promise<[NIMResCode, number]>;
     /** 更新收藏扩展字段
-     * @param collect_match_param	根据收藏的id 与 create time去匹配收藏内容
-     * @param ext	收藏的扩展字段内容
-     * @param cb		执行结果回调函数
+     * @param collect_match_param  根据收藏的id 与 create time去匹配收藏内容
+     * @param ext  收藏的扩展字段内容
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     updateCollectExt(collect_match_param: MatchCollectParm, ext: string, cb: UpdateCollectCallback | null): Promise<[NIMResCode, CollectInfo]>;
     /** 分页查询收藏列表
-     * @param query_collect_list_param	 查询参数
-     * @param cb		执行结果回调函数
+     * @param query_collect_list_param   查询参数
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     queryCollectList(query_collect_list_param: QueryCollectsParm, cb: QueryCollectsCallback | null): Promise<[NIMResCode, number, CollectInfoList]>;
     /** 添加快捷回复
-     * @param msg	被回复的消息
-     * @param info	回复的内容及设置
-     * @param cb		执行结果回调函数
+     * @param msg  被回复的消息
+     * @param info  回复的内容及设置
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     addQuickComment(msg: IMMessage, info: QuickCommentInfo, cb: AddQuickCommentCallback | null): Promise<[NIMResCode, QuickCommentInfo]>;
     /** 删除快捷回复
-     * @param msg	被删除的消息
-     * @param param	删除设置
-     * @param cb		执行结果回调函数
+     * @param msg  被删除的消息
+     * @param param  删除设置
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     removeQuickComment(msg: IMMessage, param: RemoveQuickCommentParam, cb: RemoveQuickCommentCallback | null): Promise<[NIMResCode, string]>;
     /** 查询快捷回复
-     * @param query_param	查询参数，一次最多只能查询20条消息的快捷回复
-     * @param cb		执行结果回调函数
+     * @param query_param  查询参数，一次最多只能查询20条消息的快捷回复
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     queryQuickCommentList(query_param: QueryQuickCommentsParam, cb: QueryQuickCommentCallback | null): Promise<[NIMResCode, QueryQuickCommentsResponse]>;
     /** PinMsg */
     /** Pin某条消息
-     * @param msg	要Pin的消息
-     * @param pin_info	Pin的内容 只需赋值 ext参数,其它参数SDK来补充
-     * @param cb		执行结果回调函数
+     * @param msg  要Pin的消息
+     * @param pin_info  Pin的内容 只需赋值 ext参数,其它参数SDK来补充
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     addPinMessage(msg: IMMessage, info: PinMessageInfo, cb: PinMessageCallback | null): Promise<[NIMResCode, string, number, PinMessageInfo]>;
     /** 取消Pin某条消息
-     * @param modify_param	UnPin Message 参数
-     * @param cb		执行结果回调函数
+     * @param modify_param  UnPin Message 参数
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     unPinMessage(modify_param: ModifyPinMessageParam, cb: UnPinMessageCallback | null): Promise<[NIMResCode, string, number, string]>;
     /** 更新 Pin Message ext字段
-     * @param modify_param	更新 Pin Message 参数
-     * @param cb		执行结果回调函数
+     * @param modify_param  更新 Pin Message 参数
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     updatePinMessage(modify_param: ModifyPinMessageParam, cb: UpdatePinMessageCallback | null): Promise<[NIMResCode, string, number, PinMessageInfo]>;
     /** 查询会话的所有 Pin Message
-     * @param session	会话ID
-     * @param to_type	会话类型
-     * @param cb		执行结果回调函数
+     * @param session  会话ID
+     * @param to_type  会话类型
+     * @param cb    执行结果回调函数
      * @return void 无返回值
      */
     queryAllPinMessage(session: string, to_type: number, cb: QueryPinMessageCallback | null): Promise<[NIMResCode, string, number, QueryAllPinMessageResponse]>;