Class BaseClient

constructor

• new BaseClient(p?, d, config): BaseClient

• Parameters

  • p: Platform = Platform.Android
  • d: {
        --begin--: string;
        --end--: string;
        android_id: string;
        board: string;
        boot_id: string;
        bootloader: string;
        brand: string;
        device: string;
        display: string;
        incremental: string;
        ip_address: string;
        mac_address: string;
        model: string;
        proc_version: string;
        product: string;
        wifi_ssid: string;
    }

    • --begin--: string

    • --end--: string

    • android_id: string

    • board: string

    • boot_id: string

    • bootloader: string

    • brand: string

    • device: string

    • display: string

    • incremental: string

    • ip_address: string

    • mac_address: string

    • model: string

    • proc_version: string

    • product: string

    • wifi_ssid: string

  • config: Required<Config>

  Returns BaseClient

apk

config

Readonlydevice

emp_interval

nickname

Readonlypkg

Readonlypskey

Readonlypt4token

QQNT

Readonlysig

sign_type

uid

uin

defaultCmdWhiteList

• get defaultCmdWhiteList(): string[]

• Returns string[]

useQQNT

• get useQQNT(): boolean

• Returns boolean

apiPing

• apiPing(pathname): Promise<{
      code: number;
  }>

• Parameters

  • pathname: string

  Returns Promise<{
      code: number;
  }>

emit

• emit(matcher, ...args): void

• Parameters

  • matcher: Matcher
  • Rest...args: any[]

  Returns void

fetchLogin

• fetchLogin(sig): Promise<{
      qrsig: any;
      retcode: any;
      t: {
          [tag: number]: Buffer;
      };
  } | {
      qrsig: Buffer;
      retcode: number;
      t: undefined;
  }>

• Parameters

  • sig: Buffer

  Returns Promise<{
      qrsig: any;
      retcode: any;
      t: {
          [tag: number]: Buffer;
      };
  } | {
      qrsig: Buffer;
      retcode: number;
      t: undefined;
  }>

fetchQrcode

• fetchQrcode(): Promise<void>

• 获取登录二维码

  Returns Promise<void>

generateSignPacket

• generateSignPacket(sign, token, extra): Buffer

• Parameters

  • sign: String
  • token: String
  • extra: String

  Returns Buffer

generateT544Packet

• generateT544Packet(cmd, sign): Buffer

• Parameters

  • cmd: String
  • sign: Buffer

  Returns Buffer

getApiQQVer

• getApiQQVer(): Promise<string>

• Returns Promise<string>

getApkInfo

• getApkInfo(platform, ver?): Apk

• Parameters

  • platform: Platform
  • Optionalver: string

  Returns Apk

getApkInfoList

• getApkInfoList(platform): Apk[]

• Parameters

  • platform: Platform

  Returns Apk[]

getCmdWhiteList

• getCmdWhiteList(): Promise<string[]>

• Returns Promise<string[]>

getSign

• getSign(cmd, seq, body): Promise<Buffer>

• Parameters

  • cmd: string
  • seq: number
  • body: Buffer

  Returns Promise<Buffer>

getT544

• getT544(cmd): Promise<Buffer>

• Parameters

  • cmd: string

  Returns Promise<Buffer>

isOnline

• isOnline(): boolean

• 是否为在线状态 (可以收发业务包的状态)

  Returns boolean

keyExchange

• keyExchange(): Promise<void>

• Returns Promise<void>

logout

• logout(keepalive?): Promise<void>

• 下线 (keepalive: 是否保持tcp连接)

  Parameters

  • keepalive: boolean = false

  Returns Promise<void>

ntPasswordLogin

• ntPasswordLogin(md5pass): Promise<void>

• Parameters

  • md5pass: Buffer

  Returns Promise<void>

ntSubmitCaptcha

• ntSubmitCaptcha(ticket, randStr): Promise<void>

• Parameters

  • ticket: string
  • randStr: string

  Returns Promise<void>

ntTokenLogin

• ntTokenLogin(refresh?): Promise<Buffer>

• Parameters

  • refresh: boolean = false

  Returns Promise<Buffer>

off

• off(matcher): void

• Parameters

  • matcher: Matcher

  Returns void

on

• on(name, listener): ToDispose<BaseClient>

• 收到二维码

  Parameters

  • name: "internal.qrcode"
  • listener: ((this: this, qrcode: Buffer, qrInfo: Proto) => void)
    • • (this, qrcode, qrInfo): void

      • Parameters

        • this: this
        • qrcode: Buffer
        • qrInfo: Proto

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 收到滑动验证码

  Parameters

  • name: "internal.slider"
  • listener: ((this: this, url: string) => void)
    • • (this, url): void

      • Parameters

        • this: this
        • url: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 登录保护验证

  Parameters

  • name: "internal.verify"
  • listener: ((this: this, url: string, phone?: string) => void)
    • • (this, url, phone?): void

      • Parameters

        • this: this
        • url: string
        • Optionalphone: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 身份验证事件

  Parameters

  • name: "internal.auth"
  • listener: ((this: this, info: {
        content: string;
        jump?: {
            url: string;
            word: string;
        };
        title: string;
    }) => void)
    • • (this, info): void

      • Parameters

        • this: this
        • info: {
              content: string;
              jump?: {
                  url: string;
                  word: string;
              };
              title: string;
          }

          • content: string

          • Optionaljump?: {
                url: string;
                word: string;
            }

            • url: string

            • word: string

          • title: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• token过期(此时已掉线)

  Parameters

  • name: "internal.error.token"
  • listener: ((this: this) => void)
    • • (this): void

      • Parameters

        • this: this

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 网络错误

  Parameters

  • name: "internal.error.network"
  • listener: ((this: this, code: number, message: string) => void)
    • • (this, code, message): void

      • Parameters

        • this: this
        • code: number
        • message: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 密码登录相关错误

  Parameters

  • name: "internal.error.login"
  • listener: ((this: this, code: number, message: string) => void)
    • • (this, code, message): void

      • Parameters

        • this: this
        • code: number
        • message: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 扫码登录相关错误

  Parameters

  • name: "internal.error.qrcode"
  • listener: ((this: this, code: QrcodeResult, message: string) => void)
    • • (this, code, message): void

      • Parameters

        • this: this
        • code: QrcodeResult
        • message: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 登录成功

  Parameters

  • name: "internal.online"
  • listener: ((this: this, token: Buffer, nickname: string) => void)
    • • (this, token, nickname): void

      • Parameters

        • this: this
        • token: Buffer
        • nickname: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• token更新

  Parameters

  • name: "internal.token"
  • listener: ((this: this, token: Buffer) => void)
    • • (this, token): void

      • Parameters

        • this: this
        • token: Buffer

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 下线

  Parameters

  • name: "internal.offline"
  • listener: ((this: this, reason: string) => void)
    • • (this, reason): void

      • Parameters

        • this: this
        • reason: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 服务器强制下线

  Parameters

  • name: "internal.kickoff"
  • listener: ((this: this, reason: string) => void)
    • • (this, reason): void

      • Parameters

        • this: this
        • reason: string

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 业务包

  Parameters

  • name: "internal.sso"
  • listener: ((this: this, cmd: string, payload: Buffer, seq: number) => void)
    • • (this, cmd, payload, seq): void

      • Parameters

        • this: this
        • cmd: string
        • payload: Buffer
        • seq: number

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• 日志信息

  Parameters

  • name: "internal.verbose"
  • listener: ((this: this, verbose: unknown, level: VerboseLevel) => void)
    • • (this, verbose, level): void

      • Parameters

        • this: this
        • verbose: unknown
        • level: VerboseLevel

        Returns void

  Returns ToDispose<BaseClient>
• on(name, listener): ToDispose<BaseClient>

• Parameters

  • name: string | symbol
  • listener: ((this: this, ...args: any[]) => void)
    • • (this, ...args): void

      • Parameters

        • this: this
        • Rest...args: any[]

        Returns void

  Returns ToDispose<BaseClient>

• on(matcher, listener): ToDispose<BaseClient>

• Parameters

  • matcher: Matcher
  • listener: Listener

  Returns ToDispose<BaseClient>

once

• once(matcher, listener): Dispose

• Parameters

  • matcher: Matcher
  • listener: Listener

  Returns Dispose

passwordLogin

• passwordLogin(uin, md5pass): Promise<void>

• 使用密码登录

  Parameters

  • uin: number

    登录账号
  • md5pass: Buffer

    密码的md5值

  Returns Promise<void>

qrcodeLogin

• qrcodeLogin(): Promise<void>

• 扫码后调用此方法登录

  Returns Promise<void>

queryQrcodeResult

• queryQrcodeResult(): Promise<{
      retcode: number;
      t106: undefined | Buffer;
      t16a: undefined | Buffer;
      t318: undefined | Buffer;
      tgtgt: undefined | Buffer;
      uin: undefined | number;
  }>

• 获取扫码结果(可定时查询，retcode为0则调用qrcodeLogin登录)

  Returns Promise<{
      retcode: number;
      t106: undefined | Buffer;
      t16a: undefined | Buffer;
      t318: undefined | Buffer;
      tgtgt: undefined | Buffer;
      uin: undefined | number;
  }>

refreshToken

• refreshToken(force?): Promise<undefined | boolean>

• Parameters

  • force: boolean = false

  Returns Promise<undefined | boolean>

register

• register(logout?, reflush?): Promise<number>

• Parameters

  • logout: boolean = false
  • reflush: boolean = false

  Returns Promise<number>

requestSignToken

• requestSignToken(): Promise<never[]>

• Returns Promise<never[]>

requestToken

• requestToken(): Promise<void>

• Returns Promise<void>

sendHeartbeat

• sendHeartbeat(): Promise<unknown>

• Returns Promise<unknown>

sendMergeUni

• sendMergeUni(list, timeout?, extra?): Promise<unknown>

• 多个业务包合并发送

  Parameters

  • list: {
        body: Uint8Array;
        cmd: string;
        needResp?: boolean;
        seq?: number;
    }[]

    业务包列表（等待返回包时seq参数自动生成，填写无效）
  • timeout: number = 6

    超时时间（秒），默认6秒，为0时不等待返回
  • Optionalextra: any

  Returns Promise<unknown>

sendOidb

• sendOidb(cmd, body, timeout?, extra?): Promise<Buffer>

• dont use it if not clear the usage

  Parameters

  • cmd: string
  • body: object | Uint8Array
  • timeout: number = 6
  • Optionalextra: any

  Returns Promise<Buffer>

sendOidbSvcTrpcTcp

• sendOidbSvcTrpcTcp(cmd, body, extra?): Promise<Proto>

• Parameters

  • cmd: string | object[]
  • body: object | Uint8Array
  • Optionalextra: any

  Returns Promise<Proto>

sendPacket

• sendPacket(body, timeout?, seq?, build?): Promise<Buffer>

• Parameters

  • body: Buffer | Uint8Array
  • timeout: number = 6
  • seq: number = -1
  • Optionalbuild: {
        cmd: string;
        encrypt: PacketEncrypt;
        extra?: any;
        type: PacketType;
    }

    • cmd: string

    • encrypt: PacketEncrypt

    • Optionalextra?: any

    • type: PacketType

  Returns Promise<Buffer>

sendSmsCode

• sendSmsCode(): Promise<void>

• 收到设备锁验证请求后，用于发短信

  Returns Promise<void>

sendSsoHeartBeat

• sendSsoHeartBeat(): false | Promise<unknown>

• Returns false | Promise<unknown>

sendUni

• sendUni(cmd, body, timeout?, extra?): Promise<Buffer>

• 发送一个业务包并等待返回

  Parameters

  • cmd: string
  • body: Uint8Array
  • timeout: number = 6
  • Optionalextra: any

  Returns Promise<Buffer>

setRemoteServer

• setRemoteServer(host?, port?): void

• 设置连接服务器，不设置则自动搜索

  Parameters

  • Optionalhost: string
  • Optionalport: number

  Returns void

setSignServer

• setSignServer(addr, extSign?): void

• Parameters

  • addr: string
  • extSign: Partial<__module> & Required<Pick<__module, "sign_type">> = ...

  Returns void

ssoPacketListHandler

• ssoPacketListHandler(list): Promise<void>

• Parameters

  • list: null | Packet[]

  Returns Promise<void>

startSsoHeartBeat

• startSsoHeartBeat(): void

• Returns void

submitSlider

• submitSlider(ticket): Promise<void>

• 收到滑动验证码后，用于提交滑动验证码

  Parameters

  • ticket: string

  Returns Promise<void>

submitSmsCode

• submitSmsCode(code): Promise<void>

• 提交短信验证码

  Parameters

  • code: string

  Returns Promise<void>

submitSsoPacket

• submitSsoPacket(cmd, callbackId, body): Promise<Packet[]>

• Parameters

  • cmd: string
  • callbackId: number
  • body: Buffer

  Returns Promise<Packet[]>

switchQQVer

• switchQQVer(ver?, force?): Promise<boolean>

• Parameters

  • ver: string = ""
  • Optionalforce: boolean

  Returns Promise<boolean>

syncTimeDiff

• syncTimeDiff(): void

• Returns void

terminate

• terminate(): void

• 关闭连接

  Returns void

token_expire

• token_expire(data?): Promise<void>

• Parameters

  • data: any = {}

  Returns Promise<void>

tokenLogin

• tokenLogin(token?, subcmd?): Promise<Buffer>

• 使用接收到的token登录

  Parameters

  • token: Buffer = BUF0
  • subcmd: number = 15

  Returns Promise<Buffer>

updateCmdWhiteList

• updateCmdWhiteList(): Promise<void>

• Returns Promise<void>

writeUni

• writeUni(cmd, body, seq?, extra?): Promise<void>

• 发送一个业务包不等待返回

  Parameters

  • cmd: string
  • body: Uint8Array
  • seq: number = -1
  • Optionalextra: any

  Returns Promise<void>