Class Mirai

constructor

• new Mirai(userMahSetting?, userOptions?): Mirai

• Parameters

  • OptionaluserMahSetting: Partial<MiraiApiHttpSetting>
  • OptionaluserOptions: MiraiOptions

  Returns Mirai

active

afterListener

api

axios

beforeListener

OptionalcurMsg

eventEmitter

interval

logger

mahSetting

options

qq

retries

verified

_adaptMessageForAll

• _adaptMessageForAll<T>(method, callback): void

• message 展开为 FriendMessage | GroupMessage | TempMessage

  Type Parameters

  • T extends
        | "GroupMessage"
        | "TempMessage"
        | "FriendMessage"
        | (keyof EventMap)
        | "message"

  Parameters

  • method: "on" | "off" | "once"
  • callback: ((data: Data<T>) => any)
    • • (data): any

      • Parameters

        • data: Data<T>

        Returns any

  Returns void

_sendMessageByType

• _sendMessageByType(type, msgChain, target, messageId): undefined | Promise<Api.Response.SendMessage>

• 根据消息类型发送消息

  Parameters

  • type: SendMessageType
  • msgChain: string | MessageChain
  • target: number
  • messageId: number

  Returns undefined | Promise<Api.Response.SendMessage>

about

• about(): Promise<void>

• Returns Promise<void>

after

• after(callback): void

• 在监听器函数执行后执行

  Parameters

  • callback: Function

  Returns void

before

• before(callback): void

• 在监听器函数执行前执行

  Parameters

  • callback: Function

  Returns void

bind

• bind(): Promise<BaseResponse>

• 激活 Session，绑定 QQ data.code === 0 成功

  Returns Promise<BaseResponse>

handle

• handle(msg): void

• 处理消息

  Parameters

  • msg: ChatMessage | Event

  Returns void

link

• link(qq): Promise<BaseResponse>

• link 链接 mirai 已经登录的 QQ 号

  Parameters

  • qq: number

  Returns Promise<BaseResponse>

listen

• listen(): void

• 监听消息和事件

  Returns void

off

• off<T>(type, callback): void

• 取消监听器

  Type Parameters

  • T extends
        | "GroupMessage"
        | "TempMessage"
        | "FriendMessage"
        | (keyof EventMap)
        | "message"

  Parameters

  • type: T
  • callback: ((data: Data<T>) => any)
    • • (data): any

      • Parameters

        • data: Data<T>

        Returns any

  Returns void

on

• on<T>(type, callback): void

• 绑定事件列表 message: FriendMessage | GroupMessage | TempMessage mirai-api-http事件类型一览

  Type Parameters

  • T extends
        | "GroupMessage"
        | "TempMessage"
        | "FriendMessage"
        | (keyof EventMap)
        | "message"

  Parameters

  • type: T
  • callback: ((data: Data<T>) => any)
    • • (data): any

      • Parameters

        • data: Data<T>

        Returns any

  Returns void

  Example

  mirai.on('MemberMuteEvent', ()=>{})
  Copy

once

• once<T>(type, callback): void

• 仅处理事件一次

  Type Parameters

  • T extends
        | "GroupMessage"
        | "TempMessage"
        | "FriendMessage"
        | (keyof EventMap)
        | "message"

  Parameters

  • type: T
  • callback: ((data: Data<T>) => any)
    • • (data): any

      • Parameters

        • data: Data<T>

        Returns any

  Returns void

release

• release(): Promise<BaseResponse>

• 释放 Session

  Returns Promise<BaseResponse>

reply

• reply(msgChain, srcMsg, quote?): Promise<undefined | Api.Response.SendMessage | (undefined | Api.Response.SendMessage)[]>

• 快速回复（只在消息类型包含群组或好友信息时有效）

  Parameters

  • msgChain: string | MessageChain

    发送内容（消息链/纯文本皆可）
  • srcMsg: ChatMessage | Event

    回复哪条消息
  • quote: boolean = false

    是否引用回复（非聊天消息类型时无效）

  Returns Promise<undefined | Api.Response.SendMessage | (undefined | Api.Response.SendMessage)[]>

verify

• verify(): Promise<Auth>

• 获取 Session data.code === 0 成功

  Returns Promise<Auth>