Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CalendarConfig ¶
type DiscordInput ¶
type DiscordInput struct {
Message *discordgo.MessageCreate
}
Input data coming from discord
type DynamicOutreach ¶
type FileOutput ¶
Output data going to a local file
type Input ¶
type Input struct {
Message string // The user's message in plaintext
Permissions byte // The permissions this input send has
Data any // Any external program data from implementations
Parameters objx.Map // Function parameters given in a function call by the model
}
Input content to a Horus library
func (*Input) GetInteger ¶
Get an integer parameter from the model
type Module ¶
type Module interface {
Handler(function string, input *Input) any // Handle function calls to the module
}
Module interface that the library uses to collect and use modules
type Output ¶
type Output struct {
Message string `json:"message"` // The library's message in plaintext
Data any `json:"data"` // Any external program data returned by the library
Error error `json:"error"` // Any error present in finding the output
}
Output response from a Horus library
type OutreachConfig ¶
type OutreachMessage ¶
type OutreachMessage interface {
// Returns a function that returns the content of the message
GetContent() string
// Return a list of channels to send the message
GetChannels() []chan string
// Start starts the message repeating again
Start() error
// Stop stops the message from being sent and cancels it permenantly
Stop() error
// Delete stops and deletes the message forever
Delete() error
}
OutreachMessage type is used to encode a message that will be sent to the user through a preferred communication method
type OutreachMethod ¶
type OutreachMethod string
const ( Discord OutreachMethod = "discord" Telegram OutreachMethod = "telegram" )
type OutreachServices ¶
type StaticOutreach ¶
Click to show internal directories.
Click to hide internal directories.