@22g/netease-im-web-sdk/lib/sdk/NIM/Error.d.ts

typescript netease-im-web-sdk

import { LiteralUnion } from '@22g/utility-types';
/**
 * 全局错误码
 * - [相关文档](https://dev.yunxin.163.com/docs/interface/即时通讯Web端/NIMSDK-Web/NIMError.html#.codeMap)
 */
export declare const enum NIMErrorCode {
    /** 客户端版本不对, 需升级sdk */
    _201 = "201",
    /** 用户名或密码错误, 请检查appKey和token是否有效, account和token是否匹配 */
    _302 = "302",
    /** 非法操作或没有权限 */
    _403 = "403",
    /** 对象(用户/群/聊天室)不存在 */
    _404 = "404",
    /** 参数长度过长 */
    _405 = "405",
    /** 客户端请求超时 */
    _408 = "408",
    /** 参数错误 */
    _414 = "414",
    /** 服务不可用/没有聊天室服务器可分配 */
    _415 = "415",
    /** 频率控 */
    _416 = "416",
    /** 重复操作 */
    _417 = "417",
    /** 帐号被禁用 */
    _422 = "422",
    /** 服务器内部错误 */
    _500 = "500",
    /** 数据库操作失败 */
    _501 = "501",
    /** 服务器繁忙 */
    _503 = "503",
    /** 删除有效期过了 */
    _508 = "508",
    /** 已失效 */
    _509 = "509",
    /** 被拉黑 */
    _7101 = "7101",
    /** 群人数达到上限 */
    /** 没有权限 */
    _802 = "802",
    /** 群不存在或未发生变化 */
    _803 = "803",
    /** 用户不在群里面 */
    _804 = "804",
    /** 群类型不匹配 */
    _805 = "805",
    /** 创建群数量达到限制 */
    _806 = "806",
    /** 群成员状态不对 */
    _807 = "807",
    /** 已经在群里 */
    _809 = "809",
    /** 强推列表中帐号数量超限 */
    _811 = "811",
    /** 群被禁言 */
    _812 = "812",
    /** 因群数量限制，部分拉人成功 */
    _813 = "813",
    /** 禁止使用群组消息已读服务 */
    _814 = "814",
    /** 群管理员人数上限 */
    _815 = "815",
    /** 协议已失效 */
    _997 = "997",
    /** 解包错误 */
    _998 = "998",
    /** 打包错误 */
    _999 = "999",
    /** 通道失效 */
    _9102 = "9102",
    /** 已经在其他端接听/拒绝过这通电话 */
    _9103 = "9103",
    /** 对方离线, */
    _11001 = "11001",
    /** 聊天室状态异常 */
    _13002 = "13002",
    /** 在黑名单中 */
    _13003 = "13003",
    /** 在禁言名单中 */
    _13004 = "13004",
    /** 聊天室处于整体禁言状态,只有管理员能发言 */
    _13006 = "13006",
    /** 无法建立连接, */
    Connect_Failed = "Connect_Failed",
    /** 网断了 */
    Error_Internet_Disconnected = "Error_Internet_Disconnected",
    /** 连接未建立 */
    Error_Connection_is_not_Established = "Error_Connection_is_not_Established",
    /** socket状态不对 */
    Error_Connection_Socket_State_not_Match = "Error_Connection_Socket_State_not_Match",
    /** 超时 */
    Error_Timeout = "Error_Timeout",
    /** 参数错误 */
    Param_Error = "Param_Error",
    /** 请选择文件 */
    No_File_Selected = "No_File_Selected",
    /** 文件类型错误 */
    Wrong_File_Type = "Wrong_File_Type",
    /** 文件过大 */
    File_Too_Large = "File_Too_Large",
    /** 不能获取跨域Iframe的内容 */
    Cross_Origin_Iframe = "Cross_Origin_Iframe",
    /** 不支持 */
    Not_Support = "Not_Support",
    /** 无数据库 */
    NO_DB = "NO_DB",
    /** 数据库错误 */
    DB = "DB",
    /** 还在群里 */
    Still_In_Team = "Still_In_Team",
    /** 会话已存在 */
    Session_Exist = "Session_Exist",
    /** 会话不存在 */
    Session_Not_Exist = "Session_Not_Exist",
    /** 未知错误 */
    Error_Unknown = "Error_Unknown",
    /** 操作取 */
    Operation_Canceled = "Operation_Canceled"
}
/**
 * 已知的调用函数名
 */
export declare type NIMCallFunc = LiteralUnion<'db::addTask' | 'link::onHeartbeat', string>;
/**
 * IM基础错误信息对象
 * - [相关文档](https://dev.yunxin.163.com/docs/interface/即时通讯Web端/NIMSDK-Web/NIMError)
 */
export interface NIMError {
    /** 错误消息 */
    message: string;
    /** 调用方法 */
    callFunc: NIMCallFunc;
    /** 发生时间(ms) */
    timetag: number;
    /**
     * 错误码
     * - 当接口传入参数格式错误时是没有返回code的
     */
    code?: NIMErrorCode;
    /** 错误事件 */
    event?: Partial<NIMError>;
}