ban

Documentation

Index

• Variables
• func BanHandler(e *handler.CommandEvent) error
• func Register(r *handler.Mux) []discord.ApplicationCommandCreate
• type BanHandlerData
  • func BanHandlerDataFromString(s string) (data BanHandlerData)
  • func (data BanHandlerData) String() string

Variables

var BanCommand = discord.SlashCommandCreate{
	Name:                     "ban",
	Description:              "Ban a user from the server",
	Contexts:                 []discord.InteractionContextType{discord.InteractionContextTypeGuild},
	IntegrationTypes:         []discord.ApplicationIntegrationType{discord.ApplicationIntegrationTypeGuildInstall},
	DefaultMemberPermissions: omit.NewPtr(discord.PermissionBanMembers),
	Options: []discord.ApplicationCommandOption{

		discord.ApplicationCommandOptionUser{
			Name:        "user",
			Description: "The user to ban",
			Required:    true,
		},
		discord.ApplicationCommandOptionString{
			Name:        "reason",
			Description: "Reason for banning the user. Not sent to the user. (Defaults to message)",
			Required:    false,
		},
		discord.ApplicationCommandOptionString{
			Name:        "message",
			Description: "The message sent to the user when banned.",
			Required:    false,
		},
		discord.ApplicationCommandOptionString{
			Name:        "duration",
			Description: "The duration to ban the user for",
			Required:    false,
			Choices:     durationChoices,
		},
		discord.ApplicationCommandOptionInt{
			Name:        "delete-messages",
			Description: "Whether to delete recent messages when banning the user",
			Required:    false,
			Choices: []discord.ApplicationCommandOptionChoiceInt{
				{
					Name:  "Do not delete messages",
					Value: 0,
				},
				{
					Name:  "Last 15 minutes",
					Value: 15 * 60,
				},
				{
					Name:  "Last 30 minutes",
					Value: 30 * 60,
				},
				{
					Name:  "Last hour",
					Value: 60 * 60,
				},
				{
					Name:  "Last 2 hours",
					Value: 2 * 60 * 60,
				},
				{
					Name:  "Last 4 hours",
					Value: 4 * 60 * 60,
				},
				{
					Name:  "Last 12 hours",
					Value: 12 * 60 * 60,
				},
				{
					Name:  "Last 24 hours",
					Value: 24 * 60 * 60,
				},
				{
					Name:  "Last 2 days",
					Value: 2 * 24 * 60 * 60,
				},
				{
					Name:  "Last week",
					Value: 7 * 24 * 60 * 60,
				},
			},
		},
		discord.ApplicationCommandOptionBool{
			Name:        "dont-auto-dm",
			Description: "Override server-default always send ban footer. message/duration will still trigger it",
		},
	},
}

Functions

func BanHandler

func BanHandler(e *handler.CommandEvent) error

func Register

func Register(r *handler.Mux) []discord.ApplicationCommandCreate

Types

type BanHandlerData

type BanHandlerData struct {
	User *discord.User
	// BanningUserID is used when parsing the ID, when there is no REST client
	// available.
	BanningUserID snowflake.ID
	BanningUser   *discord.User
	Guild         *discord.Guild
	Duration      string
	Reason        string
	Message       string
}

func BanHandlerDataFromString

func BanHandlerDataFromString(s string) (data BanHandlerData)

func (BanHandlerData) String

func (data BanHandlerData) String() string