node-nim 9.2.8-rc.1 → 9.3.0-rc.2

package/types/{def → nim_def}/session_def.d.ts

@@ -1,3 +1,4 @@
+import { NIMResCode } from './client_def';
 import { NIMMsgLogStatus, NIMMsgLogSubStatus, NIMMessageType, IMMessage } from './msglog_def';
 /** @enum NIMSessionType 会话类型 */
 export declare enum NIMSessionType {
@@ -21,74 +22,74 @@ export declare enum NIMSessionCommand {
     kNIMSessionCommandAllSuperTeamMsgDeleted = 11 /** < 所有超大群会话项的消息已删除 */
 }
 export interface SessionData {
-    id_: string; /**< 会话ID */
-    type_: NIMSessionType; /**< 会话类型 */
-    unread_count_: number; /**< 当前会话消息未读数 */
-    command_: NIMSessionCommand; /**< 会话修改命令 */
-    msg_id_: string; /**< 当前会话最新一条消息ID */
-    msg_sender_accid_: string; /**< 当前会话最新一条消息发送方ID */
-    msg_timetag_: number; /**< 当前会话最新一条消息时间戳（毫秒） */
-    msg_type_: NIMMessageType; /**< 当前会话最新一条消息类型 */
-    msg_content_: string; /**< 当前会话最新一条消息内容 */
-    msg_attach_: string; /**< 当前会话最新一条消息附件 */
-    msg_status_: NIMMsgLogStatus; /**< 当前会话最新一条消息状态 */
-    msg_sub_status_: NIMMsgLogSubStatus; /**< 当前会话最新一条消息子状态 */
-    last_updated_msg_: boolean; /**< (批量)消息变更或增加时是否是最后一条变更的信息 */
-    placed_on_top_: boolean; /**< 置顶标识 */
-    extend_data_: string; /**< 本地扩展字段,限制4096 */
-    is_robot_session_: boolean; /**< 是否为机器人会话, 默认为false */
-    stick_top_info_: StickTopSessionInfo; /**< 置顶信息 v7.6添加,推荐使用此字段代替 "placed_on_top_" 字段 */
+    id_?: string; /**< 会话ID */
+    type_?: NIMSessionType; /**< 会话类型 */
+    unread_count_?: number; /**< 当前会话消息未读数 */
+    command_?: NIMSessionCommand; /**< 会话修改命令 */
+    msg_id_?: string; /**< 当前会话最新一条消息ID */
+    msg_sender_accid_?: string; /**< 当前会话最新一条消息发送方ID */
+    msg_timetag_?: number; /**< 当前会话最新一条消息时间戳（毫秒） */
+    msg_type_?: NIMMessageType; /**< 当前会话最新一条消息类型 */
+    msg_content_?: string; /**< 当前会话最新一条消息内容 */
+    msg_attach_?: string; /**< 当前会话最新一条消息附件 */
+    msg_status_?: NIMMsgLogStatus; /**< 当前会话最新一条消息状态 */
+    msg_sub_status_?: NIMMsgLogSubStatus; /**< 当前会话最新一条消息子状态 */
+    last_updated_msg_?: boolean; /**< (批量)消息变更或增加时是否是最后一条变更的信息 */
+    placed_on_top_?: boolean; /**< 置顶标识 */
+    extend_data_?: string; /**< 本地扩展字段,限制4096 */
+    is_robot_session_?: boolean; /**< 是否为机器人会话, 默认为false */
+    stick_top_info_?: StickTopSessionInfo; /**< 置顶信息 v7.6添加,推荐使用此字段代替 "placed_on_top_" 字段 */
 }
 export interface StickTopSessionInfo {
-    top_: boolean; /**< 是否置顶 */
-    id_: string; /**< 会话ID */
-    type_: NIMSessionType; /**< 会话类型 */
-    ext_: string; /**< 扩展信息 */
-    create_time_: number; /**< 创建时间 */
-    update_time_: number; /**< 更新时间 */
+    top_?: boolean; /**< 是否置顶 */
+    id_?: string; /**< 会话ID */
+    type_?: NIMSessionType; /**< 会话类型 */
+    ext_?: string; /**< 扩展信息 */
+    create_time_?: number; /**< 创建时间 */
+    update_time_?: number; /**< 更新时间 */
 }
 export interface SessionDataList {
-    count_: number; /**< 会话列表项数量 */
-    unread_count_: number; /**< 会话列表总的未读消息数 */
-    sessions_: Array<SessionData>; /**< 会话列表项数据 */
+    count_?: number; /**< 会话列表项数量 */
+    unread_count_?: number; /**< 会话列表总的未读消息数 */
+    sessions_?: Array<SessionData>; /**< 会话列表项数据 */
 }
 export interface StickTopSession {
-    stick_top_info_: StickTopSessionInfo; /**< 置顶信息 */
-    session_data_: SessionData; /**< 会话信息 */
+    stick_top_info_?: StickTopSessionInfo; /**< 置顶信息 */
+    session_data_?: SessionData; /**< 会话信息 */
 }
 export interface MultiUnreadCountZeroInfo {
-    id_: string; /**< 会话ID */
-    type_: NIMSessionType; /**< 会话类型 */
+    id_?: string; /**< 会话ID */
+    type_?: NIMSessionType; /**< 会话类型 */
 }
 export interface StickTopSessionList {
-    sessions_: Array<StickTopSession>; /**< 置顶会话列表项数据 */
+    sessions_?: Array<StickTopSession>; /**< 置顶会话列表项数据 */
 }
 export interface SessionMainTagInfo {
-    session_id: string;
-    to_type: NIMSessionType;
+    session_id?: string;
+    to_type?: NIMSessionType;
 }
 export interface SessionRoamMsgHasMoreTagInfo {
-    session_tag_info: SessionMainTagInfo;
-    message_time_tag: number;
-    message_server_id: number;
+    session_tag_info?: SessionMainTagInfo;
+    message_time_tag?: number;
+    message_server_id?: number;
 }
-export declare type SessionChangeCallback = (rescode: number, result: SessionData, count: number) => void;
-export declare type DeleteSessionRoamingMessageCallback = (rescode: number, to_type: number, session_id: string) => void;
+export declare type SessionChangeCallback = (rescode: NIMResCode, result: SessionData, count: number) => void;
+export declare type DeleteSessionRoamingMessageCallback = (rescode: NIMResCode, to_type: number, session_id: string) => void;
 export declare type BadgeCountCallback = (result: string) => void;
 export declare type QuerySessionListCallback = (count: number, result: SessionDataList) => void;
-export declare type QuerySessionDataCallback = (rescode: number, result: SessionData) => void;
+export declare type QuerySessionDataCallback = (rescode: NIMResCode, result: SessionData) => void;
 export declare type SetToStickTopSessionNotifyCallback = (result: string) => void;
 export declare type CancelStickTopSessionNotifyCallback = (session_id: string, session_type: NIMSessionType) => void;
 export declare type UpdateStickTopSessionNotifyCallback = (result: string) => void;
-export declare type QueryStickTopSessionListCallback = (res_code: number, result: string) => void;
-export declare type SetToStickTopSessionCallback = (res_code: number, result: string) => void;
-export declare type UpdateStickTopSessionCallback = (res_code: number, result: string) => void;
-export declare type CancelToStickTopSessionCallback = (res_code: number, session_id: string, session_type: NIMSessionType) => void;
-export declare type QueryHasmoreRoammsgCallback = (res_code: number, info: SessionRoamMsgHasMoreTagInfo) => void;
-export declare type QueryAllHasmoreRoammsgCallback = (res_code: number, info_list: Array<SessionRoamMsgHasMoreTagInfo>) => void;
-export declare type UpdateHasmoreRoammsgCallback = (res_code: number) => void;
-export declare type DeleteHasmoreRoammsgCallback = (res_code: number) => void;
-export declare type SetMultiUnreadCountZeroAsyncCallback = (res_code: number, data_list: Array<SessionData>, unread_count: number) => void;
+export declare type QueryStickTopSessionListCallback = (res_code: NIMResCode, result: string) => void;
+export declare type SetToStickTopSessionCallback = (res_code: NIMResCode, result: string) => void;
+export declare type UpdateStickTopSessionCallback = (res_code: NIMResCode, result: string) => void;
+export declare type CancelToStickTopSessionCallback = (res_code: NIMResCode, session_id: string, session_type: NIMSessionType) => void;
+export declare type QueryHasmoreRoammsgCallback = (res_code: NIMResCode, info: SessionRoamMsgHasMoreTagInfo) => void;
+export declare type QueryAllHasmoreRoammsgCallback = (res_code: NIMResCode, info_list: Array<SessionRoamMsgHasMoreTagInfo>) => void;
+export declare type UpdateHasmoreRoammsgCallback = (res_code: NIMResCode) => void;
+export declare type DeleteHasmoreRoammsgCallback = (res_code: NIMResCode) => void;
+export declare type SetMultiUnreadCountZeroAsyncCallback = (res_code: NIMResCode, data_list: Array<SessionData>, unread_count: number) => void;
 export interface NIMSessionAPI {
     InitEventHandlers(): void;
     QueryStickTopSessionList(cb: QueryStickTopSessionListCallback): void;

package/types/nim_def/subscribe_event_def.d.ts

@@ -0,0 +1,83 @@
+import { NIMResCode } from './client_def';
+/** @enum NIMEventBroadcastType 事件广播类型 */
+export declare enum NIMEventBroadcastType {
+    kNIMEventBroadcastTypeOnline = 1 /** < 仅在线 */,
+    kNIMEventBroadcastTypeAll = 2 /** < 在线和离线 */
+}
+/** @enum NIMEventSyncType 事件同步类型 */
+export declare enum NIMEventSyncType {
+    kNIMEventSyncTypeNoSelf = 0 /** < 事件不同步给自己其他端 */,
+    kNIMEventSyncTypeSelf = 1 /** < 事件同步给自己其他端 */
+}
+/** @enum NIMEventSubscribeSyncEventType 订阅的事件的同步类型 */
+export declare enum NIMEventSubscribeSyncEventType {
+    kNIMEventSubscribeSyncTypeUnSync = 0 /** < 订阅后不同步最新事件 */,
+    kNIMEventSubscribeSyncTypeSync = 1 /** < 订阅后立即同步最新事件 */
+}
+/** @enum NIMEventType 服务器预定义的事件类型 */
+export declare enum NIMEventType {
+    kNIMEventTypeOnlineState = 1 /** < 在线状态事件(客户端可发送) */,
+    kNIMEventTypeCustom = 100000 /** < 服务器保留1～99999的事件类型，客户端自定义事件类型需大于99999 */
+}
+/** @enum NIMEventOnlineStateValue 在线状态事件值 */
+export declare enum NIMEventOnlineStateValue {
+    kNIMEventOnlineStateValueLogin = 1 /** < 登录 */,
+    kNIMEventOnlineStateValueLogout = 2 /** < 登出 */,
+    kNIMEventOnlineStateValueDisconnect = 3 /** < 断开连接 */,
+    kNIMEventOnlineStateValueCustom = 10000 /** < 在线状态事件服务器保留1～9999的事件值，客户端自定义事件值需大于9999 */,
+    kNIMEventOnlineStateValueUpdateConfig = 10001 /** < 自己的其他端更新了自己端的multi_config信息 */
+}
+export declare enum NIMOnlineState {
+    kOnlineStateOnline = 0,
+    kOnlineStateBusy = 1,
+    kOnlineStateLeave = 2
+}
+export declare enum NIMNetState {
+    kNetStateUnknow = 0,
+    kNetStateWifi = 1,
+    kNetStateWwan = 2,
+    kNetState2G = 3,
+    kNetState3G = 4,
+    kNetState4G = 5
+}
+export interface EventData {
+    event_type_?: number; /**< 事件类型，服务器保留1～99999的事件类型，客户端自定义事件类型需大于99999 */
+    event_value_?: number; /**< 事件状态，在线状态事件服务器保留1～9999的事件值，客户端自定义事件值需大于9999 */
+    client_msg_id_?: string; /**< 客户端生成的消息id */
+    config_?: string; /**< 用户自定义事件扩展属性，最长4K */
+    ttl_?: number; /**< 事件有效期，单位：秒，时间范围：60s到7天 */
+    broadcast_type_?: NIMEventBroadcastType; /**< 事件广播类型 */
+    sync_self_?: NIMEventSyncType; /**< 事件同步类型 */
+    readonly_ttl_type?: number; /**< TtlType枚举值 */
+    readonly_durable_?: number; /**< 是否需要持久化(可选字段)，默认为需要持久化,0:不需要持久化，1：需要持久化 */
+    readonly_event_time_?: number; /**< 事件发布的时间戳，服务器补充 */
+    readonly_server_msg_id_?: string; /**< 服务端生成的消息id */
+    readonly_client_type_?: number; /**< 发送客户端类型 */
+    readonly_nim_config_?: string; /**< 预定义事件的扩展字段（在线状态事件：在线的客户端类型Json） */
+    readonly_multi_config_?: string; /**< 多端配置信息字段，JSON格式{"clent_type":"clent_config","1":"xxx","2":"xxx"} */
+    readonly_publisher_accid_?: string; /**< 事件发布者的accid */
+    readonly_consid_?: string; /**< 发送设备id */
+}
+export interface EventSubscribeData {
+    event_type_?: number; /**< 事件类型 */
+    ttl_?: number; /**< 订阅有效期，单位：秒，范围：60s到30天 */
+    sync_event_?: NIMEventSubscribeSyncEventType; /**< 订阅的事件的同步类型 */
+    publisher_accid_?: string; /**< 被订阅人（事件发布人）的accid */
+    subscribe_accid_?: string; /**< 订阅人的accid */
+    subscribe_time_?: number; /**< 订阅时间戳 */
+}
+export declare type PushEventCallback = (rescode: NIMResCode, result: EventData) => void;
+export declare type BatchPushEventCallback = (rescode: NIMResCode, result: Array<EventData>) => void;
+export declare type PublishEventCallback = (rescode: NIMResCode, eventType: number, result: EventData) => void;
+export declare type SubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
+export declare type UnSubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
+export declare type BatchUnSubscribeEventCallback = (rescode: NIMResCode, eventType: number) => void;
+export declare type QuerySubscribeEventCallback = (rescode: NIMResCode, eventType: number, result: Array<EventSubscribeData>) => void;
+export interface NIMSubscribeEventAPI {
+    InitEventHandlers(): void;
+    Publish(data: EventData, cb: PublishEventCallback, jsonExtension: string): boolean;
+    Subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback, jsonExtension: string): boolean;
+    UnSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback, jsonExtension: string): boolean;
+    BatchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback, jsonExtension: string): boolean;
+    QuerySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback, jsonExtension: string): void;
+}

package/types/{def → nim_def}/super_team_def.d.ts

@@ -54,47 +54,47 @@ export declare enum NIMSuperTeamMuteType {
     kNIMSuperTeamMuteTypeAllMute = 3 /**< 全部禁言 */
 }
 export interface SuperTeamEvent {
-    res_code_: NIMResCode; /**< 错误码 */
-    notification_id_: NIMNotificationId; /**< 通知类型ID */
-    team_id_: string; /**< 群组ID */
-    ids_: Array<string>; /**< 通知可能涉及到的群成员ID */
-    invalid_ids_: Array<string>; /**< 通知可能涉及到的失效的群成员ID，比如邀请入群的成员的群数量超限导致当次邀请失败 */
-    namecards_: Array<UserNameCard>; /**< 通知可能涉及到的群成员的用户名片 */
-    team_info_: SuperTeamInfo; /**< 通知可能涉及到的群信息 */
-    member_property_: SuperTeamMemberProperty; /**< 群成员属性 */
-    opt_: boolean; /**< 操作 */
-    attach_: string; /**< 扩展字段,目前仅kick和invite事件可选 */
-    src_data_: string; /**< 未解析过的原信息，目前仅支持群消息未读数相关事件 */
+    res_code_?: NIMResCode; /**< 错误码 */
+    notification_id_?: NIMNotificationId; /**< 通知类型ID */
+    team_id_?: string; /**< 群组ID */
+    ids_?: Array<string>; /**< 通知可能涉及到的群成员ID */
+    invalid_ids_?: Array<string>; /**< 通知可能涉及到的失效的群成员ID，比如邀请入群的成员的群数量超限导致当次邀请失败 */
+    namecards_?: Array<UserNameCard>; /**< 通知可能涉及到的群成员的用户名片 */
+    team_info_?: SuperTeamInfo; /**< 通知可能涉及到的群信息 */
+    member_property_?: SuperTeamMemberProperty; /**< 群成员属性 */
+    opt_?: boolean; /**< 操作 */
+    attach_?: string; /**< 扩展字段,目前仅kick和invite事件可选 */
+    src_data_?: string; /**< 未解析过的原信息，目前仅支持群消息未读数相关事件 */
 }
 export interface SuperTeamInfoJsonValue {
-    tid: string;
-    name: string;
-    member_max_count: number;
-    prop: string;
-    intro: string;
-    announcement: string;
-    join_mode: NIMSuperTeamJoinMode;
-    custom: string;
-    icon: string;
-    be_invite_mode: NIMSuperTeamBeInviteMode;
-    invite_mode: NIMSuperTeamInviteMode;
-    update_info_mode: NIMSuperTeamUpdateInfoMode;
-    update_custom_mode: NIMSuperTeamUpdateCustomMode;
-    mute_type: NIMSuperTeamMuteType;
+    tid?: string;
+    name?: string;
+    member_max_count?: number;
+    prop?: string;
+    intro?: string;
+    announcement?: string;
+    join_mode?: NIMSuperTeamJoinMode;
+    custom?: string;
+    icon?: string;
+    be_invite_mode?: NIMSuperTeamBeInviteMode;
+    invite_mode?: NIMSuperTeamInviteMode;
+    update_info_mode?: NIMSuperTeamUpdateInfoMode;
+    update_custom_mode?: NIMSuperTeamUpdateCustomMode;
+    mute_type?: NIMSuperTeamMuteType;
 }
 export interface SuperTeamInfo {
-    team_info_json_value_: SuperTeamInfoJsonValue;
+    team_info_json_value_?: SuperTeamInfoJsonValue;
 }
 export interface SuperTeamMemberPropertyJsonValue {
-    tid: string;
-    type: NIMSuperTeamUserType;
-    nick: string;
-    bits: number;
-    mute: number;
-    custom: string;
+    tid?: string;
+    type?: NIMSuperTeamUserType;
+    nick?: string;
+    bits?: number;
+    mute?: number;
+    custom?: string;
 }
 export interface SuperTeamMemberProperty {
-    member_info_json_value_: SuperTeamMemberPropertyJsonValue;
+    member_info_json_value_?: SuperTeamMemberPropertyJsonValue;
 }
 export declare type SuperTeamEventCallback = (result: SuperTeamEvent) => void;
 export declare type QueryAllMySuperTeamsCallback = (count: number, result: Array<string>) => void;
@@ -103,7 +103,7 @@ export declare type QuerySuperTeamMyAllMemberInfosCallback = (count: number, res
 export declare type QuerySuperTeamMembersCallback = (tid: string, count: number, result: Array<SuperTeamMemberProperty>) => void;
 export declare type QuerySuperTeamMemberCallback = (result: SuperTeamMemberProperty) => void;
 export declare type QuerySuperTeamInfoCallback = (tid: string, result: SuperTeamInfo) => void;
-export declare type QuerySuperTeamMembersOnlineCallback = (rescode: number, count: number, result: Array<SuperTeamMemberProperty>) => void;
+export declare type QuerySuperTeamMembersOnlineCallback = (rescode: NIMResCode, count: number, result: Array<SuperTeamMemberProperty>) => void;
 export interface NIMSuperTeamAPI {
     InitEventHandlers(): void;
     InviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;

package/types/{def → nim_def}/sysmsg_def.d.ts

@@ -25,36 +25,36 @@ export declare enum NIMSysMsgType {
     kNIMSysMsgTypeUnknown = 1000 /** < 未知类型，本地使用，发送时勿使用，作为默认 */
 }
 export interface SysMessage {
-    timetag_: number; /**< 通知时间戳（毫秒） */
-    type_: NIMSysMsgType; /**< 通知类型 */
-    receiver_accid_: string; /**< 接收者ID */
-    sender_accid_: string; /**< 发送者ID */
-    content_: string; /**< 只读，SDK不转发该字段 */
-    attach_: string; /**< 通知附件 */
-    id_: number; /**< 通知ID */
-    status_: NIMSysMsgStatus; /**< 通知状态 */
-    msg_setting_: SysMessageSetting; /**< 消息属性设置 */
-    rescode_: NIMResCode; /**< 通知错误码 */
-    feature_: NIMMessageFeature; /**< 通知属性 */
-    total_unread_count_: number; /**< 总计的通知未读数 */
-    client_msg_id_: string; /**< 通知ID（客户端） */
-    callbac_ext_: string; /**< v8.2.0 第三方回调返回的自定义字段 */
+    timetag_?: number; /**< 通知时间戳（毫秒） */
+    type_?: NIMSysMsgType; /**< 通知类型 */
+    receiver_accid_?: string; /**< 接收者ID */
+    sender_accid_?: string; /**< 发送者ID */
+    content_?: string; /**< 只读，SDK不转发该字段 */
+    attach_?: string; /**< 通知附件 */
+    id_?: number; /**< 通知ID */
+    status_?: NIMSysMsgStatus; /**< 通知状态 */
+    msg_setting_?: SysMessageSetting; /**< 消息属性设置 */
+    rescode_?: NIMResCode; /**< 通知错误码 */
+    feature_?: NIMMessageFeature; /**< 通知属性 */
+    total_unread_count_?: number; /**< 总计的通知未读数 */
+    client_msg_id_?: string; /**< 通知ID（客户端） */
+    callbac_ext_?: string; /**< v8.2.0 第三方回调返回的自定义字段 */
 }
 export interface SysMessageSetting {
-    need_push_: BoolStatus; /**< 是否需要推送 */
-    push_need_badge_: BoolStatus; /**< 是否要做消息计数 */
-    push_need_prefix_: BoolStatus; /**< 需要推送昵称 */
-    need_offline_: BoolStatus; /**< 是否支持离线消息 */
-    push_payload_: object; /**< 第三方自定义的推送属性，长度2048 */
-    push_content_: string; /**< 自定义推送文案，长度限制200字节 */
-    anti_spam_enable_: BoolStatus; /**< (功能暂时不开放)是否需要过易盾反垃圾 */
-    anti_spam_content_: string; /**< (功能暂时不开放)(可选)开发者自定义的反垃圾字段 */
-    env_config_: string; /**< (可选) 指向自定义抄送的配置 */
+    need_push_?: BoolStatus; /**< 是否需要推送 */
+    push_need_badge_?: BoolStatus; /**< 是否要做消息计数 */
+    push_need_prefix_?: BoolStatus; /**< 需要推送昵称 */
+    need_offline_?: BoolStatus; /**< 是否支持离线消息 */
+    push_payload_?: object; /**< 第三方自定义的推送属性，长度2048 */
+    push_content_?: string; /**< 自定义推送文案，长度限制200字节 */
+    anti_spam_enable_?: BoolStatus; /**< (功能暂时不开放)是否需要过易盾反垃圾 */
+    anti_spam_content_?: string; /**< (功能暂时不开放)(可选)开发者自定义的反垃圾字段 */
+    env_config_?: string; /**< (可选) 指向自定义抄送的配置 */
 }
 export declare type SysmsgCallback = (result: SysMessage) => void;
 export declare type SendCustomSysmsgCallback = (result: SendMessageArc) => void;
-export declare type NotifySingleSysmsgCallback = (res_code: number, msg_id: number, unread_count: number) => void;
-export declare type NotifySysmsgResCallback = (res_code: number, unread_count: number) => void;
+export declare type NotifySingleSysmsgCallback = (res_code: NIMResCode, msg_id: number, unread_count: number) => void;
+export declare type NotifySysmsgResCallback = (res_code: NIMResCode, unread_count: number) => void;
 export declare type QuerySysmsgCallback = (count: number, unread_count: number, result: Array<SysMessage>) => void;
 export interface NIMSysMsgAPI {
     InitEventHandlers(): void;

package/types/{def → nim_def}/talk_def.d.ts

@@ -2,38 +2,38 @@ import { NIMResCode } from './client_def';
 import { IMMessage, NIMMessageFeature, NIMMessageType } from './msglog_def';
 import { NIMSessionType } from './session_def';
 export interface SendMessageArc {
-    talk_id_: string; /**< 会话ID */
-    msg_id_: string; /**< 消息ID */
-    rescode_: NIMResCode; /**< 错误码 */
-    msg_timetag_: number; /**< 消息时间戳 */
-    third_party_callback_ext_: string; /**< 第三方回调回来的自定义扩展字段 */
-    anti_spam_res_: string; /**< 易盾反垃圾返回的结果字段*/
+    talk_id_?: string; /**< 会话ID */
+    msg_id_?: string; /**< 消息ID */
+    rescode_?: NIMResCode; /**< 错误码 */
+    msg_timetag_?: number; /**< 消息时间戳 */
+    third_party_callback_ext_?: string; /**< 第三方回调回来的自定义扩展字段 */
+    anti_spam_res_?: string; /**< 易盾反垃圾返回的结果字段*/
 }
 export interface BroadcastMessage {
-    body_: string;
-    time_: number;
-    id_: number;
-    from_id_: string;
+    body_?: string;
+    time_?: number;
+    id_?: number;
+    from_id_?: string;
 }
 export interface RecallMsgNotify {
-    from_id_: string; /**< 消息发送方ID */
-    to_id_: string; /**< 消息接收方ID */
-    msg_id_: string; /**< 客户端消息ID */
-    notify_: string; /**< 自定义通知文案 */
-    from_nick_: string; /**< 消息发送方昵称 */
-    operator_id_: string; /**< 消息的操作者，比哪谁撤消了消息 */
-    session_type_: NIMSessionType; /**< 会话类型 */
-    notify_timetag_: number; /**< 通知时间戳 */
-    notify_feature_: NIMMessageFeature; /**< 通知的种类 */
-    msglog_exist_: boolean; /**< 客户端消息本地是否存在 */
-    msglog_timetag_: number; /**< 撤回的消息的消息时间戳 */
-    attach_: string; /**< v8.2.0 透传的附件信息 */
-    callback_ext_: string; /**< v8.2.0 第三方回调返回的字定义字段 */
+    from_id_?: string; /**< 消息发送方ID */
+    to_id_?: string; /**< 消息接收方ID */
+    msg_id_?: string; /**< 客户端消息ID */
+    notify_?: string; /**< 自定义通知文案 */
+    from_nick_?: string; /**< 消息发送方昵称 */
+    operator_id_?: string; /**< 消息的操作者，比哪谁撤消了消息 */
+    session_type_?: NIMSessionType; /**< 会话类型 */
+    notify_timetag_?: number; /**< 通知时间戳 */
+    notify_feature_?: NIMMessageFeature; /**< 通知的种类 */
+    msglog_exist_?: boolean; /**< 客户端消息本地是否存在 */
+    msglog_timetag_?: number; /**< 撤回的消息的消息时间戳 */
+    attach_?: string; /**< v8.2.0 透传的附件信息 */
+    callback_ext_?: string; /**< v8.2.0 第三方回调返回的字定义字段 */
 }
 export declare type SendMsgAckCallback = (result: SendMessageArc) => void;
 export declare type ReceiveMsgCallback = (result: IMMessage) => void;
 export declare type ReceiveMsgsCallback = (result: Array<IMMessage>) => void;
-export declare type RecallMsgsCallback = (rescode: number, result: Array<RecallMsgNotify>) => void;
+export declare type RecallMsgsCallback = (rescode: NIMResCode, result: Array<RecallMsgNotify>) => void;
 export declare type ReceiveBroadcastMsgCallback = (result: BroadcastMessage) => void;
 export declare type ReceiveBroadcastMsgsCallback = (result: Array<BroadcastMessage>) => void;
 export declare type TeamNotificationFilterCallback = (result: IMMessage) => boolean;

package/types/nim_def/talkex_def.d.ts

@@ -0,0 +1,112 @@
+import { NIMResCode } from './client_def';
+import { IMMessage } from './msglog_def';
+import { NIMSessionType } from './session_def';
+export interface CollectInfo {
+    id?: number; /**< id */
+    type?: number; /**< number 类型,开发者可根据业务自定义其含意 */
+    data?: string; /**<数据,string,最大20480 */
+    ext?: string; /**< 扩展字段,string,最大1024 */
+    unique_id?: string; /**< 去重唯一ID */
+    create_time?: number; /**<创建时间 */
+    update_time?: number; /**< 更新时间 */
+}
+export interface CollectInfoList {
+    list?: Array<CollectInfo>;
+}
+export interface RemoveCollectsParm {
+    list?: Array<MatchCollectParm>;
+}
+export interface MatchCollectParm {
+    create_time?: number; /**<创建时间 */
+    id?: number; /**< id */
+}
+export interface QueryCollectsParm {
+    from_time?: number; /**<起始时间,默认0 */
+    to_time?: number; /**<结束时间,推荐当前时间+1小时 */
+    exclude_id?: number; /**<结束查询的最后一条收藏的id(不包含在查询结果中)缺省 可填0 */
+    limit?: number; /**< 本次查询的上限(最多100条) */
+    reverse?: boolean; /**<反向查询(按时间正序起查，正序排列)，false：按时间逆序起查，逆序排列（建议默认为false） */
+    type?: number; /**< 收藏类型，缺省表示所有类型 */
+}
+export interface QuickCommentInfo {
+    id?: string; /** <服务端没有这个字段，本地为了好处理记录加上的(message serverid + from_accid + type) */
+    from_account?: string;
+    reply_type?: number; /**< 开发者自定义的回复类型 */
+    client_id?: string; /**< 被回复消息的客户端ID */
+    server_id?: number; /**< 被回复消息的服务端ID */
+    time?: number; /**< 回复的时间戳 */
+    ext?: string; /**< 自定义扩展字段，最大8字符 */
+    need_push?: boolean; /**< 是否需要推送，0表示不需要，1表示需要，默认0 */
+    need_badge?: boolean; /**<  是否需要角标，0表示不需要，1表示需要，默认0 */
+    push_title?: string; /**<  推送标题 */
+    push_content?: string; /**<  推送文案 */
+    push_payload?: string; /**<  推送自定义字段JSON */
+}
+export interface RemoveQuickCommentParam {
+    id?: string; /**< string 服务端没有这个字段，本地为了好处理记录加上的 */
+    reply_type?: number; /**< number 开发者自定义的回复类型 */
+    ext?: string; /**< string 取消操作的扩展字段 */
+}
+export interface QueryQuickCommentsParam {
+    message_list?: Array<IMMessage>; /**< list 要查询的消息 一次最多查询20条 */
+}
+export interface QueryQuickCommentsResponseItem {
+    message_client_id?: string;
+    quick_comment_list?: Array<QuickCommentInfo>;
+}
+export interface QueryQuickCommentsResponse {
+    message_quick_comment_list?: Array<QueryQuickCommentsResponseItem>;
+}
+export interface PinMessageInfo {
+    id?: string; /**< Pin Message的ID 客户端生成服务端没有 */
+    session_id?: string; /**< Pin Message对应的会话ID (客户端数据) */
+    server_id?: number; /**< 被 Pin 消息的服务端ID */
+    client_id?: string; /**< 被 pin 消息的客户商dID */
+    to_type?: number; /**< 被 pin 消息的会话类型 */
+    from_account?: string; /**< 被 pin 消息的发送方ID */
+    to_account?: string; /**< 被 pin 消息的接收方ID */
+    message_time?: number; /**< 被 pin 消息的时间戳 */
+    operator_account?: string; /**< Pin Message的操作者ID */
+    ext?: string; /**< Pin Message的扩展字段 */
+    create_time?: number; /**< Pin Message的创建时间戳 */
+    update_time?: number; /**< Pin Message的更新时间戳 */
+}
+export interface ModifyPinMessageParam {
+    session?: string; /**< UnPin 消息所属会话 */
+    to_type?: number; /**< UnPin 消息所属会话类型 */
+    id?: string; /**< Pin Message 的ID 客户端生成服务端没有 */
+    ext?: string; /**< 扩展字段 */
+}
+export interface QueryAllPinMessageResponse {
+    pin_list?: Array<PinMessageInfo>;
+}
+export declare type AddCollectCallback = (rescode: NIMResCode, info: CollectInfo) => void;
+export declare type RemoveCollectsCallback = (rescode: NIMResCode, count: number) => void;
+export declare type UpdateCollectCallback = (rescode: NIMResCode, info: CollectInfo) => void;
+export declare type QueryCollectsCallback = (rescode: NIMResCode, count: number, info: CollectInfoList) => void;
+export declare type AddQuickCommentCallback = (rescode: NIMResCode, info: QuickCommentInfo) => void;
+export declare type RemoveQuickCommentCallback = (rescode: NIMResCode, id: string) => void;
+export declare type QueryQuickCommentCallback = (rescode: NIMResCode, res: QueryQuickCommentsResponse) => void;
+export declare type AddQuickCommentNotifyCallback = (session: string, to_type: NIMSessionType, msg_client_id: string, qc_info: QuickCommentInfo) => void;
+export declare type RemoveQuickCommentNotifyCallback = (session: string, to_type: NIMSessionType, msg_client_id: string, quick_comment_id: string, ext: string) => void;
+export declare type PinMessageCallback = (rescode: NIMResCode, session: string, to_type: number, info: PinMessageInfo) => void;
+export declare type UnPinMessageCallback = (rescode: NIMResCode, session: string, to_type: number, id: string) => void;
+export declare type UpdatePinMessageCallback = (rescode: NIMResCode, session: string, to_type: number, info: PinMessageInfo) => void;
+export declare type QueryPinMessageCallback = (rescode: NIMResCode, session: string, to_type: number, res: QueryAllPinMessageResponse) => void;
+export declare type AddPinMessageNotifyCallback = (session: string, to_type: number, info: PinMessageInfo) => void;
+export declare type UnPinMessageNotifyCallback = (session: string, to_type: number, id: string) => void;
+export declare type UpdatePinMessageNotifyCallback = (session: string, to_type: number, info: PinMessageInfo) => void;
+export interface NIMTalkExAPI {
+    InitEventHandlers(): void;
+    AddCollect(collect_info: CollectInfo, cb: AddCollectCallback): void;
+    RemoveCollects(collect_list: RemoveCollectsParm, cb: RemoveCollectsCallback): void;
+    UpdateCollectExt(collect_match_param: MatchCollectParm, ext: string, cb: UpdateCollectCallback): void;
+    QueryCollectList(query_collect_list_param: QueryCollectsParm, cb: QueryCollectsCallback): void;
+    AddQuickComment(msg: IMMessage, info: QuickCommentInfo, cb: AddQuickCommentCallback): void;
+    RemoveQuickComment(msg: IMMessage, param: RemoveQuickCommentParam, cb: RemoveQuickCommentCallback): void;
+    QueryQuickCommentList(query_param: QueryQuickCommentsParam, cb: QueryQuickCommentCallback): void;
+    AddPinMessage(msg: IMMessage, info: PinMessageInfo, cb: PinMessageCallback): void;
+    UnPinMessage(modify_param: ModifyPinMessageParam, cb: UnPinMessageCallback): void;
+    UpdatePinMessage(modify_param: ModifyPinMessageParam, cb: UpdatePinMessageCallback): void;
+    QueryAllPinMessage(session: string, to_type: number, cb: QueryPinMessageCallback): void;
+}