node-nim 7.8.3 → 9.1.0-rc.1

package/types/def/subscribe_event_def.d.ts

@@ -0,0 +1,82 @@
+/** @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
+}
+/** @enum NIMEventOnlineStateValue 在线状态事件值 */
+export declare enum NIMEventOnlineStateValue {
+    kNIMEventOnlineStateValueLogin = 1,
+    kNIMEventOnlineStateValueLogout = 2,
+    kNIMEventOnlineStateValueDisconnect = 3,
+    kNIMEventOnlineStateValueCustom = 10000,
+    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: number, result: EventData) => void;
+export declare type BatchPushEventCallback = (rescode: number, result: Array<EventData>) => void;
+export declare type PublishEventCallback = (rescode: number, eventType: number, result: EventData) => void;
+export declare type SubscribeEventCallback = (rescode: number, eventType: number, failedList: Array<string>) => void;
+export declare type UnSubscribeEventCallback = (rescode: number, eventType: number, failedList: Array<string>) => void;
+export declare type BatchUnSubscribeEventCallback = (rescode: number, eventType: number) => void;
+export declare type QuerySubscribeEventCallback = (rescode: number, 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/super_team_def.d.ts

@@ -0,0 +1,133 @@
+import { NIMResCode } from './client_def';
+import { NIMNotificationId } from './msglog_def';
+import { UserNameCard } from './user_def';
+/** @enum NIMSuperTeamBitsConfigMask 群组成员信息Bits属性kNIMSuperTeamUserKeyBits的配置定义 */
+export declare enum NIMSuperTeamBitsConfigMask {
+    kNIMSuperTeamBitsConfigMaskMuteNone = 0,
+    kNIMSuperTeamBitsConfigMaskMuteNotify = 1,
+    kNIMSuperTeamBitsConfigMaskOnlyAdmin = 2
+}
+/** @enum NIMSuperTeamUserType 群成员类型 */
+export declare enum NIMSuperTeamUserType {
+    kNIMSuperTeamUserTypeNomal = 0,
+    kNIMSuperTeamUserTypeCreator = 1,
+    kNIMSuperTeamUserTypeManager = 2,
+    kNIMSuperTeamUserTypeApply = 3,
+    kNIMSuperTeamUserTypeLocalWaitAccept = 100
+}
+/** @enum NIMSuperTeamBeInviteMode 被邀请人同意方式 */
+export declare enum NIMSuperTeamBeInviteMode {
+    kNIMSuperTeamBeInviteModeNeedAgree = 0,
+    kNIMSuperTeamBeInviteModeNotNeedAgree = 1
+}
+/** @enum NIMSuperTeamInviteMode 谁可以邀请他人入群 */
+export declare enum NIMSuperTeamInviteMode {
+    kNIMSuperTeamInviteModeManager = 0,
+    kNIMSuperTeamInviteModeEveryone = 1
+}
+/** @enum NIMSuperTeamUpdateInfoMode 谁可以修改群资料 */
+export declare enum NIMSuperTeamUpdateInfoMode {
+    kNIMSuperTeamUpdateInfoModeManager = 0,
+    kNIMSuperTeamUpdateInfoModeEveryone = 1
+}
+/** @enum NIMSuperTeamUpdateCustomMode 谁可以更新群自定义属性 */
+export declare enum NIMSuperTeamUpdateCustomMode {
+    kNIMSuperTeamUpdateCustomModeManager = 0,
+    kNIMSuperTeamUpdateCustomModeEveryone = 1
+}
+/** @enum NIMSuperTeamJoinMode 群允许加入类型 */
+export declare enum NIMSuperTeamJoinMode {
+    kNIMSuperTeamJoinModeNoAuth = 0,
+    kNIMSuperTeamJoinModeNeedAuth = 1,
+    kNIMSuperTeamJoinModeRejectAll = 2
+}
+/** @enum NIMSuperTeamQueryType 根据关键字查询群组信息类型 */
+export declare enum NIMSuperTeamQueryType {
+    kNIMQuerySuperTeamDefault = 1,
+    kNIMQuerySuperTeamByTeamId = 2,
+    kNIMQuerySuperTeamByTeamName = 3 /** 仅匹配群名称 */
+}
+/** @enum NIMSuperTeamMuteType 群信息kNIMSuperTeamInfoKeyMuteType的配置定义 */
+export declare enum NIMSuperTeamMuteType {
+    kNIMSuperTeamMuteTypeNone = 0,
+    kNIMSuperTeamMuteTypeNomalMute = 1,
+    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; /**< 未解析过的原信息，目前仅支持群消息未读数相关事件 */
+}
+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;
+}
+export interface SuperTeamInfo {
+    team_info_json_value_: SuperTeamInfoJsonValue;
+}
+export interface SuperTeamMemberPropertyJsonValue {
+    tid: string;
+    type: NIMSuperTeamUserType;
+    nick: string;
+    bits: number;
+    mute: number;
+    custom: string;
+}
+export interface SuperTeamMemberProperty {
+    member_info_json_value_: SuperTeamMemberPropertyJsonValue;
+}
+export declare type SuperTeamEventCallback = (result: SuperTeamEvent) => void;
+export declare type QueryAllMySuperTeamsCallback = (count: number, result: Array<string>) => void;
+export declare type QueryAllMySuperTeamsInfoCallback = (count: number, result: Array<SuperTeamInfo>) => void;
+export declare type QueryMyAllMemberInfosCallback = (count: number, result: Array<SuperTeamMemberProperty>) => void;
+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 interface NIMSuperTeamAPI {
+    InitEventHandlers(): void;
+    InviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    KickAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    LeaveAsync(tid: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    UpdateSuperTeamInfoAsync(tid: string, info: SuperTeamInfo, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    ApplyJoinAsync(tid: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    PassJoinApplyAsync(tid: string, applicantId: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    RejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    AddManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    RemoveManagersAsync(tid: string, ids: Array<string>, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    TransferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    UpdateMyPropertyAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    UpdateOtherNickAsync(prop: SuperTeamMemberProperty, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    AcceptInvitationAsync(tid: string, inviterId: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    RejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    QueryAllMySuperTeamsAsync(cb: QueryAllMySuperTeamsCallback, jsonExtension: string): void;
+    QueryAllMySuperTeamsInfoAsync(cb: QueryAllMySuperTeamsInfoCallback, jsonExtension: string): void;
+    QueryMyAllMemberInfosAsync(cb: QueryMyAllMemberInfosCallback, jsonExtension: string): void;
+    QuerySuperTeamMembersAsync(tid: string, cb: QuerySuperTeamMembersCallback, jsonExtension: string): boolean;
+    QuerySuperTeamMemberAsync(tid: string, id: string, cb: QuerySuperTeamMemberCallback, jsonExtension: string): void;
+    QuerySuperTeamInfoAsync(tid: string, cb: QuerySuperTeamInfoCallback, jsonExtension: string): boolean;
+    QuerySuperTeamInfoOnlineAsync(tid: string, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    MuteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    MuteAsync(tid: string, set_mute: boolean, cb: SuperTeamEventCallback, jsonExtension: string): boolean;
+    QuerySuperTeamsInfoByKeywordAsync(keyword: string, cb: QueryAllMySuperTeamsInfoCallback, jsonExtension: string): void;
+}

package/types/def/sysmsg_def.d.ts

@@ -0,0 +1,84 @@
+import { NIMResCode } from './client_def';
+import { BoolStatus } from './msglog_def';
+/** @enum NIMSysMsgStatus 系统消息状态 */
+export declare enum NIMSysMsgStatus {
+    kNIMSysMsgStatusNone = 0,
+    kNIMSysMsgStatusPass = 1,
+    kNIMSysMsgStatusDecline = 2,
+    kNIMSysMsgStatusRead = 3,
+    kNIMSysMsgStatusDeleted = 4,
+    kNIMSysMsgStatusInvalid = 5
+}
+/** @enum NIMSysMsgType 系统消息内容类型 */
+export declare enum NIMSysMsgType {
+    kNIMSysMsgTypeTeamApply = 0,
+    kNIMSysMsgTypeTeamReject = 1,
+    kNIMSysMsgTypeTeamInvite = 2,
+    kNIMSysMsgTypeTeamInviteReject = 3,
+    kNIMSysMsgTypeFriendAdd = 5,
+    kNIMSysMsgTypeFriendDel = 6,
+    kNIMSysMsgTypeCustomP2PMsg = 100,
+    kNIMSysMsgTypeCustomTeamMsg = 101,
+    kNIMSysMsgTypeCustomSuperTeamMsg = 103,
+    kNIMSysMsgTypeUnknown = 1000
+}
+/** @enum NIMMessageFeature 消息种类 */
+export declare enum NIMMessageFeature {
+    kNIMMessageFeatureDefault = 0,
+    kNIMMessageFeatureLeaveMsg = 1,
+    kNIMMessageFeatureRoamMsg = 2,
+    kNIMMessageFeatureSyncMsg = 3,
+    kNIMMessageFeatureCustomizedMsg = 4
+}
+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 第三方回调返回的自定义字段 */
+}
+export interface SysMessageSetting {
+    need_push_: BoolStatus; /**< 是否需要推送 */
+    push_need_badge_: BoolStatus; /**< 是否要做消息计数 */
+    push_need_prefix_: BoolStatus; /**< 需要推送昵称 */
+    need_offline_: BoolStatus; /**< 是否支持离线消息 */
+    push_payload_: string; /**< 第三方自定义的推送属性，长度2048 */
+    push_content_: string; /**< 自定义推送文案，长度限制200字节 */
+    anti_spam_enable_: BoolStatus; /**< (功能暂时不开放)是否需要过易盾反垃圾 */
+    anti_spam_content_: string; /**< (功能暂时不开放)(可选)开发者自定义的反垃圾字段 */
+    env_config_: string; /**< (可选) 指向自定义抄送的配置 */
+}
+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; /**< 易盾反垃圾返回的结果字段*/
+}
+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 QuerySysmsgCallback = (count: number, unread_count: number, result: Array<SysMessage>) => void;
+export interface NIMSysMsgAPI {
+    InitEventHandlers(): void;
+    SendCustomNotificationMsg(msg: SysMessage): void;
+    QueryMsgAsync(limit_count: number, last_time: number, cb: QuerySysmsgCallback, jsonExtension: string): boolean;
+    QueryUnreadCount(cb: NotifySysmsgResCallback, jsonExtension: string): void;
+    SetStatusAsync(msg_id: number, status: NIMSysMsgStatus, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
+    ReadAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): void;
+    DeleteAsync(msg_id: number, cb: NotifySingleSysmsgCallback, jsonExtension: string): boolean;
+    DeleteAllAsync(cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+    SetStatusByTypeAsync(type: NIMSysMsgType, status: NIMSysMsgStatus, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+    DeleteByTypeAsync(type: NIMSysMsgType, cb: NotifySysmsgResCallback, jsonExtension: string): boolean;
+}

package/types/def/talk_def.d.ts

@@ -0,0 +1,48 @@
+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; /**< 易盾反垃圾返回的结果字段*/
+}
+export interface BroadcastMessage {
+    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 第三方回调返回的字定义字段 */
+}
+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 ReceiveBroadcastMsgCallback = (result: BroadcastMessage) => void;
+export declare type ReceiveBroadcastMsgsCallback = (result: Array<BroadcastMessage>) => void;
+export declare type TeamNotificationFilterCallback = (result: IMMessage) => void;
+export declare type MessageFilterCallback = (result: IMMessage) => boolean;
+export interface NIMTalkAPI {
+    InitEventHandlers(): void;
+    SendMsg(msg: IMMessage, jsonExtension: string): void;
+    StopSendMsg(clientMsgId: string, type: NIMMessageType, jsonExtension: string): void;
+    RecallMsg(msg: IMMessage, notify_msg: string, cb: RecallMsgsCallback, apnstext: string, pushpayloadconst: string, jsonExtension: string): void;
+    GetAttachmentPathFromMsg(msg: IMMessage): string;
+    ReplyMessage(msg: IMMessage, json_reply_msg: string): void;
+}

package/types/def/talkex_def.d.ts

@@ -0,0 +1,111 @@
+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 = (code: number, info: CollectInfo) => void;
+export declare type RemoveCollectsCallback = (code: number, count: number) => void;
+export declare type UpdateCollectCallback = (code: number, info: CollectInfo) => void;
+export declare type QueryCollectsCallback = (code: number, count: number, info: CollectInfoList) => void;
+export declare type AddQuickCommentCallback = (code: number, info: QuickCommentInfo) => void;
+export declare type RemoveQuickCommentCallback = (code: number, id: string) => void;
+export declare type QueryQuickCommentCallback = (code: number, 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 = (code: number, session: string, to_type: number, info: PinMessageInfo) => void;
+export declare type UnPinMessageCallback = (code: number, session: string, to_type: number, id: string) => void;
+export declare type UpdatePinMessageCallback = (code: number, session: string, to_type: number, info: PinMessageInfo) => void;
+export declare type QueryPinMessageCallback = (code: number, 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;
+}

package/types/def/team_def.d.ts

@@ -0,0 +1,153 @@
+import { NIMResCode } from './client_def';
+import { IMMessage, NIMNotificationId } from './msglog_def';
+import { UserNameCard } from './user_def';
+/** @enum NIMTeamBeInviteMode 被邀请人同意方式 */
+export declare enum NIMTeamBeInviteMode {
+    kNIMTeamBeInviteModeNeedAgree = 0,
+    kNIMTeamBeInviteModeNotNeedAgree = 1
+}
+/** @enum NIMTeamInviteMode 谁可以邀请他人入群 */
+export declare enum NIMTeamInviteMode {
+    kNIMTeamInviteModeManager = 0,
+    kNIMTeamInviteModeEveryone = 1
+}
+/** @enum NIMTeamUpdateInfoMode 谁可以修改群资料 */
+export declare enum NIMTeamUpdateInfoMode {
+    kNIMTeamUpdateInfoModeManager = 0,
+    kNIMTeamUpdateInfoModeEveryone = 1
+}
+/** @enum NIMTeamUpdateCustomMode 谁可以更新群自定义属性 */
+export declare enum NIMTeamUpdateCustomMode {
+    kNIMTeamUpdateCustomModeManager = 0,
+    kNIMTeamUpdateCustomModeEveryone = 1
+}
+/** @enum NIMTeamMuteType 群信息kTeamInfoKeyMuteType的配置定义 */
+export declare enum NIMTeamMuteType {
+    kNIMTeamMuteTypeNone = 0,
+    kNIMTeamMuteTypeNomalMute = 1,
+    kNIMTeamMuteTypeAllMute = 3
+}
+/** @enum NIMTeamBitsConfigMask 群组成员信息Bits属性kNIMTeamUserKeyBits的配置定义 */
+export declare enum NIMTeamBitsConfigMask {
+    kNIMTeamBitsConfigMaskMuteNone = 0,
+    kNIMTeamBitsConfigMaskMuteNotify = 1,
+    kNIMTeamBitsConfigMaskOnlyAdmin = 2
+}
+/** @enum NIMTeamType 群组类型 */
+export declare enum NIMTeamType {
+    kNIMTeamTypeNormal = 0,
+    kNIMTeamTypeAdvanced = 1
+}
+/** @enum NIMTeamUserType 群成员类型 */
+export declare enum NIMTeamUserType {
+    kNIMTeamUserTypeNomal = 0,
+    kNIMTeamUserTypeCreator = 1,
+    kNIMTeamUserTypeManager = 2,
+    kNIMTeamUserTypeApply = 3,
+    kNIMTeamUserTypeLocalWaitAccept = 100
+}
+/** @enum NIMTeamJoinMode 群允许加入类型 */
+export declare enum NIMTeamJoinMode {
+    kNIMTeamJoinModeNoAuth = 0,
+    kNIMTeamJoinModeNeedAuth = 1,
+    kNIMTeamJoinModeRejectAll = 2
+}
+export declare enum NIMTeamQueryType {
+    kNIMTeamQueryDefault = 0,
+    kNIMTeamQueryByTeamId = 1,
+    kNIMTeamQueryByTeamName = 2 /** < 仅匹配群组名称 */
+}
+export interface TeamEvent {
+    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_: TeamInfo; /**< 通知可能涉及到的群信息 */
+    member_property_: TeamMemberProperty; /**< 群成员属性 */
+    opt_: boolean; /**< 操作 */
+    attach_: string; /**< 扩展字段,目前仅kick和invite事件可选 */
+    src_data_: string; /**< 未解析过的原信息，目前仅支持群消息未读数相关事件 */
+}
+export interface TeamInfoJsonValue {
+    tid: string;
+    name: string;
+    member_max_count: number;
+    type: NIMTeamType;
+    prop: string;
+    intro: string;
+    announcement: string;
+    join_mode: NIMTeamJoinMode;
+    custom: string;
+    icon: string;
+    be_invite_mode: NIMTeamBeInviteMode;
+    invite_mode: NIMTeamInviteMode;
+    update_info_mode: NIMTeamUpdateInfoMode;
+    update_custom_mode: NIMTeamUpdateCustomMode;
+    mute_type: NIMTeamMuteType;
+}
+export interface TeamInfo {
+    team_info_json_value_: TeamInfoJsonValue;
+}
+export interface TeamMemberPropertyJsonValue {
+    tid: string;
+    type: NIMTeamUserType;
+    nick: string;
+    bits: number;
+    mute: number;
+    custom: string;
+}
+export interface TeamMemberProperty {
+    member_info_json_value_: TeamMemberPropertyJsonValue;
+}
+export declare type TeamEventCallback = (result: TeamEvent) => void;
+export declare type QueryAllMyTeamsCallback = (count: number, result: Array<string>) => void;
+export declare type QueryAllMyTeamsInfoCallback = (count: number, result: Array<TeamInfo>) => void;
+export declare type QueryMyAllMemberInfosCallback = (count: number, result: Array<TeamMemberProperty>) => void;
+export declare type QueryTeamMembersCallback = (tid: string, count: number, result: Array<TeamMemberProperty>) => void;
+export declare type QueryTeamMemberCallback = (result: TeamMemberProperty) => void;
+export declare type QueryTeamInfoCallback = (tid: string, result: TeamInfo) => void;
+export declare type QueryTeamMembersOnlineCallback = (rescode: number, count: number, result: Array<TeamMemberProperty>) => void;
+export declare type QueryTeamMembersInvitorCallback = (rescode: number, count: number, result: Map<string, string>) => void;
+export declare type QueryTeamsInfoCallback = (count: number, result: Array<TeamInfo>) => void;
+export declare type TeamMsgAckReadCallback = (tid: string, success_ids: Array<string>, failure_ids: Array<string>, ignored_ids: Array<string>) => void;
+export declare type UpdateTInfoLocalCallback = (success_ids: Array<string>, failure_ids: Array<string>) => void;
+export declare type GetTeamInfoBatchSFTransCallback = (count: number, infos: Array<TeamInfo>) => void;
+export declare type GetTeamInfoListCallback = (rescode: NIMResCode, infos: Array<TeamInfo>, failure_ids: Array<string>) => void;
+export interface NIMTeamAPI {
+    InitEventHandlers(): void;
+    CreateTeamAsync(info: TeamInfo, ids: Array<string>, invitationPostscript: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    InviteAsync(tid: string, ids: Array<string>, invitationPostscript: string, invitationAttachment: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    KickAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
+    LeaveAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    DismissAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    UpdateTeamInfoAsync(tid: string, info: TeamInfo, cb: TeamEventCallback, jsonExtension: string): boolean;
+    ApplyJoinAsync(tid: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    PassJoinApplyAsync(tid: string, applicantId: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    RejectJoinApplyAsync(tid: string, applicantId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    AddManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
+    RemoveManagersAsync(tid: string, ids: Array<string>, cb: TeamEventCallback, jsonExtension: string): boolean;
+    TransferTeamAsync(tid: string, newOwnerId: string, isLeave: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
+    UpdateMyPropertyAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): boolean;
+    UpdateOtherNickAsync(prop: TeamMemberProperty, cb: TeamEventCallback, jsonExtension: string): boolean;
+    AcceptInvitationAsync(tid: string, inviterId: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    RejectInvitationAsync(tid: string, inviterId: string, reason: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    QueryAllMyTeamsAsync(cb: QueryAllMyTeamsCallback, jsonExtension: string): void;
+    QueryAllMyTeamsInfoAsync(cb: QueryAllMyTeamsInfoCallback, jsonExtension: string): void;
+    QueryMyAllMemberInfosAsync(cb: QueryMyAllMemberInfosCallback, jsonExtension: string): void;
+    QueryTeamMembersAsync(tid: string, cb: QueryTeamMembersCallback, jsonExtension: string): boolean;
+    QueryTeamMemberAsync(tid: string, id: string, cb: QueryTeamMemberCallback, jsonExtension: string): void;
+    QueryTeamInfoAsync(tid: string, cb: QueryTeamInfoCallback, jsonExtension: string): boolean;
+    QueryTeamInfoOnlineAsync(tid: string, cb: TeamEventCallback, jsonExtension: string): boolean;
+    MuteMemberAsync(tid: string, member_id: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
+    QueryMuteListOnlineAsync(tid: string, cb: QueryTeamMembersOnlineCallback, jsonExtension: string): boolean;
+    MuteAsync(tid: string, set_mute: boolean, cb: TeamEventCallback, jsonExtension: string): boolean;
+    TeamMsgAckRead(tid: string, msgs: Array<IMMessage>, cb: TeamMsgAckReadCallback, jsonExtension: string): void;
+    TeamMsgQueryUnreadList(tid: string, msg: IMMessage, accids: Array<string>, cb: TeamEventCallback, jsonExtension: string): void;
+    QueryTeamMembersInvitor(tid: string, members: Array<string>, cb: QueryTeamMembersInvitorCallback): void;
+    QueryTeamInfoByKeywordAsync(keyword: string, cb: QueryTeamsInfoCallback, jsonExtension: string): boolean;
+    UpdateTInfoLocal(infos: Array<TeamInfo>, cb: UpdateTInfoLocalCallback, jsonExtension: string): void;
+    GetTeamInfoBatchSFTrans(cb: GetTeamInfoBatchSFTransCallback, time_tag: number, jsonExtension: string): void;
+    GetTeaminfoList(tids: Array<string>, cb: GetTeamInfoListCallback): void;
+}

package/types/def/tool_def.d.ts

@@ -0,0 +1,27 @@
+/** @enum NIMAppDataType AppData类型 */
+export declare enum NIMAppDataType {
+    kNIMAppDataTypeUnknownOtherRes = 0,
+    kNIMAppDataTypeImage = 1,
+    kNIMAppDataTypeAudio = 2,
+    kNIMAppDataTypeVideo = 3
+}
+export interface AudioInfo {
+    mime_type_: string; /** < string 语音类型 */
+    samplerate_: string; /** < string 语音采样率 */
+    url_: string; /** < string 语音url*/
+    duration_: number; /** < long 语音时长，毫秒*/
+}
+export declare type GetAudioTextCallback = (rescode: number, text: string) => void;
+export declare type FilterClientAntispamCallback = (succeed: boolean, rescode: number, text: string) => void;
+export interface NIMToolAPI {
+    InitEventHandlers(): void;
+    GetUserAppdataDir(appAccount: string): string;
+    GetSpecificAppdataDir(appAccount: string, appdataType: NIMAppDataType): string;
+    GetLocalAppdataDir(): string;
+    GetCurModuleDir(): string;
+    GetMd5(input: string): string;
+    GetFileMd5(filePath: string): string;
+    GetUuid(): string;
+    GetAudioTextAsync(audioInfo: AudioInfo, cb: GetAudioTextCallback, jsonExtension: string): boolean;
+    FilterClientAntispam(text: string, replaceString: string, libName: string, cb: FilterClientAntispamCallback): void;
+}