webhook

Documentation

Index

• Variables
• func Bind(c *gin.Context, req any) error
• func CORSMiddleware() gin.HandlerFunc
• func FatalError(err error)
• func GenerateId() int64
• func GenerateIdStr() string
• func InitGin()
• func InitLog()
• func PathExists(path string) bool
• func Return(c *gin.Context, resp proto.Message)
• func RunGin(engine *gin.Engine, port string) (string, error)
• func SafeGo(fn func())
• type App
• type Bot
  • func NewBot(h *BotHeaderInfo, p *dto.WSPayload, m []byte, appId string) *Bot
  • func (bot *Bot) AddOpenapi(iOpenapi openapi.OpenAPI) *Bot
  • func (bot *Bot) ParseWHData(h *BotHeaderInfo, p *dto.WSPayload, message []byte)
• type BotHeaderInfo
• type Frame
• type Setting
  • func AllSettings() *Setting
  • func ReadSetting() Setting
• type ValidationRequest
• type ValidationResponse

Variables

var (
	SelectPort = map[string]string{
		"80":   ":80",
		"8080": ":8080",
		"443":  ":443",
		"8443": ":8443",
	}
	FirstStart bool = true
)

var ATMessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSATMessageData) error

ATMessageEventHandler at 机器人消息事件 handler

var AudioEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSAudioData) error

AudioEventHandler 音频机器人事件 handler

var Bots = make(map[string]*Bot)

var C2CMessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSC2CMessageData) error

var C2CMsgReceiveHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSFriendMsgReveiceData) error

var C2CMsgRejectHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSFriendMsgRejectData) error

var ChannelEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSChannelData) error

ChannelEventHandler 子频道事件 handler

var CheckEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, message []byte) bool

CheckEventHandler 消息前置检测

var DirectMessageDeleteEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSDirectMessageDeleteData) error

DirectMessageDeleteEventHandler 消息事件 handler

var DirectMessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSDirectMessageData) error

DirectMessageEventHandler 私信消息事件 handler

var ErrorNotifyHandler func(err error)

ErrorNotifyHandler 当 ws 连接发生错误的时候，会回调，方便使用方监控相关错误 比如 reconnect invalidSession 等错误，错误可以转换为 bot.Err

var ForumAuditEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSForumAuditData) error

ForumAuditEventHandler 论坛帖子审核事件 handler

var FriendAddEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSFriendAddData) error

var FriendDelEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSFriendDelData) error

var GlobalId int64 = 0

var GroupAddRobotEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupAddRobotData) error

var GroupAtMessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupATMessageData) error

var GroupDelRobotEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupDelRobotData) error

var GroupMessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupMessageData) error

var GroupMsgReceiveEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupMsgReceiveData) error

var GroupMsgRejectEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGroupMsgRejectData) error

var GuildEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGuildData) error

GuildEventHandler 频道事件handler

var GuildMemberEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSGuildMemberData) error

GuildMemberEventHandler 频道成员事件 handler

var InteractionEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSInteractionData) error

InteractionEventHandler 互动事件 handler

var MessageAuditEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSMessageAuditData) error

MessageAuditEventHandler 消息审核事件 handler

var MessageDeleteEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSMessageDeleteData) error

MessageDeleteEventHandler 消息事件 handler

var MessageEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSMessageData) error

MessageEventHandler 消息事件 handler

var MessageReactionEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSMessageReactionData) error

MessageReactionEventHandler 表情表态事件 handler

var PlainEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, message []byte) error

PlainEventHandler 透传handler

var PostEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSPostData) error

PostEventHandler 论坛回帖事件 handler

var PublicMessageDeleteEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSPublicMessageDeleteData) error

PublicMessageDeleteEventHandler 消息事件 handler

var ReadyHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSReadyData)

ReadyHandler 可以处理 ws 的 ready 事件

var ReplyEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSReplyData) error

ReplyEventHandler 论坛帖子回复事件 handler

var SettingPath = "setting"

var ThreadEventHandler func(bot *BotHeaderInfo, event *dto.WSPayload, data *dto.WSThreadData) error

ThreadEventHandler 论坛主题事件 handler

Functions

func Bind

func Bind(c *gin.Context, req any) error

func CORSMiddleware

func CORSMiddleware() gin.HandlerFunc

func FatalError

func FatalError(err error)

func GenerateId

func GenerateId() int64

func GenerateIdStr

func GenerateIdStr() string

func InitGin

func InitGin()

func InitLog

func InitLog()

func PathExists

func PathExists(path string) bool

func Return

func Return(c *gin.Context, resp proto.Message)

func RunGin

func RunGin(engine *gin.Engine, port string) (string, error)

func SafeGo

func SafeGo(fn func())

Types

type App

type App struct {
	QQ        uint64 `json:"qq,omitempty" toml:"QQ"`
	AppId     uint64 `json:"app_id,omitempty" toml:"AppId"`
	Token     string `json:"token,omitempty" toml:"Token"`
	AppSecret string `json:"app_secret,omitempty" toml:"AppSecret"`
}

type Bot

type Bot struct {
	QQ        uint64
	AppId     string
	Token     string
	AppSecret string
	Openapi   openapi.OpenAPI

	WaitingFrames map[string]*promise.Promise

	Payload *dto.WSPayload
	// contains filtered or unexported fields
}

func NewBot

func NewBot(h *BotHeaderInfo, p *dto.WSPayload, m []byte, appId string) *Bot

func (*Bot) AddOpenapi

func (bot *Bot) AddOpenapi(iOpenapi openapi.OpenAPI) *Bot

func (*Bot) ParseWHData

func (bot *Bot) ParseWHData(h *BotHeaderInfo, p *dto.WSPayload, message []byte)

type BotHeaderInfo

type BotHeaderInfo struct {
	ContentLength       []string `json:"Content-Length,omitempty"`
	ContentType         []string `json:"Content-Type,omitempty"`
	UserAgent           []string `json:"User-Agent,omitempty"`
	XBotAppid           []string `json:"X-Bot-Appid,omitempty"`
	XSignatureEd25519   []string `json:"X-Signature-Ed25519,omitempty"`
	XSignatureMethod    []string `json:"X-Signature-Method,omitempty"`
	XSignatureTimestamp []string `json:"X-Signature-Timestamp,omitempty"`
	XTpsTraceId         []string `json:"X-Tps-Trace-Id,omitempty"`
}

type Frame

type Frame struct {
	BotId   uint64
	Echo    string
	Ok      bool
	Openapi openapi.OpenAPI
}

type Setting

type Setting struct {
	Apps     map[string]*App `json:"apps,omitempty" toml:"Apps"`
	Port     int             `json:"port,omitempty" toml:"Port"`
	CertFile string          `json:"cert_file,omitempty" toml:"CertFile"`
	CertKey  string          `json:"cert_key,omitempty" toml:"CertKey"`
}

var AllSetting *Setting = &Setting{}

func AllSettings

func AllSettings() *Setting

func ReadSetting

func ReadSetting() Setting

type ValidationRequest

type ValidationRequest struct {
	PlainToken string `json:"plain_token,omitempty"`
	EventTs    string `json:"event_ts,omitempty"`
}

type ValidationResponse

type ValidationResponse struct {
	PlainToken string `json:"plain_token,omitempty"`
	Signature  string `json:"signature,omitempty"`
}