modlog

package

v0.0.0-...-0abf00b Latest Latest Go to latest Published: Aug 11, 2023 License: AGPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/starshine-sys/tribble

Links

Open Source Insights

Documentation ¶

Overview ¶

SPDX-License-Identifier: AGPL-3.0-only

Index ¶

func InitCommands(bot *bot.Bot) (s string, list []*bcr.Command)
type ActionType
type Entry
type Export
type ModLog
- func New(bot *bot.Bot) *ModLog

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func InitCommands ¶

func InitCommands(bot *bot.Bot) (s string, list []*bcr.Command)

InitCommands ...

Types ¶

type ActionType ¶

type ActionType string

ActionType ...

const (
	ActionBan          ActionType = "ban"
	ActionUnban        ActionType = "unban"
	ActionKick         ActionType = "kick"
	ActionWarn         ActionType = "warn"
	ActionChannelban   ActionType = "channelban"
	ActionUnchannelban ActionType = "unchannelban"
)

Constants for action types

type Entry ¶

type Entry struct {
	ID       int64           `json:"id"`
	ServerID discord.GuildID `json:"-"`

	UserID discord.UserID `json:"user_id"`
	ModID  discord.UserID `json:"mod_id"`

	ActionType ActionType `json:"action_type"`
	Reason     string     `json:"reason,omitempty"`

	Time time.Time `json:"timestamp"`

	ChannelID discord.ChannelID `json:"-"`
	MessageID discord.MessageID `json:"-"`
}

Entry ...

type Export ¶

type Export struct {
	ServerID  discord.GuildID `json:"server_id"`
	Timestamp time.Time       `json:"timestamp"`

	Entries []Entry `json:"entries"`
}

Export is an export of a server's mod logs

type ModLog ¶

type ModLog struct {
	*bot.Bot
}

ModLog can be created in two ways: either by bcr for commands, or other

func New ¶

func New(bot *bot.Bot) *ModLog

New creates a new ModLog

func (*ModLog) Embed ¶

func (bot *ModLog) Embed(s *state.State, entry *Entry) (embed discord.Embed)

func (*ModLog) InsertEntry ¶

func (bot *ModLog) InsertEntry(guildID discord.GuildID, user, mod discord.UserID, timestamp time.Time, actionType ActionType, reason string) (log *Entry, err error)

InsertEntry inserts a mod log entry

func (*ModLog) Log ¶

func (bot *ModLog) Log(
	s *state.State,
	actionType ActionType,
	guildID discord.GuildID,
	userID, modID discord.UserID,
	reason string,
) (err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL