oicq

Index

Namespaces

core

Enumerations

Classes

Type aliases

Variables

segment

Functions

Type aliases

Apk

Apk: typeof mobile

Device

Device: ReturnType<typeof generateFullDevice>

Domain

Gender

Gender: "male" | "female" | "unknown"

性别

GroupRole

GroupRole: "owner" | "admin" | "member"

群内权限

LogLevel

日志等级

MessageElem

注意：只有ChainElem中的元素可以组合发送，其他元素只能单独发送

MusicPlatform

MusicPlatform: "qq" | "163" | "migu" | "kugou" | "kuwo"

支持的音乐平台

Sendable

Sendable: string | MessageElem | (string | MessageElem)[]

可通过sendMsg发送的类型集合 (字符串、元素对象，或它们的数组)

Statistics

Statistics: Client["stat"]

数据统计

Variables

segment

segment: { at: any; bface: any; dice: any; face: any; flash: any; fromCqcode: any; image: any; json: any; location: any; mirai: any; poke: any; record: any; rps: any; sface: any; share: any; text: any; video: any; xml: any } = ...

用于构造消息元素

Type declaration

at:function
- at(qq: string | number, text?: string, dummy?: boolean): AtElem
- - Defined in lib/message/elements.ts:230
  mention@提及
  
  Parameters
  - qq: string | number
    
    全体成员:"all", 频道:tiny_id
  - Optional text: string
  - Optional dummy: boolean
  Returns AtElem
bface:function
- bface(file: string, text: string): BfaceElem
- - Defined in lib/message/elements.ts:210
  原创表情(file规则不明)
  
  Parameters
  - file: string
  - text: string
  Returns BfaceElem
dice:function
- dice(id?: number): MfaceElem
- - Defined in lib/message/elements.ts:222
  骰子(id=1~6)
  
  Parameters
  - Optional id: number
  Returns MfaceElem
face:function
- face(id: number): FaceElem
- - Defined in lib/message/elements.ts:198
  经典表情(id=0~324)
  
  Parameters
  - id: number
  Returns FaceElem
flash:function
- flash(file: string | Buffer | Readable, cache?: boolean, timeout?: number, headers?: OutgoingHttpHeaders): FlashElem
- - Defined in lib/message/elements.ts:248
  闪照(支持http://,base64://)
  
  Parameters
  - file: string | Buffer | Readable
  - Optional cache: boolean
  - Optional timeout: number
  - Optional headers: OutgoingHttpHeaders
  Returns FlashElem
fromCqcode:function
- fromCqcode(str: string): MessageElem[]
- - Defined in lib/message/elements.ts:300
  deprecated
  将CQ码转换为消息链
  
  Parameters
  - str: string
  Returns MessageElem[]
image:function
- image(file: string | Buffer | Readable, cache?: boolean, timeout?: number, headers?: OutgoingHttpHeaders): ImageElem
- - Defined in lib/message/elements.ts:242
  图片(支持http://,base64://)
  
  Parameters
  - file: string | Buffer | Readable
  - Optional cache: boolean
  - Optional timeout: number
  - Optional headers: OutgoingHttpHeaders
  Returns ImageElem
json:function
- json(data: any): JsonElem
- - Defined in lib/message/elements.ts:265
  Parameters
  - data: any
  Returns JsonElem
location:function
- location(lat: number, lng: number, address: string, id?: string): LocationElem
- - Defined in lib/message/elements.ts:288
  位置分享
  
  Parameters
  - lat: number
  - lng: number
  - address: string
  - Optional id: string
  Returns LocationElem
mirai:function
- mirai(data: string): MiraiElem
- - Defined in lib/message/elements.ts:276
  一种特殊消息(官方客户端无法解析)
  
  Parameters
  - data: string
  Returns MiraiElem
poke:function
- poke(id: number): PokeElem
- - Defined in lib/message/elements.ts:294
  id 0~6
  
  Parameters
  - id: number
  Returns PokeElem
record:function
- record(file: string | Buffer): PttElem
- - Defined in lib/message/elements.ts:254
  语音(支持http://,base64://)
  
  Parameters
  - file: string | Buffer
  Returns PttElem
rps:function
- rps(id?: number): MfaceElem
- - Defined in lib/message/elements.ts:216
  猜拳(id=1~3)
  
  Parameters
  - Optional id: number
  Returns MfaceElem
sface:function
- sface(id: number, text?: string): FaceElem
- - Defined in lib/message/elements.ts:204
  小表情(id规则不明)
  
  Parameters
  - id: number
  - Optional text: string
  Returns FaceElem
share:function
- share(url: string, title: string, image?: string, content?: string): ShareElem
- - Defined in lib/message/elements.ts:282
  链接分享
  
  Parameters
  - url: string
  - title: string
  - Optional image: string
  - Optional content: string
  Returns ShareElem
text:function
- text(text: string): TextElem
- - Defined in lib/message/elements.ts:192
  deprecated
  文本，建议直接使用字符串
  
  Parameters
  - text: string
  Returns TextElem
video:function
- video(file: string): VideoElem
- - Defined in lib/message/elements.ts:260
  视频(仅支持本地文件)
  
  Parameters
  - file: string
  Returns VideoElem
xml:function
- xml(data: string, id?: number): XmlElem
- - Defined in lib/message/elements.ts:270
  Parameters
  - data: string
  - Optional id: number
  Returns XmlElem

Functions

createClient

createClient(uin: number, config?: Config): Client

- Defined in lib/client.ts:653
创建一个客户端 (=new Client)

Parameters
- uin: number
- Optional config: Config
Returns Client

getGroupImageUrl

getGroupImageUrl(md5: string): string

- Defined in lib/message/parser.ts:337
Parameters
- md5: string
Returns string

parseDmMessageId

parseDmMessageId(msgid: string): { flag: number; rand: number; seq: number; time: number; user_id: number }

- Defined in lib/message/message.ts:38
cqhttp
解析私聊消息id

Parameters
- msgid: string
Returns { flag: number; rand: number; seq: number; time: number; user_id: number }
- flag: number
- rand: number
- seq: number
- time: number
- user_id: number

parseGroupMessageId

parseGroupMessageId(msgid: string): { group_id: number; pktnum: number; rand: number; seq: number; time: number; user_id: number }

- Defined in lib/message/message.ts:61
cqhttp
解析群消息id

Parameters
- msgid: string
Returns { group_id: number; pktnum: number; rand: number; seq: number; time: number; user_id: number }
- group_id: number
- pktnum: number
- rand: number
- seq: number
- time: number
- user_id: number

parseImageFileParam

parseImageFileParam(file: string): { ext: string; height: number; md5: string; size: number; width: number }

- Defined in lib/message/image.ts:42
从图片的file中解析出图片属性参数

Parameters
- file: string
Returns { ext: string; height: number; md5: string; size: number; width: number }
- ext: string
- height: number
- md5: string
- size: number
- width: number

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Apk

Device

Domain

Gender

GroupRole

LogLevel

MessageElem

MusicPlatform

Sendable

Statistics

Variables

segment

Type declaration

at:function

Parameters

qq: string | number

Optional text: string

Optional dummy: boolean

Returns AtElem

bface:function

Parameters

file: string

text: string

Returns BfaceElem

dice:function

Parameters

Optional id: number

Returns MfaceElem

face:function

Parameters

id: number

Returns FaceElem

flash:function

Parameters

file: string | Buffer | Readable

Optional cache: boolean

Optional timeout: number

Optional headers: OutgoingHttpHeaders

Returns FlashElem

fromCqcode:function

Parameters

str: string

Returns MessageElem[]

image:function

Parameters

file: string | Buffer | Readable

Optional cache: boolean

Optional timeout: number

Optional headers: OutgoingHttpHeaders

Returns ImageElem

json:function

Parameters

data: any

Returns JsonElem

location:function

Parameters

lat: number

lng: number

address: string

Optional id: string

Returns LocationElem

mirai:function

Parameters

data: string

Returns MiraiElem

poke:function

Parameters

id: number

Returns PokeElem

record:function

Parameters