Class BaseClient

Hierarchy

Trapper
- BaseClient
  - Client

Constructors

constructor

new BaseClient(p?, d?): BaseClient
Parameters
- p: Platform = Platform.Android
- Optional d: {
      --begin--: string;
      --end--: string;
      android_id: string;
      board: string;
      boot_id: string;
      bootloader: string;
      brand: string;
      device: string;
      imei: 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
  - imei: string
  - incremental: string
  - ip_address: string
  - mac_address: string
  - model: string
  - proc_version: string
  - product: string
  - wifi_ssid: string
Returns BaseClient
- Defined in lib/core/base-client.ts:163

Properties

`Private` [ECDH]

[ECDH]: default = ...

`Private` `Readonly` [HANDLERS]

[HANDLERS]: Map<number, ((buf) => void)> = ...

Type declaration

- (buf): void
- Parameters
  - buf: Buffer
  Returns void

`Private` [HEARTBEAT]

[HEARTBEAT]: Timeout

`Private` [IS_ONLINE]

[IS_ONLINE]: boolean = false

`Private` [LOGIN_LOCK]

[LOGIN_LOCK]: boolean = false

`Private` `Readonly` [NET]

[NET]: default = ...

`Readonly` apk

apk: {
    app_key: string;
    appid: number;
    bitmap: number;
    buildtime: number;
    display: string;
    id: string;
    main_sig_map: number;
    name: string;
    sdkver: string;
    sign: Buffer;
    ssover: number;
    sub_sig_map: number;
    subid: number;
    ver: string;
    version: string;
}

Type declaration

app_key: string
appid: number
bitmap: number
buildtime: number
display: string
id: string
main_sig_map: number
name: string
sdkver: string
sign: Buffer
ssover: number
sub_sig_map: number
subid: number
ver: string
version: string

`Readonly` config

config: any

`Readonly` device

device: Device

`Protected` heartbeat

heartbeat: (() => void) = NOOP

Type declaration

- (): void
- 随心跳一起触发的函数，可以随意设定
  
  Returns void

`Protected` interval

interval: number = 30

心跳间隔(秒)

logger

logger: Logger

`Readonly` pskey

pskey: {
[domain: string]: Buffer;
} = {}

Type declaration

[domain: string]: Buffer

`Readonly` pt4token

pt4token: {
[domain: string]: Buffer;
} = {}

Type declaration

[domain: string]: Buffer

`Readonly` sig

sig: Record<string, any> = ...

`Protected` `Readonly` statistics

statistics: {
    lost_pkt_cnt: number;
    lost_times: number;
    msg_cnt_per_min: number;
    recv_msg_cnt: number;
    recv_pkt_cnt: number;
    remote_ip: string;
    remote_port: number;
    sent_msg_cnt: number;
    sent_pkt_cnt: number;
    start_time: number;
} = ...

数据统计

Type declaration

lost_pkt_cnt: number
lost_times: number
msg_cnt_per_min: number
recv_msg_cnt: number
recv_pkt_cnt: number
remote_ip: string
remote_port: number
sent_msg_cnt: number
sent_pkt_cnt: number
start_time: number

uin

uin: number

Methods

`Private` [FN_NEXT_SEQ]

[FN_NEXT_SEQ](): any
Returns any
- Defined in lib/core/base-client.ts:626

`Private` [FN_SEND]

[FN_SEND](pkt, timeout?): Promise<Buffer>
Parameters
- pkt: Uint8Array
- timeout: number = 5
Returns Promise<Buffer>
- Defined in lib/core/base-client.ts:632

`Private` [FN_SEND_LOGIN]

[FN_SEND_LOGIN](cmd, body): Promise<void>
Parameters
- cmd: LoginCmd
- body: Buffer
Returns Promise<void>
- Defined in lib/core/base-client.ts:653

addMatcher

addMatcher<T>(this, matcher, listener): ToDispose<T>
Type Parameters
- T extends Trapper<T> = this
Parameters
- this: T
- matcher: Matcher
- listener: Listener
Returns ToDispose<T>
- Defined in node_modules/triptrap/lib/index.d.ts:14

bail

bail(matcher, ...args): any
Parameters
- matcher: Matcher
- Rest ...args: any[]
Returns any
- Defined in node_modules/triptrap/lib/index.d.ts:20

bailSync

bailSync(matcher, ...args): Promise<any>
Parameters
- matcher: Matcher
- Rest ...args: any[]
Returns Promise<any>
- Defined in node_modules/triptrap/lib/index.d.ts:19

calcPoW

calcPoW(data): Buffer
Parameters
- data: any
Returns Buffer
- Defined in lib/core/base-client.ts:225

emit

emit(matcher, ...args): void
Parameters
- matcher: Matcher
- Rest ...args: any[]
Returns void
- Defined in lib/core/base-client.ts:216

fetchQrcode

fetchQrcode(): void
获取登录二维码

Returns void
- Defined in lib/core/base-client.ts:478

isOnline

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

Returns boolean
- Defined in lib/core/base-client.ts:221

listeners

listeners(matcher?): Listener[]
Parameters
- Optional matcher: Matcher
Returns Listener[]
- Defined in node_modules/triptrap/lib/index.d.ts:12

logout

logout(keepalive?): Promise<void>
下线 (keepalive: 是否保持tcp连接)
Parameters
- keepalive: boolean = false
Returns Promise<void>
- Defined in lib/core/base-client.ts:292

off

off(matcher): void
Parameters
- matcher: Matcher
Returns void
- Defined in lib/core/base-client.ts:212

offTrap

offTrap(matcher, listener?): void
Parameters
- matcher: Matcher
- Optional listener: Listener
Returns void
- Defined in node_modules/triptrap/lib/index.d.ts:16

on

on(name, listener): ToDispose<BaseClient>
收到二维码
Parameters
- name: "internal.qrcode"
- listener: ((this, qrcode) => void)
  - - (this, qrcode): void
    - Parameters
      
      this: BaseClient
      
      qrcode: Buffer
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:53
on(name, listener): ToDispose<BaseClient>
收到滑动验证码
Parameters
- name: "internal.slider"
- listener: ((this, url) => void)
  - - (this, url): void
    - Parameters
      
      this: BaseClient
      
      url: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:56
on(name, listener): ToDispose<BaseClient>
登录保护验证
Parameters
- name: "internal.verify"
- listener: ((this, url, phone) => void)
  - - (this, url, phone): void
    - Parameters
      
      this: BaseClient
      
      url: string
      
      phone: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:59
on(name, listener): ToDispose<BaseClient>
token过期(此时已掉线)
Parameters
- name: "internal.error.token"
- listener: ((this) => void)
  - - (this): void
    - Parameters
      
      this: BaseClient
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:62
on(name, listener): ToDispose<BaseClient>
网络错误
Parameters
- name: "internal.error.network"
- listener: ((this, code, message) => void)
  - - (this, code, message): void
    - Parameters
      
      this: BaseClient
      
      code: number
      
      message: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:65
on(name, listener): ToDispose<BaseClient>
密码登录相关错误
Parameters
- name: "internal.error.login"
- listener: ((this, code, message) => void)
  - - (this, code, message): void
    - Parameters
      
      this: BaseClient
      
      code: number
      
      message: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:68
on(name, listener): ToDispose<BaseClient>
扫码登录相关错误
Parameters
- name: "internal.error.qrcode"
- listener: ((this, code, message) => void)
  - - (this, code, message): void
    - Parameters
      
      this: BaseClient
      
      code: QrcodeResult
      
      message: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:71
on(name, listener): ToDispose<BaseClient>
登录成功
Parameters
- name: "internal.online"
- listener: ((this, token, nickname, gender, age) => void)
  - - (this, token, nickname, gender, age): void
    - Parameters
      
      this: BaseClient
      
      token: Buffer
      
      nickname: string
      
      gender: number
      
      age: number
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:74
on(name, listener): ToDispose<BaseClient>
token更新
Parameters
- name: "internal.token"
- listener: ((this, token) => void)
  - - (this, token): void
    - Parameters
      
      this: BaseClient
      
      token: Buffer
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:77
on(name, listener): ToDispose<BaseClient>
服务器强制下线
Parameters
- name: "internal.kickoff"
- listener: ((this, reason) => void)
  - - (this, reason): void
    - Parameters
      
      this: BaseClient
      
      reason: string
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:80
on(name, listener): ToDispose<BaseClient>
业务包
Parameters
- name: "internal.sso"
- listener: ((this, cmd, payload, seq) => void)
  - - (this, cmd, payload, seq): void
    - Parameters
      
      this: BaseClient
      
      cmd: string
      
      payload: Buffer
      
      seq: number
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:83
on(name, listener): ToDispose<BaseClient>
日志信息
Parameters
- name: "internal.verbose"
- listener: ((this, verbose, level) => void)
  - - (this, verbose, level): void
    - Parameters
      
      this: BaseClient
      
      verbose: unknown
      
      level: VerboseLevel
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:86
on(name, listener): ToDispose<BaseClient>
Parameters
- name: string | symbol
- listener: ((this, ...args) => void)
  - - (this, ...args): void
    - Parameters
      
      this: BaseClient
      
      Rest ...args: any[]
      
      Returns void
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:88
on(matcher, listener): ToDispose<BaseClient>
Parameters
- matcher: Matcher
- listener: Listener
Returns ToDispose<BaseClient>
- Defined in lib/core/base-client.ts:204

once

once(matcher, listener): Dispose
Parameters
- matcher: Matcher
- listener: Listener
Returns Dispose
- Defined in lib/core/base-client.ts:208

passwordLogin

passwordLogin(uin, md5pass): Promise<void>
使用密码登录
Parameters
- uin: number
  
  登录账号
- md5pass: Buffer
  
  密码的md5值
Returns Promise<void>
- Defined in lib/core/base-client.ts:361

qrcodeLogin

qrcodeLogin(): Promise<void>
扫码后调用此方法登录

Returns Promise<void>
- Defined in lib/core/base-client.ts:513

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;
}>
- Defined in lib/core/base-client.ts:578

sendOidb

sendOidb(cmd, body, timeout?): Promise<Buffer>
dont use it if not clear the usage
Parameters
- cmd: string
- body: Uint8Array
- timeout: number = 5
Returns Promise<Buffer>
- Defined in lib/core/base-client.ts:675

sendOidbSvcTrpcTcp

sendOidbSvcTrpcTcp(cmd, body): Promise<any>
Parameters
- cmd: string
- body: Uint8Array
Returns Promise<any>
- Defined in lib/core/base-client.ts:703

sendPacket

sendPacket(type, cmd, body): Promise<Buffer>
Parameters
- type: string
- cmd: string
- body: any
Returns Promise<Buffer>
- Defined in lib/core/base-client.ts:691

sendSmsCode

sendSmsCode(): void
收到设备锁验证请求后，用于发短信

Returns void
- Defined in lib/core/base-client.ts:436

sendUni

sendUni(cmd, body, timeout?): Promise<Buffer>
发送一个业务包并等待返回
Parameters
- cmd: string
- body: Uint8Array
- timeout: number = 5
Returns Promise<Buffer>
- Defined in lib/core/base-client.ts:697

setRemoteServer

setRemoteServer(host?, port?): void
设置连接服务器，不设置则自动搜索
Parameters
- Optional host: string
- Optional port: number
Returns void
- Defined in lib/core/base-client.ts:194

submitSlider

submitSlider(ticket): Promise<void>
收到滑动验证码后，用于提交滑动验证码
Parameters
- ticket: string
Returns Promise<void>
- Defined in lib/core/base-client.ts:413

submitSmsCode

submitSmsCode(code): Promise<void>
提交短信验证码
Parameters
- code: string
Returns Promise<void>
- Defined in lib/core/base-client.ts:454

terminate

terminate(): void
关闭连接

Returns void
- Defined in lib/core/base-client.ts:301

tokenLogin

tokenLogin(token): Promise<void>
使用接收到的token登录
Parameters
- token: Buffer
Returns Promise<void>
- Defined in lib/core/base-client.ts:307

trap

trap(matcher, listener): ToDispose<BaseClient>
Parameters
- matcher: Matcher
- listener: Listener
Returns ToDispose<BaseClient>
- Defined in node_modules/triptrap/lib/index.d.ts:13

trapOnce

trapOnce(matcher, listener): Dispose
Parameters
- matcher: Matcher
- listener: Listener
Returns Dispose
- Defined in node_modules/triptrap/lib/index.d.ts:15

trip

trip(matcher, ...args): void
Parameters
- matcher: Matcher
- Rest ...args: any[]
Returns void
- Defined in node_modules/triptrap/lib/index.d.ts:18

tripAsync

tripAsync(matcher, ...args): Promise<void>
Parameters
- matcher: Matcher
- Rest ...args: any[]
Returns Promise<void>
- Defined in node_modules/triptrap/lib/index.d.ts:17

writeUni

writeUni(cmd, body, seq?): void
发送一个业务包不等待返回
Parameters
- cmd: string
- body: Uint8Array
- seq: number = 0
Returns void
- Defined in lib/core/base-client.ts:669

Class BaseClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

p: Platform = Platform.Android

--begin--: string

--end--: string

android_id: string

board: string

boot_id: string

bootloader: string

brand: string

device: string

imei: string

incremental: string

ip_address: string

mac_address: string

model: string

proc_version: string

product: string

wifi_ssid: string

Returns BaseClient

Properties

Private [ECDH]

Private Readonly [HANDLERS]

Type declaration

Parameters

buf: Buffer

Returns void

Private [HEARTBEAT]

Private [IS_ONLINE]

Private [LOGIN_LOCK]

Private Readonly [NET]

Readonly apk

Type declaration

app_key: string

appid: number

bitmap: number

buildtime: number

display: string

id: string

main_sig_map: number

name: string

sdkver: string

sign: Buffer

ssover: number

sub_sig_map: number

subid: number

ver: string

version: string

Readonly config

Readonly device

Protected heartbeat

Type declaration

Returns void

Protected interval

logger

Readonly pskey

Type declaration

[domain: string]: Buffer

Readonly pt4token

Type declaration

[domain: string]: Buffer

Readonly sig

Protected Readonly statistics

Type declaration

lost_pkt_cnt: number

lost_times: number

msg_cnt_per_min: number

recv_msg_cnt: number

recv_pkt_cnt: number

remote_ip: string

remote_port: number

sent_msg_cnt: number

sent_pkt_cnt: number

`Private` [ECDH]

`Private` `Readonly` [HANDLERS]

`Private` [HEARTBEAT]

`Private` [IS_ONLINE]

`Private` [LOGIN_LOCK]

`Private` `Readonly` [NET]

`Readonly` apk

`Readonly` config

`Readonly` device

`Protected` heartbeat

`Protected` interval

`Readonly` pskey

`Readonly` pt4token

`Readonly` sig

`Protected` `Readonly` statistics

`Private` [FN_NEXT_SEQ]

`Private` [FN_SEND]

`Private` [FN_SEND_LOGIN]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` matcher: Matcher

`Optional` listener: Listener