Class BaseClient

Hierarchy (View Summary)

Trapper
- BaseClient
  - icqq.Client

Constructors

constructor

new BaseClient(
    p: icqq.Platform,
    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;
    },
    config: Required<Config>,
): BaseClient
Parameters
- p: icqq.Platform
- 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;
  }
- config: Required<Config>
Returns BaseClient
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:115

Properties

apk

apk: icqq.Apk

config

config: Required<Config>

`Readonly`device

device: icqq.Device

emp_interval

emp_interval: number

token刷新间隔(秒)

`Protected`heartbeat

heartbeat: () => void

随心跳一起触发的函数，可以随意设定

`Protected`interval

interval: number

心跳间隔(秒)

`Protected`login_timer

login_timer: Timeout

`Readonly`pkg

pkg: any

`Readonly`pskey

pskey: { [domain: string]: Buffer<ArrayBufferLike> }

`Readonly`pt4token

pt4token: { [domain: string]: Buffer<ArrayBufferLike> }

`Protected`register_retry_num

register_retry_num: number

上线失败重试次数

`Readonly`sig

sig: Record<string, any>

`Protected`signCmd

signCmd: string[]

`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;
    ver: string;
}

数据统计

`Protected`token_retry_num

token_retry_num: number

token登录重试次数

uid

uid: string

uin

uin: number

Methods

addMatcher

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

bail

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

bailSync

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

buildReserveFields

buildReserveFields(cmd: string, sec_info: any): Buffer
Parameters
- cmd: string
- sec_info: any
Returns Buffer
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:126

calcPoW

calcPoW(data: any): Buffer
Parameters
- data: any
Returns Buffer
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:139

emit

emit(matcher: Matcher, ...args: any[]): void
Parameters
- matcher: Matcher
- ...args: any[]
Returns void
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:121

fetchQrcode

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

Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:160

generateSignPacket

generateSignPacket(sign: String, token: String, extra: String): Buffer
Parameters
- sign: String
- token: String
- extra: String
Returns Buffer
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:134

generateT544Packet

generateT544Packet(cmd: String, sign: Buffer): Buffer
Parameters
- cmd: String
- sign: Buffer
Returns Buffer
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:133

getApiQQVer

getApiQQVer(): Promise<string>
Returns Promise<string>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:130

getApkInfo

getApkInfo(platform: icqq.Platform, ver?: string): icqq.Apk
Parameters
- platform: icqq.Platform
- Optionalver: string
Returns icqq.Apk
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:124

getApkInfoList

getApkInfoList(platform: icqq.Platform): icqq.Apk[]
Parameters
- platform: icqq.Platform
Returns icqq.Apk[]
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:125

getCmdWhiteList

getCmdWhiteList(): Promise<never[]>
Returns Promise<never[]>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:129

getSign

getSign(
    cmd: string,
    seq: number,
    body: Buffer,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- cmd: string
- seq: number
- body: Buffer
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:132

getT544

getT544(cmd: string): Promise<Buffer<ArrayBufferLike>>
Parameters
- cmd: string
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:131

isOnline

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

Returns boolean
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:123

listeners

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

logout

logout(keepalive?: boolean): Promise<void>
下线 (keepalive: 是否保持tcp连接)
Parameters
- Optionalkeepalive: boolean
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:141

off

off(matcher: Matcher): void
Parameters
- matcher: Matcher
Returns void
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:120

offTrap

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

on

on(
name: "internal.qrcode",
listener: (this: this, qrcode: Buffer) => void,
): ToDispose<BaseClient>
收到二维码
Parameters
- name: "internal.qrcode"
- listener: (this: this, qrcode: Buffer) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:39
on(
name: "internal.slider",
listener: (this: this, url: string) => void,
): ToDispose<BaseClient>
收到滑动验证码
Parameters
- name: "internal.slider"
- listener: (this: this, url: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:41
on(
name: "internal.verify",
listener: (this: this, url: string, phone: string) => void,
): ToDispose<BaseClient>
登录保护验证
Parameters
- name: "internal.verify"
- listener: (this: this, url: string, phone: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:43
on(
name: "internal.error.token",
listener: (this: this) => void,
): ToDispose<BaseClient>
token过期(此时已掉线)
Parameters
- name: "internal.error.token"
- listener: (this: this) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:45
on(
name: "internal.error.network",
listener: (this: this, code: number, message: string) => void,
): ToDispose<BaseClient>
网络错误
Parameters
- name: "internal.error.network"
- listener: (this: this, code: number, message: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:47
on(
name: "internal.error.login",
listener: (this: this, code: number, message: string) => void,
): ToDispose<BaseClient>
密码登录相关错误
Parameters
- name: "internal.error.login"
- listener: (this: this, code: number, message: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:49
on(
name: "internal.error.qrcode",
listener: (this: this, code: QrcodeResult, message: string) => void,
): ToDispose<BaseClient>
扫码登录相关错误
Parameters
- name: "internal.error.qrcode"
- listener: (this: this, code: QrcodeResult, message: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:51
on(
    name: "internal.online",
    listener: (
        this: this,
        token: Buffer,
        nickname: string,
        gender: number,
        age: number,
    ) => void,
): ToDispose<BaseClient>
登录成功
Parameters
- name: "internal.online"
- listener: (
      this: this,
      token: Buffer,
      nickname: string,
      gender: number,
      age: number,
  ) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:53
on(
name: "internal.token",
listener: (this: this, token: Buffer) => void,
): ToDispose<BaseClient>
token更新
Parameters
- name: "internal.token"
- listener: (this: this, token: Buffer) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:55
on(
name: "internal.kickoff",
listener: (this: this, reason: string) => void,
): ToDispose<BaseClient>
服务器强制下线
Parameters
- name: "internal.kickoff"
- listener: (this: this, reason: string) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:57
on(
name: "internal.sso",
listener: (this: this, cmd: string, payload: Buffer, seq: number) => void,
): ToDispose<BaseClient>
业务包
Parameters
- name: "internal.sso"
- listener: (this: this, cmd: string, payload: Buffer, seq: number) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:59
on(
name: "internal.verbose",
listener: (this: this, verbose: unknown, level: VerboseLevel) => void,
): ToDispose<BaseClient>
日志信息
Parameters
- name: "internal.verbose"
- listener: (this: this, verbose: unknown, level: VerboseLevel) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:61
on(
name: string | symbol,
listener: (this: this, ...args: any[]) => void,
): ToDispose<BaseClient>
Parameters
- name: string | symbol
- listener: (this: this, ...args: any[]) => void
Returns ToDispose<BaseClient>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:62

once

once(matcher: Matcher, listener: Listener): Dispose
Parameters
- matcher: Matcher
- listener: Listener
Returns Dispose
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:119

passwordLogin

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

qrcodeLogin

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

Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:162

queryQrcodeResult

queryQrcodeResult(): Promise<
    {
        retcode: number;
        t106: Buffer<ArrayBufferLike>;
        t16a: Buffer<ArrayBufferLike>;
        t318: Buffer<ArrayBufferLike>;
        tgtgt: Buffer<ArrayBufferLike>;
        uin: number;
    },
>
获取扫码结果(可定时查询，retcode为0则调用qrcodeLogin登录)

Returns Promise<
    {
        retcode: number;
        t106: Buffer<ArrayBufferLike>;
        t16a: Buffer<ArrayBufferLike>;
        t318: Buffer<ArrayBufferLike>;
        tgtgt: Buffer<ArrayBufferLike>;
        uin: number;
    },
>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:164

refreshToken

refreshToken(force?: boolean): Promise<boolean>
Parameters
- Optionalforce: boolean
Returns Promise<boolean>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:144

register

register(logout?: boolean, reflush?: boolean): Promise<unknown>
Parameters
- Optionallogout: boolean
- Optionalreflush: boolean
Returns Promise<unknown>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:183

requestSignToken

requestSignToken(): Promise<never[]>
Returns Promise<never[]>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:137

requestToken

requestToken(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:136

sendHeartbeat

sendHeartbeat(): Promise<unknown>
Returns Promise<unknown>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:186

sendOidb

sendOidb(
    cmd: string,
    body: Uint8Array,
    timeout?: number,
): Promise<Buffer<ArrayBufferLike>>
dont use it if not clear the usage
Parameters
- cmd: string
- body: Uint8Array
- Optionaltimeout: number
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:178

sendOidbSvcTrpcTcp

sendOidbSvcTrpcTcp(cmd: string, body: Uint8Array): Promise<any>
Parameters
- cmd: string
- body: Uint8Array
Returns Promise<any>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:182

sendPacket

sendPacket(
    type: string,
    cmd: string,
    body: any,
): Promise<Buffer<ArrayBufferLike>>
Parameters
- type: string
- cmd: string
- body: any
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:179

sendSmsCode

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

Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:156

sendUni

sendUni(
    cmd: string,
    body: Uint8Array,
    timeout?: number,
): Promise<Buffer<ArrayBufferLike>>
发送一个业务包并等待返回
Parameters
- cmd: string
- body: Uint8Array
- Optionaltimeout: number
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:181

setRemoteServer

setRemoteServer(host?: string, port?: number): void
设置连接服务器，不设置则自动搜索
Parameters
- Optionalhost: string
- Optionalport: number
Returns void
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:117

setSignServer

setSignServer(addr?: string): Promise<void>
Parameters
- Optionaladdr: string
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:118

ssoPacketListHandler

ssoPacketListHandler(list: Packet[]): Promise<void>
Parameters
- list: Packet[]
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:135

submitSlider

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

submitSmsCode

submitSmsCode(code: string): Promise<void>
提交短信验证码
Parameters
- code: string
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:158

submitSsoPacket

submitSsoPacket(
    cmd: string,
    callbackId: number,
    body: Buffer,
): Promise<Packet[]>
Parameters
- cmd: string
- callbackId: number
- body: Buffer
Returns Promise<Packet[]>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:138

switchQQVer

switchQQVer(ver?: string): Promise<boolean>
Parameters
- Optionalver: string
Returns Promise<boolean>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:127

syncTimeDiff

syncTimeDiff(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:184

terminate

terminate(): void
关闭连接

Returns void
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:143

token_expire

token_expire(data?: any): Promise<void>
Parameters
- Optionaldata: any
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:185

tokenLogin

tokenLogin(token?: Buffer, cmd?: number): Promise<Buffer<ArrayBufferLike>>
使用接收到的token登录
Parameters
- Optionaltoken: Buffer
- Optionalcmd: number
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:146

trap

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

trapOnce

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

trip

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

tripAsync

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

updateCmdWhiteList

updateCmdWhiteList(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:128

writeUni

writeUni(cmd: string, body: Uint8Array, seq?: number): Promise<void>
发送一个业务包不等待返回
Parameters
- cmd: string
- body: Uint8Array
- Optionalseq: number
Returns Promise<void>
- Defined in node_modules/.pnpm/icqq@0.6.10/node_modules/icqq/lib/core/base-client.d.ts:176

Class BaseClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseClient

Properties

apk

config

Readonlydevice

emp_interval

Protectedheartbeat

Protectedinterval

Protectedlogin_timer

Readonlypkg

Readonlypskey

Readonlypt4token

Protectedregister_retry_num

Readonlysig

ProtectedsignCmd

Protected Readonlystatistics

Protectedtoken_retry_num

uid

uin

Methods

addMatcher

Type Parameters

Parameters

Returns ToDispose<T>

bail

Parameters

Returns any

bailSync

Parameters

Returns Promise<any>

buildReserveFields

Parameters

Returns Buffer

calcPoW

Parameters

Returns Buffer

emit

Parameters

Returns void

fetchQrcode

Returns Promise<void>

generateSignPacket

Parameters

Returns Buffer

generateT544Packet

Parameters

Returns Buffer

getApiQQVer

Returns Promise<string>

getApkInfo

Parameters

Returns icqq.Apk

getApkInfoList

Parameters

Returns icqq.Apk[]

getCmdWhiteList

Returns Promise<never[]>

getSign

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

getT544

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

isOnline

Returns boolean

listeners

Parameters

Returns Listener[]

logout

Parameters

Returns Promise<void>

`Readonly`device

`Protected`heartbeat

`Protected`interval

`Protected`login_timer

`Readonly`pkg

`Readonly`pskey

`Readonly`pt4token

`Protected`register_retry_num

`Readonly`sig

`Protected`signCmd

`Protected` `Readonly`statistics

`Protected`token_retry_num

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