Documentation
¶
Index ¶
- Variables
- type ActionRunsProvider
- type AuditLogEntry
- type Channel
- type ChannelCategory
- type ChatLogWithPerson
- type ChatProvider
- type CommandsProvider
- type ConfigField
- type ConfigStatus
- type ConfigStatusProvider
- type DiscordProvider
- func (p *DiscordProvider) AuditLog(limit int) ([]AuditLogEntry, error)
- func (p *DiscordProvider) Channels() ([]ChannelCategory, error)
- func (p *DiscordProvider) Guild() (Guild, error)
- func (p *DiscordProvider) MatchMembers(query string, max int) []PersonRef
- func (p *DiscordProvider) Member(id string) (Member, error)
- func (p *DiscordProvider) MemberPermissions(id string) (MemberPermissions, error)
- func (p *DiscordProvider) Members(query string, limit, offset int) (MembersPage, error)
- func (p *DiscordProvider) PersonRef(id string) PersonRef
- func (p *DiscordProvider) Roles() ([]Role, error)
- type Guild
- type JobsProvider
- type LeaderboardsProvider
- type Member
- type MemberPermissions
- type MembersPage
- type PersonRef
- type Profile
- type ProfileMessage
- type ProfileProvider
- type Role
- type ServiceStatus
- type ServicesProvider
- type SettingsProvider
- type Status
- type StatusProvider
- type TopMessagesEntry
- type TopReactionsEntry
- type UserWithPerson
- type UsersPage
- type UsersProvider
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrChatFilterRequired = errors.New("a userId or a search query is required to browse chat history")
View Source
var ErrDiscordNotReady = errors.New("discord session is not ready")
View Source
var ErrMemberCacheNotReady = errors.New("the member cache has not been populated yet")
Functions ¶
This section is empty.
Types ¶
type ActionRunsProvider ¶
type ActionRunsProvider struct {
// contains filtered or unexported fields
}
func NewActionRunsProvider ¶
func NewActionRunsProvider(storer storage.Storer) *ActionRunsProvider
type AuditLogEntry ¶
type ChannelCategory ¶
type ChatLogWithPerson ¶
type ChatProvider ¶
type ChatProvider struct {
// contains filtered or unexported fields
}
func NewChatProvider ¶
func NewChatProvider(storer storage.Storer, discord *DiscordProvider) *ChatProvider
func (*ChatProvider) GetByID ¶
func (p *ChatProvider) GetByID(messageID string) (ChatLogWithPerson, bool, error)
func (*ChatProvider) Messages ¶
func (p *ChatProvider) Messages(discordUserID, query string) ([]ChatLogWithPerson, error)
type CommandsProvider ¶
type CommandsProvider struct {
// contains filtered or unexported fields
}
func NewCommandsProvider ¶
func NewCommandsProvider(manager *commands.CommandManager) *CommandsProvider
func (*CommandsProvider) List ¶
func (p *CommandsProvider) List() []string
type ConfigField ¶
type ConfigStatus ¶
type ConfigStatus struct {
DatabaseEnabled bool `json:"databaseEnabled"`
Fields []ConfigField `json:"fields"`
}
type ConfigStatusProvider ¶
type ConfigStatusProvider struct {
// contains filtered or unexported fields
}
func NewConfigStatusProvider ¶
func NewConfigStatusProvider(cfg *types.Config) *ConfigStatusProvider
func (*ConfigStatusProvider) Status ¶
func (p *ConfigStatusProvider) Status() ConfigStatus
type DiscordProvider ¶
type DiscordProvider struct {
// contains filtered or unexported fields
}
func NewDiscordProvider ¶
func NewDiscordProvider(session *discord.Session) *DiscordProvider
func (*DiscordProvider) AuditLog ¶
func (p *DiscordProvider) AuditLog(limit int) ([]AuditLogEntry, error)
func (*DiscordProvider) Channels ¶
func (p *DiscordProvider) Channels() ([]ChannelCategory, error)
func (*DiscordProvider) Guild ¶
func (p *DiscordProvider) Guild() (Guild, error)
func (*DiscordProvider) MatchMembers ¶
func (p *DiscordProvider) MatchMembers(query string, max int) []PersonRef
func (*DiscordProvider) MemberPermissions ¶
func (p *DiscordProvider) MemberPermissions(id string) (MemberPermissions, error)
func (*DiscordProvider) Members ¶
func (p *DiscordProvider) Members(query string, limit, offset int) (MembersPage, error)
func (*DiscordProvider) PersonRef ¶
func (p *DiscordProvider) PersonRef(id string) PersonRef
func (*DiscordProvider) Roles ¶
func (p *DiscordProvider) Roles() ([]Role, error)
type JobsProvider ¶
type JobsProvider struct {
// contains filtered or unexported fields
}
func NewJobsProvider ¶
func NewJobsProvider(hb *heartbeat.Heartbeat) *JobsProvider
func (*JobsProvider) List ¶
func (p *JobsProvider) List() []heartbeat.JobStatus
type LeaderboardsProvider ¶
type LeaderboardsProvider struct {
// contains filtered or unexported fields
}
func NewLeaderboardsProvider ¶
func NewLeaderboardsProvider(storer storage.Storer, discord *DiscordProvider) *LeaderboardsProvider
func (*LeaderboardsProvider) TopMessages ¶
func (p *LeaderboardsProvider) TopMessages(limit int) ([]TopMessagesEntry, error)
func (*LeaderboardsProvider) TopReactions ¶
func (p *LeaderboardsProvider) TopReactions(limit int, reaction string) ([]TopReactionsEntry, error)
type Member ¶
type Member struct {
ID string `json:"id"`
Username string `json:"username"`
Nickname string `json:"nickname,omitempty"`
AvatarURL string `json:"avatarUrl,omitempty"`
Roles []string `json:"roles"`
JoinedAt string `json:"joinedAt,omitempty"`
CJCanActOn bool `json:"cjCanActOn"`
Reasons []string `json:"reasons,omitempty"`
}
type MemberPermissions ¶
type MembersPage ¶
type Profile ¶
type Profile struct {
DiscordUserID string `json:"discordUserId"`
Member *Member `json:"member,omitempty"`
Permissions *MemberPermissions `json:"permissions,omitempty"`
User *storage.User `json:"user,omitempty"`
RecentMessages []ProfileMessage `json:"recentMessages"`
MessageCount int `json:"messageCount"`
Rank int `json:"rank"`
}
type ProfileMessage ¶
type ProfileProvider ¶
type ProfileProvider struct {
// contains filtered or unexported fields
}
func NewProfileProvider ¶
func NewProfileProvider(storer storage.Storer, discord *DiscordProvider, users *UsersProvider, leaderboards *LeaderboardsProvider) *ProfileProvider
type Role ¶
type Role struct {
ID string `json:"id"`
Name string `json:"name"`
Color int `json:"color"`
Position int `json:"position"`
Managed bool `json:"managed"`
MemberCount int `json:"memberCount"`
Permissions []string `json:"permissions"`
CJCanManage bool `json:"cjCanManage"`
Reasons []string `json:"reasons,omitempty"`
}
type ServiceStatus ¶
type ServicesProvider ¶
type ServicesProvider struct {
// contains filtered or unexported fields
}
func NewServicesProvider ¶
func (*ServicesProvider) Check ¶
func (p *ServicesProvider) Check(name string) (ServiceStatus, error)
func (*ServicesProvider) List ¶
func (p *ServicesProvider) List() []ServiceStatus
type SettingsProvider ¶
type SettingsProvider struct {
// contains filtered or unexported fields
}
func NewSettingsProvider ¶
func NewSettingsProvider(storer storage.Storer) *SettingsProvider
func (*SettingsProvider) Get ¶
func (p *SettingsProvider) Get() (storage.GuildSettings, error)
func (*SettingsProvider) Set ¶
func (p *SettingsProvider) Set(next storage.GuildSettings, requestID string) (storage.GuildSettings, error)
type StatusProvider ¶
type StatusProvider struct {
// contains filtered or unexported fields
}
func NewStatusProvider ¶
func NewStatusProvider(version string, startedAt time.Time) *StatusProvider
func (*StatusProvider) Status ¶
func (p *StatusProvider) Status() Status
type TopMessagesEntry ¶
type TopReactionsEntry ¶
type UserWithPerson ¶
type UsersPage ¶
type UsersPage struct {
Users []UserWithPerson `json:"users"`
Total int `json:"total"`
Limit int `json:"limit"`
Offset int `json:"offset"`
}
type UsersProvider ¶
type UsersProvider struct {
// contains filtered or unexported fields
}
func NewUsersProvider ¶
func NewUsersProvider(storer storage.Storer, discord *DiscordProvider) *UsersProvider
Click to show internal directories.
Click to hide internal directories.