node-nim/types/qchat_def/server_def.d.ts

NetEase IM nodejs wrapper based on NetEase IM C++ SDK

import { QChatServerInfo, QChatBaseResp, QChatPageInfo, NIMQChatServerInviteFailReason, QChatMemberInfo, QChatInviteApplyRecord, QChatBusinessAntiSpamInfo, NIMQChatSubscribeOpeType, NIMQChatSubscribeType, NIMQChatSearchOrder, NIMQChatServerSearchSort, NIMQChatServerSearchType } from './public_def';
export interface QChatServerCreateResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 服务器ID */
    server_info?: QChatServerInfo;
}
/** @interface QChatServerDeleteResp */
export type QChatServerDeleteResp = QChatBaseResp;
/** @interface QChatServerUpdateResp */
export type QChatServerUpdateResp = QChatServerCreateResp;
/** @interface QChatServerGetServersResp */
export interface QChatServerGetServersResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 服务器列表 */
    server_list?: Array<QChatServerInfo>;
}
/** @interface QChatServerGetServersPageResp */
export interface QChatServerGetServersPageResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 服务器列表 */
    server_list?: Array<QChatServerInfo>;
    /** 分页信息 */
    page_info?: QChatPageInfo;
}
/** @interface QChatServerEnterAsVisitorResp */
export interface QChatServerEnterAsVisitorResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
}
/** @interface QChatServerLeaveAsVisitorResp */
export interface QChatServerLeaveAsVisitorResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
}
/** @interface QChatServerInviteResp */
export interface QChatServerInviteResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 请求ID */
    request_id?: string;
    /** 请求失效时间戳 */
    expire_time?: number;
    /** 邀请失败的成员id和失败原因 */
    fail_map?: Map<string, NIMQChatServerInviteFailReason>;
}
/** @interface QChatServerAcceptInviteResp */
export type QChatServerAcceptInviteResp = QChatBaseResp;
/** @interface QChatServerRejectInviteResp */
export type QChatServerRejectInviteResp = QChatBaseResp;
/** @interface QChatServerApplyResp */
export interface QChatServerApplyResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 请求ID */
    request_id?: string;
    /** 过期时间 */
    expire_time?: number;
}
/** @interface QChatServerAcceptApplyResp */
export type QChatServerAcceptApplyResp = QChatBaseResp;
/** @interface QChatServerRejectApplyResp */
export type QChatServerRejectApplyResp = QChatBaseResp;
/** @interface QChatServerKickResp */
export type QChatServerKickResp = QChatBaseResp;
/** @interface QChatServerLeaveResp */
export type QChatServerLeaveResp = QChatBaseResp;
/** @interface QChatServerUpdateMemberInfoResp */
export type QChatServerUpdateMemberInfoResp = QChatBaseResp;
/** @interface QChatServerGetMembersResp */
export interface QChatServerGetMembersResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 成员信息列表 */
    member_list?: Array<QChatMemberInfo>;
}
export interface QChatServerGetMembersPageResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 分页信息 */
    page_info?: QChatPageInfo;
    /** 成员信息列表 */
    member_list?: Array<QChatMemberInfo>;
}
/** @interface QChatServerSubscribeResp */
export interface QChatServerSubscribeResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
}
/** @interface QChatServerSubscribeAsVisitorResp */
export interface QChatServerSubscribeAsVisitorResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
}
/** @interface QChatServerSubscribeAllChannelResp */
export interface QChatServerSubscribeAllChannelResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
}
/** @interface QChatServerMarkReadResp */
export interface QChatServerMarkReadResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 失败列表 */
    failed_servers?: Array<string>;
    /** 成功列表 */
    succeeded_servers?: Array<string>;
    /** 标记已读时间戳 */
    timestamp?: number;
}
/** @interface QChatServerBanMemberResp */
export type QChatServerBanMemberResp = QChatBaseResp;
/** @interface QChatServerUnbanMemberResp */
export type QChatServerUnbanMemberResp = QChatBaseResp;
/** @interface QChatMemberBanInfo 圈组服务器成员封禁信息 */
export interface QChatMemberBanInfo {
    /** server id */
    server_id?: string;
    /** 用户accid */
    accid?: string;
    /** 自定义字段 */
    custom?: string;
    /** 封禁时间 */
    ban_time?: number;
    /** 有效标记，false:无效 true:有效 */
    valid_flag?: boolean;
    /** 创建时间 */
    create_time?: number;
    /** 更新时间 */
    update_time?: number;
}
/** @interface QChatServerGetBannedMembersPageResp */
export interface QChatServerGetBannedMembersPageResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 分页信息 */
    page_info?: QChatPageInfo;
    /** 成员封禁列表 */
    ban_list?: Array<QChatMemberBanInfo>;
}
/** @interface QChatServerSearchPageResp */
export type QChatServerSearchPageResp = QChatServerGetServersPageResp;
/** @interface QChatServerMemberSearchResp */
export type QChatServerMemberSearchResp = QChatServerGetMembersResp;
/** @interface NIMQChatServerUnreadInfo */
export interface NIMQChatServerUnreadInfo {
    /** 服务器ID */
    server_id?: string;
    /** 未读数 */
    unread_count?: number;
    /** 被@未读数 */
    mentioned_unread_count?: number;
    /** 订阅未读数时的最大未读数 */
    max_unread_count?: number;
}
/** @interface QChatServerUnreadResp */
export interface QChatServerUnreadResp {
    /** 未读数信息 */
    unread_infos?: Array<NIMQChatServerUnreadInfo>;
}
/** QChatServerGenerateInviteCodeResp */
export interface QChatServerGenerateInviteCodeResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 服务器 id */
    server_id?: string;
    /** 请求ID */
    request_id?: string;
    /** 邀请码 */
    invite_code?: string;
    /** 过期时间 */
    expire_time?: number;
}
/** @interface QChatServerJoinByInviteCodeResp */
export type QChatServerJoinByInviteCodeResp = QChatBaseResp;
/** @interface QChatServerGetInviteApplyRecordOfServerResp */
export interface QChatServerGetInviteApplyRecordOfServerResp {
    /** 操作结果, 参考NIMResCode */
    res_code?: number;
    /** 邀请申请历史列表 */
    invite_apply_records?: Array<QChatInviteApplyRecord>;
}
/** @interface QChatServerGetInviteApplyRecordOfSelfResp */
export type QChatServerGetInviteApplyRecordOfSelfResp = QChatServerGetInviteApplyRecordOfServerResp;
/** 未读数回调 */
export type ServerUnreadCallback = (resp: QChatServerUnreadResp) => void;
/** 创建服务器回调 */
export type ServerCreateCallback = (resp: QChatServerCreateResp) => void;
/** 删除服务器回调 */
export type ServerRemoveCallback = (resp: QChatServerDeleteResp) => void;
/** 更新服务器回调 */
export type ServerUpdateCallback = (resp: QChatServerUpdateResp) => void;
/** 以游客身份加入服务器回调 */
export type EnterAsVisitorCallback = (resp: QChatServerEnterAsVisitorResp) => void;
/** 以游客身份离开服务器回调 */
export type LeaveAsVisitorCallback = (resp: QChatServerLeaveAsVisitorResp) => void;
/** 查询服务器列表回调 */
export type GetServersCallback = (resp: QChatServerGetServersResp) => void;
/** 查询服务器列表分页回调 */
export type GetServersPageCallback = (resp: QChatServerGetServersPageResp) => void;
/** 邀请用户加入服务器回调 */
export type ServerInviteCallback = (resp: QChatServerInviteResp) => void;
/** 接受邀请加入服务器回调 */
export type ServerAcceptInviteCallback = (resp: QChatServerAcceptInviteResp) => void;
/** 拒绝邀请加入服务器回调 */
export type ServerRejectInviteCallback = (resp: QChatServerRejectInviteResp) => void;
/** 申请加入服务器回调 */
export type ServerApplyCallback = (resp: QChatServerApplyResp) => void;
/** 接受申请加入服务器回调 */
export type ServerAcceptApplyCallback = (resp: QChatServerAcceptApplyResp) => void;
/** 拒绝申请加入服务器回调 */
export type ServerRejectApplyCallback = (resp: QChatServerRejectApplyResp) => void;
/** 踢出服务器回调 */
export type ServerKickCallback = (resp: QChatServerKickResp) => void;
/** 离开服务器回调 */
export type ServerLeaveCallback = (resp: QChatServerLeaveResp) => void;
/** 更新服务器成员信息回调 */
export type ServerUpdateMemberInfoCallback = (resp: QChatServerUpdateMemberInfoResp) => void;
/** 查询服务器成员列表回调 */
export type ServerGetMembersCallback = (resp: QChatServerGetMembersResp) => void;
/** 查询服务器成员列表分页回调 */
export type ServerGetMembersPageCallback = (resp: QChatServerGetMembersPageResp) => void;
/** 订阅回调 */
export type ServerSubscribeCallback = (resp: QChatServerSubscribeResp) => void;
/** 以游客身份订阅回调 */
export type ServerSubscribeAsVisitorCallback = (resp: QChatServerSubscribeResp) => void;
/** 封禁成员回调 */
export type ServerBanMemberCallback = (resp: QChatServerBanMemberResp) => void;
/** 解封成员回调 */
export type ServerUnbanMemberCallback = (resp: QChatServerUnbanMemberResp) => void;
/** 查询服务器成员封禁列表分页回调 */
export type ServerGetBannedMembersPageCallback = (resp: QChatServerGetBannedMembersPageResp) => void;
/** 搜索服务器分页回调 */
export type ServerSearchPageCallback = GetServersPageCallback;
/** 搜索服务器成员分页回调 */
export type ServerMemberSearchCallback = ServerGetMembersCallback;
/** 生成邀请码回调 */
export type ServerGenerateInviteCodeCallback = (resp: QChatServerGenerateInviteCodeResp) => void;
/** 通过邀请码加入回调 */
export type ServerJoinByInviteCodeCallback = (resp: QChatServerJoinByInviteCodeResp) => void;
/** 查询服务器下的申请邀请记录回调 */
export type ServerGetInviteApplyRecordOfServerCallback = (resp: QChatServerGetInviteApplyRecordOfServerResp) => void;
/** 查询自己的申请邀请记录回调 */
export type ServerGetInviteApplyRecordOfSelfCallback = (resp: QChatServerGetInviteApplyRecordOfSelfResp) => void;
/** 服务器标记已读 */
export type ServerMarkReadCallback = (resp: QChatServerMarkReadResp) => void;
/** 订阅所有频道 */
export type ServerSubscribeAllChannelCallback = (resp: QChatServerSubscribeAllChannelResp) => void;
/** @interface QChatServerCreateParam */
export interface QChatServerCreateParam {
    /** 服务器信息 */
    server_info?: QChatServerInfo;
    /** 反垃圾信息 */
    anti_spam_info?: QChatBusinessAntiSpamInfo;
}
/** @interface QChatServerDeleteParam */
export interface QChatServerDeleteParam {
    /** 服务器ID */
    server_id?: string;
}
/** @interface QChatServerEnterAsVisitorParam */
export interface QChatServerEnterAsVisitorParam {
    /** ID 列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerLeaveAsVisitorParam */
export interface QChatServerLeaveAsVisitorParam {
    /** ID 列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerUpdateParam */
export interface QChatServerUpdateParam {
    /** 服务器信息 */
    server_info?: QChatServerInfo;
    /** 反垃圾信息 */
    anti_spam_info?: QChatBusinessAntiSpamInfo;
}
/** @interface QChatServerGetServersParam */
export interface QChatServerGetServersParam {
    /** 服务器id列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerGetServersPageParam */
export interface QChatServerGetServersPageParam {
    /** 时间戳 */
    timestamp?: number;
    /** 查询条数 */
    limit?: number;
}
/** @interface QChatServerInviteParam */
export interface QChatServerInviteParam {
    /** 服务器ID */
    server_id?: string;
    /** 受邀人id列表 */
    invite_ids?: Array<string>;
    /** 请求生存时间 ms */
    ttl?: number;
    /** 附言 */
    postscript?: string;
}
/** @interface QChatServerAcceptInviteParam */
export interface QChatServerAcceptInviteParam {
    /** 服务器ID */
    server_id?: string;
    /** 邀请人id */
    accid?: string;
    /** 请求ID */
    request_id?: string;
}
/** @interface QChatServerRejectInviteParam */
export interface QChatServerRejectInviteParam {
    /** 服务器ID */
    server_id?: string;
    /** 邀请人id */
    accid?: string;
    /** 附言 */
    postscript?: string;
    /** 请求ID */
    request_id?: string;
}
/** @interface QChatServerApplyParam */
export interface QChatServerApplyParam {
    /** 服务器ID */
    server_id?: string;
    /** 请求生存时间 ms */
    ttl?: number;
    /** 附言 */
    postscript?: string;
}
/** @interface QChatServerAcceptApplyParam */
export interface QChatServerAcceptApplyParam {
    /** 服务器ID */
    server_id?: string;
    /** 申请人id */
    accid?: string;
    /** 请求ID */
    request_id?: string;
}
/** @interface QChatServerRejectApplyParam */
export interface QChatServerRejectApplyParam {
    /** 服务器ID */
    server_id?: string;
    /** 申请人id */
    accid?: string;
    /** 附言 */
    postscript?: string;
    /** 请求ID */
    request_id?: string;
}
/** @interface QChatServerKickParam */
export interface QChatServerKickParam {
    /** 服务器ID */
    server_id?: string;
    /** 被踢人id列表 */
    accids?: Array<string>;
}
/** @interface QChatServerLeaveParam */
export interface QChatServerLeaveParam {
    /** 服务器ID */
    server_id?: string;
}
/** @interface QChatServerUpdateMemberInfoParam */
export interface QChatServerUpdateMemberInfoParam {
    /** 更新的成员信息 */
    member_info?: QChatMemberInfo;
    /** 反垃圾信息 */
    anti_spam_info?: QChatBusinessAntiSpamInfo;
}
export interface QChatServerAccidPair {
    /** 服务器ID */
    server_id?: string;
    /** accid */
    accid?: string;
}
/** @interface QChatServerGetMembersParam */
export interface QChatServerGetMembersParam {
    /** 服务器id和accid列表 */
    server_accid_list?: Array<QChatServerAccidPair>;
}
/** @interface QChatServerGetMembersPageParam */
export interface QChatServerGetMembersPageParam {
    /** 服务器ID */
    server_id?: string;
    /** 时间戳 */
    timestamp?: number;
    /** 查询条数 */
    limit?: number;
}
/** @interface QChatServerSubscribeParam */
export interface QChatServerSubscribeParam {
    /** 操作类型 */
    ope_type?: NIMQChatSubscribeOpeType;
    /** 订阅类型 */
    sub_type?: NIMQChatSubscribeType;
    /** ID 列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerSubscribeAsVisitorParam */
export interface QChatServerSubscribeAsVisitorParam {
    /** 操作类型 */
    ope_type?: NIMQChatSubscribeOpeType;
    /** ID 列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerBanMemberParam */
export interface QChatServerBanMemberParam {
    /** 服务器ID */
    server_id?: string;
    /** 用户id */
    accid?: string;
    /** 自定义字段 */
    custom?: string;
}
/** @interface QChatServerUnbanMemberParam */
export interface QChatServerUnbanMemberParam {
    /** 服务器ID */
    server_id?: string;
    /** 用户id */
    accid?: string;
    /** 自定义字段 */
    custom?: string;
}
/** @interface QChatServerGetBannedMembersPageParam */
export interface QChatServerGetBannedMembersPageParam {
    /** 服务器ID */
    server_id?: string;
    /** 时间戳 */
    timestamp?: number;
    /** 查询条数 */
    limit?: number;
}
/** @interface QChatServerSearchPageParam */
export interface QChatServerSearchPageParam {
    /** 搜索内容 */
    keyword?: string;
    /** 起始时间 */
    start_time?: number;
    /** 结束时间 */
    end_time?: number;
    /** 排序规则 */
    order?: NIMQChatSearchOrder;
    /** 排序条件 */
    sort?: NIMQChatServerSearchSort;
    /** 搜索的服务器类型, 为空表示搜索所有类型 */
    server_types?: Array<string>;
    /** 搜索类型 */
    search_type?: NIMQChatServerSearchType;
    /** 查询条数 */
    limit?: number;
    /** 查询游标, 查询的起始位置 */
    cursor?: string;
}
/** @interface QChatServerMemberSearchParam */
export interface QChatServerMemberSearchParam {
    /** 服务器 id */
    server_id?: string;
    /** 搜索内容 */
    keyword?: string;
    /** 查询条数 */
    limit?: number;
}
/** @interface QChatServerGenerateInviteCodeParam */
export interface QChatServerGenerateInviteCodeParam {
    /** 服务器 id */
    server_id?: string;
    /** 请求生存时间 ms */
    ttl?: number;
}
/** @interface QChatServerJoinByInviteCodeParam */
export interface QChatServerJoinByInviteCodeParam {
    /** 服务器 id */
    server_id?: string;
    /** 邀请码 */
    invite_code?: string;
    /** 附言 */
    postscript?: string;
}
/** @interface QChatServerGetInviteApplyRecordOfServerParam */
export interface QChatServerGetInviteApplyRecordOfServerParam {
    /** 服务器 id */
    server_id?: string;
    /** 起始时间 */
    start_time?: number;
    /** 结束时间 */
    end_time?: number;
    /** 是否倒序, false: 否, true: 是 */
    reverse?: boolean;
    /** 查询条数 */
    limit?: number;
    /** 要排除的记录id */
    exclude_record_id?: string;
}
/** @interface QChatServerGetInviteApplyRecordOfSelfParam */
export interface QChatServerGetInviteApplyRecordOfSelfParam {
    /** 起始时间 */
    start_time?: number;
    /** 结束时间 */
    end_time?: number;
    /** 是否倒序, false: 否, true: 是 */
    reverse?: boolean;
    /** 查询条数 */
    limit?: number;
    /** 要排除的记录id */
    exclude_record_id?: string;
}
/** @interface QChatServerMarkReadParam */
export interface QChatServerMarkReadParam {
    /** 服务器 id 列表 */
    server_ids?: Array<string>;
}
/** @interface QChatServerSubscribeAllChannelParam */
export interface QChatServerSubscribeAllChannelParam {
    /** 订阅类型 */
    sub_type: NIMQChatSubscribeType;
    /** 服务器 id 列表 */
    server_ids?: Array<string>;
}