Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MiscInterface

杂项 API

Hierarchy

  • MiscInterface

Implemented by

Index

Methods

Methods

filterClientAntispam

  • filterClientAntispam(options: { content: string }): { code: number; content: string; errmsg: string; result: string; type: number }

  • 检查客户端反垃圾。客户端反垃圾具体用法请参考 反垃圾(内容审核)

    注: 调用此接口前，需要调用过一次 getClientAntispamLexicon 来获取反垃圾词库. 否则会出现 404 没有反垃圾词库

    示例场景

    Parameters

    • options: { content: string }
      • content: string

        待检查文本.

    Returns { code: number; content: string; errmsg: string; result: string; type: number }

    • code: number

      请求的处理状态

    • content: string

      待检查文本.

    • errmsg: string

      建议处理提示

    • result: string

      建议放行的文本

    • type: number

      建议处理类型

      0 放行. 1 对特殊字符过了过滤后放行 2 建议拒绝发送 3 命中客户端反垃圾，交给服务器处理，在发送消息时带上 clientAntiSpam 字段来表示命中.

getClientAntispamLexicon

  • getClientAntispamLexicon(options: { done: any }): void

  • 获取反垃圾词库。开发者可以通过此接口获取反垃圾的词库。调用后，词库加载后会自动保存在内存中

    详细用法请参考: 反垃圾(内容审核)

    示例场景

    Parameters

    • options: { done: any }
      • done:function
        • done(err: null | NIMCommonError | Error | NIMStrAnyObj, data: { clientAntispam: { md5: string; nosurl: string; thesaurus: string; version: string } }): void

        • Parameters

          • err: null | NIMCommonError | Error | NIMStrAnyObj
          • data: { clientAntispam: { md5: string; nosurl: string; thesaurus: string; version: string } }
            • clientAntispam: { md5: string; nosurl: string; thesaurus: string; version: string }
              • md5: string

                词库文件的md5

              • nosurl: string

                词库文件的下载地址

              • thesaurus: string

                词库内容, 可以被解析为 JSON 对象

              • version: string

                词库版本

          Returns void

    Returns void

getDBLastOpenError

  • getDBLastOpenError(): null | Error

  • 获取近期 DB 打开失败的原因

    注: 当 DBStatus 为 0(NIM_DB_STATUS_CLOSED) 时, 若通过此接口获取到了 Error 对象, 那么说明 DB 打开失败了.

    注: 注意是同步接口

    示例

    var error = nim.getDBLastOpenError()
    if (error) {
      console.log('数据库打开失败原因', error.message)
    }

    Returns null | Error

getDBStatus

  • 查询 DB 状态

    注: 注意是同步接口

    示例

    var status = nim.getDBStatus()
    if (status === 2) {
      console.log('数据库已打开')
    } else if (status === 1) {
      console.log('数据库打开中')
    } else {
      console.log('数据库未打开')
    }

    Returns NIMDBStatus

getServerTime

  • getServerTime(options: { done: any }): void

  • 获取服务器时间戳（毫秒）

    示例

    nim.getServerTime({
      done: function(err, timestamp) {
        if (err) {
          console.log('获取服务器时间失败', err)
        } else {
          console.log('服务器时间戳', timestamp)
          console.log('服务器时间', new Date(timestamp))
        }
      }
    })

    Parameters

    Returns void

reinitDB

  • reinitDB(options: { done: any }): void

  • 重建 DB 函数.

    示例

    nim.reinitDB({
      done: function(err) {
        if (err) {
          console.log('重建数据库失败', err)
        } else {
          console.log('重建数据库成功')
        }
      }
    })

    Parameters

    Returns void