node-nim 7.8.3 → 9.1.0-rc.3

package/types/api/sysmsg.d.ts

@@ -0,0 +1,104 @@
+/// <reference types="node" />
+import ev from 'events';
+import { NIMSysMsgAPI, SysMessage, NIMSysMsgStatus, NIMSysMsgType, NotifySingleSysmsgCallback, NotifySysmsgResCallback, QuerySysmsgCallback } from '../def/sysmsg_def';
+export declare interface NIMSysMsg {
+    on(event: 'receiveSystemMsg', listener: () => void): this;
+    on(event: 'sendCustomSystemMsg', listener: () => void): this;
+    once(event: 'receiveSystemMsg', listener: () => void): this;
+    once(event: 'sendCustomSystemMsg', listener: () => void): this;
+}
+export declare class NIMSysMsg extends ev.EventEmitter {
+    sysmsg: NIMSysMsgAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 发送自定义通知消息
+       * @param json_msg		消息体Json, 可以通过CreateCustomNotificationMsg方法自动创建
+       * @return void 无返回值
+       */
+    sendCustomNotificationMsg(msg: SysMessage): void;
+    /** 查询本地系统消息
+       * @param limit_count	一次查询数量，建议20
+       * @param last_time	上次查询最后一条消息的时间戳
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			查询本地系统消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       */
+    queryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback, jsonExtension: string): boolean;
+    /** 查询未读消息数
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			查询未读消息数的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    queryUnreadCount(cb: NotifySysmsgResCallback, jsonExtension: string): void;
+    /** 设置消息状态
+       * @param msg_id		消息id
+       * @param status		消息状态
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			设置消息状态的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setStatusAsync(msg_id: number, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
+    /** 设置全部消息为已读
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			设置全部消息为已读的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    readAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): void;
+    /** 删除消息
+       * @param msg_id		消息id
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			删除消息的回调函数
+       * @return bool 检查参数如果不符合要求则返回失败
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteAsync(msg_id: number, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
+    /** 全部删除
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			删除消息的回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+    /** 按类型设置系统通知状态
+       * @param type 类型
+       * @param status 状态
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    setStatusByTypeAsync(type: NIMSysMsgType, status: NIMSysMsgStatus, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+    /** 按类型删除系统通知
+       * @param type 类型
+       * @param jsonExtension json扩展参数（备用，目前不需要）
+       * @param cb			回调函数
+       * @return void 无返回值
+       * @note
+       * <pre>
+       * 200:成功
+       * </pre>
+       */
+    deleteByTypeAsync(type: NIMSysMsgType, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+}

package/types/api/talk.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+import ev from 'events';
+import { IMMessage, NIMMessageType } from '../def/msglog_def';
+import { NIMTalkAPI, RecallMsgsCallback } from '../def/talk_def';
+export declare interface NIMTalk {
+    on(event: 'sendMsg', listener: () => void): this;
+    on(event: 'receiveMsg', listener: () => void): this;
+    on(event: 'receiveMsgs', listener: () => void): this;
+    on(event: 'filterNotification', listener: () => void): this;
+    on(event: 'filterMsg', listener: () => void): this;
+    on(event: 'recallMsgs', listener: () => void): this;
+    on(event: 'receiveBroadcastMsg', listener: () => void): this;
+    on(event: 'receiveBroadcastMsgs', listener: () => void): this;
+    once(event: 'sendMsg', listener: () => void): this;
+    once(event: 'receiveMsg', listener: () => void): this;
+    once(event: 'receiveMsgs', listener: () => void): this;
+    once(event: 'filterNotification', listener: () => void): this;
+    once(event: 'filterMsg', listener: () => void): this;
+    once(event: 'recallMsgs', listener: () => void): this;
+    once(event: 'receiveBroadcastMsg', listener: () => void): this;
+    once(event: 'receiveBroadcastMsgs', listener: () => void): this;
+}
+export declare class NIMTalk extends ev.EventEmitter {
+    talk: NIMTalkAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 发送消息
+       * @param json_msg		消息体Json字符串,可以通过CreateXXXMessage方法自动创建
+       * @param jsonExtension json扩展参数（备用,目前不需要）
+       * @param pcb		上传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+       * @return void 无返回值
+       */
+    sendMsg(msg: IMMessage, jsonExtension: string): void;
+    /** 停止正在发送中的消息（目前只支持发送文件消息时的终止）
+       * @param client_msg_id	停止发送的消息客户端id
+       * @param type			停止发送的消息类型
+       * @param jsonExtension json扩展参数（备用,目前不需要）
+       * @return void 无返回值
+       */
+    stopSendMsg(clientMsgId: string, type: NIMMessageType, jsonExtension: string): void;
+    /** 撤回消息
+       * @param msg 消息
+       * @param notify_msg 自定义通知消息
+       * @param cb	回调
+       * @param param 额外的参数，包含apnstext、pushpayload、jsonExtension、env_config、user_data
+       * @note
+       * <pre>
+       * 200:成功
+       * 414:参数错误
+       * 508:撤回时间超过配制有效期，默认是2分钟
+       * 10414:本地错误码，参数错误
+       * 10508:本地错误码,超过配置有效期或者所需参数不存在
+       * </pre>
+       */
+    recallMsg(msg: IMMessage, notify_msg: string, cb: RecallMsgsCallback, apnstext: string, pushpayloadconst: string, jsonExtension: string): void;
+    /** 从消息体中获取附件（图片、语音、视频等）的本地路径
+       *  @param  msg	消息
+       *  @return string	消息如果有附件，不管是否已下载，返回附件的本地路径；消息如果没有附件，返回空字符串。
+       */
+    getAttachmentPathFromMsg(msg: IMMessage): string;
+    /** 回复消息thread 聊天场景
+       * @param msg	被回复消息的消息体
+       * @param json_reply_msg	回复消息的消息体,可通过各种createxxxmessage接口创建
+       * @param prg_cb		传进度的回调函数, 如果发送的消息里包含了文件资源,则通过此回调函数通知上传进度
+       * @return void 无返回值
+       */
+    replyMessage(msg: IMMessage, json_reply_msg: string): void;
+}

package/types/api/talkex.d.ts

@@ -0,0 +1,93 @@
+/// <reference types="node" />
+import ev from 'events';
+import { NIMTalkExAPI, CollectInfo, AddCollectCallback, RemoveCollectsParm, RemoveCollectsCallback, MatchCollectParm, UpdateCollectCallback, QueryCollectsParm, QueryCollectsCallback, QuickCommentInfo, AddQuickCommentCallback, RemoveQuickCommentParam, RemoveQuickCommentCallback, QueryQuickCommentsParam, QueryQuickCommentCallback, PinMessageInfo, PinMessageCallback, ModifyPinMessageParam, UnPinMessageCallback, UpdatePinMessageCallback, QueryPinMessageCallback } from '../def/talkex_def';
+import { IMMessage } from '../def/msglog_def';
+export declare interface NIMTalkEx {
+    on(event: 'addQuickComment', listener: () => void): this;
+    on(event: 'removeQuickComment', listener: () => void): this;
+    on(event: 'pin', listener: () => void): this;
+    on(event: 'unpin', listener: () => void): this;
+    on(event: 'updatePin', listener: () => void): this;
+    once(event: 'addQuickComment', listener: () => void): this;
+    once(event: 'removeQuickComment', listener: () => void): this;
+    once(event: 'pin', listener: () => void): this;
+    once(event: 'unpin', listener: () => void): this;
+    once(event: 'updatePin', listener: () => void): this;
+}
+export declare class NIMTalkEx extends ev.EventEmitter {
+    talkex: NIMTalkExAPI;
+    constructor();
+    /** 注册全局回调 */
+    initEventHandlers(): void;
+    /** 添加收藏
+       * @param collect_info	收藏内容
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    addCollect(collect_info: CollectInfo, cb: AddCollectCallback): void;
+    /** 批量删除收藏
+       * @param collect_list	要删除的收藏列表
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    removeCollects(collect_list: RemoveCollectsParm, cb: RemoveCollectsCallback): void;
+    /** 更新收藏扩展字段
+       * @param collect_match_param	根据收藏的id 与 create time去匹配收藏内容
+       * @param ext	收藏的扩展字段内容
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    updateCollectExt(collect_match_param: MatchCollectParm, ext: string, cb: UpdateCollectCallback): void;
+    /** 分页查询收藏列表
+       * @param query_collect_list_param	 查询参数
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    queryCollectList(query_collect_list_param: QueryCollectsParm, cb: QueryCollectsCallback): void;
+    /** 添加快捷回复
+       * @param msg	被回复的消息
+       * @param info	回复的内容及设置
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    addQuickComment(msg: IMMessage, info: QuickCommentInfo, cb: AddQuickCommentCallback): void;
+    /** 删除快捷回复
+       * @param msg	被删除的消息
+       * @param param	删除设置
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    removeQuickComment(msg: IMMessage, param: RemoveQuickCommentParam, cb: RemoveQuickCommentCallback): void;
+    /** 查询快捷回复
+       * @param query_param	查询参数，一次最多只能查询20条消息的快捷回复
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    queryQuickCommentList(query_param: QueryQuickCommentsParam, cb: QueryQuickCommentCallback): void;
+    /** Pin某条消息
+       * @param msg	要Pin的消息
+       * @param pin_info	Pin的内容 只需赋值 ext参数,其它参数SDK来补充
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    addPinMessage(msg: IMMessage, info: PinMessageInfo, cb: PinMessageCallback): void;
+    /** 取消Pin某条消息
+       * @param modify_param	UnPin Message 参数
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    unPinMessage(modify_param: ModifyPinMessageParam, cb: UnPinMessageCallback): void;
+    /** 更新 Pin Message ext字段
+       * @param modify_param	更新 Pin Message 参数
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    updatePinMessage(modify_param: ModifyPinMessageParam, cb: UpdatePinMessageCallback): void;
+    /** 查询会话的所有 Pin Message
+       * @param session	会话ID
+       * @param to_type	会话类型
+       * @param cb		执行结果回调函数
+       * @return void 无返回值
+       */
+    queryAllPinMessage(session: string, to_type: number, cb: QueryPinMessageCallback): void;
+}