Documentation
¶
Overview ¶
To avoid needing to store the entire state even when not needed, jobs defines a state interface to store and fetch only needed state
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ProgressState ¶
type State ¶
type State interface {
// GetTransport returns the http transport to use for jobs
//
// E.g. localjobs uses a custom http transport to support local files via the file:// scheme
Transport() *http.Transport
// Returns the current operation mode of the service (jobserver/localjob etc.). Similar to webserver/state.CurrentOperationMode
OperationMode() string
// Returns a *discordgo.Session, the bots current user and a boolean indicating whether or not the gateway is available
//
// This boolean is currently unused
Discord() (*discordgo.Session, *discordgo.User, bool)
// Debug Info and extra debug info
DebugInfo() *debug.BuildInfo
// Context returns the context to use for the job
Context() context.Context
// GuildID returns the guild ID for the job, if applicable
GuildID() string
}
Click to show internal directories.
Click to hide internal directories.