bot

Documentation

Index

• Constants
• Variables
• func CommonLogin() error
• func GenRandomDevice()
• func Init()
• func InitBot(account int64, password string)
• func InitWithDeviceJSONContent(deviceJSONContent []byte)
• func InitWithOption(option InitOption) error
• func Login() error
• func LoginWithOption(option LoginOption) error
• func QrcodeLogin() error
• func RefreshList()
• func RegisterModule(instance Module)
• func SaveToken()
• func StartService()
• func Stop()
• func UseDevice(device []byte) error
• func UseProtocol(p protocol)
• type Bot
• type InitOption
• type LoginMethod
• type LoginOption
• type Module
• type ModuleID
  • func (id ModuleID) Name() string
  • func (id ModuleID) Namespace() string
• type ModuleInfo
  • func GetModule(name string) (ModuleInfo, error)
  • func (mi ModuleInfo) String() string

Constants

const (
	LoginMethodToken  = "token"
	LoginMethodQRCode = "qrcode"
	LoginMethodCommon = "common"
)

const (
	AndroidPhone = protocol(client.AndroidPhone)
	IPad         = protocol(client.IPad)
	AndroidWatch = protocol(client.AndroidWatch)
	MacOS        = protocol(client.MacOS)
)

Variables

var ErrSMSRequestError = errors.New("sms request error")

ErrSMSRequestError SMS请求出错

Functions

func CommonLogin

func CommonLogin() error

CommonLogin 普通账号密码登录

func GenRandomDevice

func GenRandomDevice()

GenRandomDevice 生成随机设备信息

func Init

func Init()

Init 快速初始化 使用 config.GlobalConfig 初始化账号 使用 ./device.json 初始化设备信息

func InitBot

func InitBot(account int64, password string)

InitBot 使用 account password 进行初始化账号

func InitWithDeviceJSONContent

func InitWithDeviceJSONContent(deviceJSONContent []byte)

func InitWithOption

func InitWithOption(option InitOption) error

func Login

func Login() error

Login 登录

func LoginWithOption

func LoginWithOption(option LoginOption) error

func QrcodeLogin

func QrcodeLogin() error

QrcodeLogin 扫码登陆

func RefreshList

func RefreshList()

RefreshList 刷新联系人

func RegisterModule

func RegisterModule(instance Module)

RegisterModule - 向全局添加 Module

func SaveToken

func SaveToken()

SaveToken 会话缓存

func StartService

func StartService()

StartService 启动服务 根据 Module 生命周期 此过程应在Login前调用 请勿重复调用

func Stop

func Stop()

Stop 停止所有服务 调用此函数并不会使Bot离线

func UseDevice

func UseDevice(device []byte) error

UseDevice 使用 device 进行初始化设备信息

func UseProtocol

func UseProtocol(p protocol)

UseProtocol 使用协议 不同协议会有部分功能无法使用 默认为 AndroidPad

Types

type Bot

type Bot struct {
	*client.QQClient
	// contains filtered or unexported fields
}

Bot 全局 Bot

var Instance *Bot

Instance Bot 实例

type InitOption

type InitOption struct {
	Account           int64
	Password          string
	DeviceJSONContent []byte //cannot be nil if using option init
}

type LoginMethod

type LoginMethod string

type LoginOption

type LoginOption struct {
	LoginMethod              LoginMethod
	Token                    []byte //if not nil, try with most priority
	UseTokenWhenUnmatchedUin bool
}

type Module

type Module interface {
	MiraiGoModule() ModuleInfo

	// Init 初始化
	// 待所有 Module 初始化完成后
	// 进行服务注册 Serve
	Init()

	// PostInit 第二次初始化
	// 调用该函数时，所有 Module 都已完成第一段初始化过程
	// 方便进行跨Module调用
	PostInit()

	// Serve 向Bot注册服务函数
	// 结束后调用 Start
	Serve(bot *Bot)

	// Start 启用Module
	// 此处调用为
	// “` go
	// go Start()
	// “`
	// 结束后进行登录
	Start(bot *Bot)

	// Stop 应用结束时对所有 Module 进行通知
	// 在此进行资源回收
	Stop(bot *Bot, wg *sync.WaitGroup)
}

Module MiraiGo 中的模块 用于进行模块化设计

type ModuleID

type ModuleID string

ModuleID 模块ID 请使用 小写 并用 _ 代替空格 Example: - logiase.autoreply

func (ModuleID) Name

func (id ModuleID) Name() string

Name - 获取一个 Module 的 Name

func (ModuleID) Namespace

func (id ModuleID) Namespace() string

Namespace - 获取一个 Module 的 Namespace

type ModuleInfo

type ModuleInfo struct {
	// ID 模块的名称
	// 应全局唯一
	ID ModuleID

	// Instance 返回 Module
	Instance Module
}

ModuleInfo 模块信息

func GetModule

func GetModule(name string) (ModuleInfo, error)

GetModule - 获取一个已注册的 Module 的 ModuleInfo

func (ModuleInfo) String

func (mi ModuleInfo) String() string