commands

Documentation

Index

• Variables
• func BuildMessage(mail Mail) string
• func SendEmail(to []string, code string, discordUser *discordgo.User) error
• func StartWebserver(session *discordgo.Session)
• type Mail
• type Ping
  • func (c *Ping) Exec(ctx shireikan.Context) error
  • func (c *Ping) GetDescription() string
  • func (c *Ping) GetDomainName() string
  • func (c *Ping) GetGroup() string
  • func (c *Ping) GetHelp() string
  • func (c *Ping) GetInvokes() []string
  • func (c *Ping) GetSubPermissionRules() []shireikan.SubPermission
  • func (c *Ping) IsExecutableInDMChannels() bool
• type Steal
  • func (c *Steal) Exec(ctx shireikan.Context) error
  • func (c *Steal) GetDescription() string
  • func (c *Steal) GetDomainName() string
  • func (c *Steal) GetGroup() string
  • func (c *Steal) GetHelp() string
  • func (c *Steal) GetInvokes() []string
  • func (c *Steal) GetSubPermissionRules() []shireikan.SubPermission
  • func (c *Steal) IsExecutableInDMChannels() bool
• type Verification
• type VerifyCommand
  • func (c *VerifyCommand) Exec(ctx shireikan.Context) error
  • func (c *VerifyCommand) GetDescription() string
  • func (c *VerifyCommand) GetDomainName() string
  • func (c *VerifyCommand) GetGroup() string
  • func (c *VerifyCommand) GetHelp() string
  • func (c *VerifyCommand) GetInvokes() []string
  • func (c *VerifyCommand) GetSubPermissionRules() []shireikan.SubPermission
  • func (c *VerifyCommand) IsExecutableInDMChannels() bool

Variables

var VerificationCodes map[string]Verification = make(map[string]Verification)

Functions

func BuildMessage

func BuildMessage(mail Mail) string

func SendEmail

func SendEmail(to []string, code string, discordUser *discordgo.User) error

func StartWebserver

func StartWebserver(session *discordgo.Session)

Types

type Mail

type Mail struct {
	Sender  string
	To      []string
	Subject string
	Body    string
}

type Ping

type Ping struct {
}

Ping is a command responding with a ping message in the commands channel.

func (*Ping) Exec

func (c *Ping) Exec(ctx shireikan.Context) error

Exec is the commands execution handler.

func (*Ping) GetDescription

func (c *Ping) GetDescription() string

GetDescription returns the commands description.

func (*Ping) GetDomainName

func (c *Ping) GetDomainName() string

GetDomainName returns the commands domain name.

func (*Ping) GetGroup

func (c *Ping) GetGroup() string

GetGroup returns the commands group.

func (*Ping) GetHelp

func (c *Ping) GetHelp() string

GetHelp returns the commands help text.

func (*Ping) GetInvokes

func (c *Ping) GetInvokes() []string

GetInvoke returns the command invokes.

func (*Ping) GetSubPermissionRules

func (c *Ping) GetSubPermissionRules() []shireikan.SubPermission

GetSubPermissionRules returns the commands sub permissions array.

func (*Ping) IsExecutableInDMChannels

func (c *Ping) IsExecutableInDMChannels() bool

IsExecutableInDMChannels returns whether the command is executable in DM channels.

type Steal

type Steal struct {
}

func (*Steal) Exec

func (c *Steal) Exec(ctx shireikan.Context) error

func (*Steal) GetDescription

func (c *Steal) GetDescription() string

func (*Steal) GetDomainName

func (c *Steal) GetDomainName() string

func (*Steal) GetGroup

func (c *Steal) GetGroup() string

func (*Steal) GetHelp

func (c *Steal) GetHelp() string

func (*Steal) GetInvokes

func (c *Steal) GetInvokes() []string

func (*Steal) GetSubPermissionRules

func (c *Steal) GetSubPermissionRules() []shireikan.SubPermission

func (*Steal) IsExecutableInDMChannels

func (c *Steal) IsExecutableInDMChannels() bool

type Verification

type Verification struct {
	User           *discordgo.User
	Email          string
	Expires        time.Time
	IsStaffFaculty bool
}

type VerifyCommand

type VerifyCommand struct {
}

func (*VerifyCommand) Exec

func (c *VerifyCommand) Exec(ctx shireikan.Context) error

func (*VerifyCommand) GetDescription

func (c *VerifyCommand) GetDescription() string

func (*VerifyCommand) GetDomainName

func (c *VerifyCommand) GetDomainName() string

func (*VerifyCommand) GetGroup

func (c *VerifyCommand) GetGroup() string

func (*VerifyCommand) GetHelp

func (c *VerifyCommand) GetHelp() string

func (*VerifyCommand) GetInvokes

func (c *VerifyCommand) GetInvokes() []string

func (*VerifyCommand) GetSubPermissionRules

func (c *VerifyCommand) GetSubPermissionRules() []shireikan.SubPermission

func (*VerifyCommand) IsExecutableInDMChannels

func (c *VerifyCommand) IsExecutableInDMChannels() bool