commands

Documentation

Index

• type Object
  • func (c *Object) Exec(ctx shireikan.Context) error
  • func (c *Object) GetDescription() string
  • func (c *Object) GetDomainName() string
  • func (c *Object) GetGroup() string
  • func (c *Object) GetHelp() string
  • func (c *Object) GetInvokes() []string
  • func (c *Object) GetSubPermissionRules() []shireikan.SubPermission
  • func (c *Object) IsExecutableInDMChannels() bool
• 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

Types

type Object

type Object struct {
}

Object is a command returning an object recovered from the context's object map.

func (*Object) Exec

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

Exec is the commands execution handler.

func (*Object) GetDescription

func (c *Object) GetDescription() string

GetDescription returns the commands description.

func (*Object) GetDomainName

func (c *Object) GetDomainName() string

GetDomainName returns the commands domain name.

func (*Object) GetGroup

func (c *Object) GetGroup() string

GetGroup returns the commands group.

func (*Object) GetHelp

func (c *Object) GetHelp() string

GetHelp returns the commands help text.

func (*Object) GetInvokes

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

GetInvoke returns the command invokes.

func (*Object) GetSubPermissionRules

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

GetSubPermissionRules returns the commands sub permissions array.

func (*Object) IsExecutableInDMChannels

func (c *Object) IsExecutableInDMChannels() bool

IsExecutableInDMChannels returns whether the command is executable in DM channels.

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.