bot

Documentation

Index

• type Config
• type DiscordBot
  • func NewDiscordBot(deps dependencies, conf Config, permissions, intents int) *DiscordBot
  • func (d *DiscordBot) API() *json.DiscordJSONClient
  • func (d *DiscordBot) AuthenticateAndConnect() error
  • func (d *DiscordBot) Config() Config
  • func (d *DiscordBot) Disconnect() error
  • func (d *DiscordBot) Dispatcher() Dispatcher
  • func (d *DiscordBot) Intents() int
  • func (d *DiscordBot) LastSequence() int
  • func (d *DiscordBot) ReconfigureHeartbeat(ctx context.Context, interval int)
  • func (d *DiscordBot) Run(ctx context.Context) error
  • func (d *DiscordBot) SetDebug(val bool)
  • func (d *DiscordBot) UpdateSequence(seq int) bool
• type DispatchHandlerFunc
• type Dispatcher
• type Logger
• type Payload

Types

type Config

type Config struct {
	ClientID     string
	ClientSecret string
	BotToken     string
	APIURL       string
	NumWorkers   int

	OS          string
	BotName     string
	BotPresence string
}

Config is the set of configuration options for creating a DiscordBot with NewDiscordBot

type DiscordBot

type DiscordBot struct {
	// contains filtered or unexported fields
}

func NewDiscordBot

func NewDiscordBot(deps dependencies, conf Config, permissions, intents int) *DiscordBot

NewDiscordBot creates a new DiscordBot

func (*DiscordBot) API

func (d *DiscordBot) API() *json.DiscordJSONClient

func (*DiscordBot) AuthenticateAndConnect

func (d *DiscordBot) AuthenticateAndConnect() error

func (*DiscordBot) Config

func (d *DiscordBot) Config() Config

func (*DiscordBot) Disconnect

func (d *DiscordBot) Disconnect() error

func (*DiscordBot) Dispatcher

func (d *DiscordBot) Dispatcher() Dispatcher

func (*DiscordBot) Intents

func (d *DiscordBot) Intents() int

func (*DiscordBot) LastSequence

func (d *DiscordBot) LastSequence() int

func (*DiscordBot) ReconfigureHeartbeat

func (d *DiscordBot) ReconfigureHeartbeat(ctx context.Context, interval int)

func (*DiscordBot) Run

func (d *DiscordBot) Run(ctx context.Context) error

func (*DiscordBot) SetDebug

func (d *DiscordBot) SetDebug(val bool)

func (*DiscordBot) UpdateSequence

func (d *DiscordBot) UpdateSequence(seq int) bool

type DispatchHandlerFunc

type DispatchHandlerFunc = func(Payload, wsapi.WSMessage, chan<- wsapi.WSMessage) snowflake.Snowflake

DispatcherFunc is the api that a bot expects a handler function to have

type Dispatcher

type Dispatcher interface {
	ConnectToBot(*DiscordBot)
	GenerateHeartbeat(context.Context, int) (wsapi.WSMessage, error)
	AddHandler(string, DispatchHandlerFunc)
	HandleRequest(wsapi.WSMessage, chan<- wsapi.WSMessage) snowflake.Snowflake
}

Dispatcher is the api that a bot expects a handler manager to have

type Logger

type Logger = interface {
	Log(keyvals ...interface{}) error
	Message(string, ...interface{})
	Err(string, error, ...interface{})
	Printf(string, ...interface{})
}

type Payload

type Payload = interface {
	EventName() string
	Contents() map[string]etf.Element
}