Skip to content

service error

为了统一错误信息,所有插件返回错误的时候都按照以下格式

属性类型说明
typestring错误类型,可设置为下方错误之一
messagestring错误描述,用于展示给用户看
additionany附加信息,可以是任何可 json 序列化的数据类型,用于 debug
troubleshootingLinkstring故障排除的链接,目前主要用在插件验证的功能 Bob 1.6.0+ 可用

错误类型(type)如下:

  • unknown 未知错误
  • param 参数错误
  • unsupportedLanguage 不支持的语言
  • secretKey 未设置秘钥
  • network 请求服务器异常(网络连接失败、服务器返回 HTTP 状态码异常等)
  • api 服务异常(接口返回数据异常等)
  • notFound 服务调用过程未出错,但是未查询到结果;例如词典不包含某个词汇

请尽量将错误类型(type)设置正确,如果实在不知道错误类型归为哪一类,type 可设置为 unknown,但一定要设置好 message,用于提示

针对文本翻译类型的插件,如果翻译出错返回错误类型为 unsupportedLanguagenotFound,Bob 会自动将该插件对应的翻译视图折叠起来。