gateway

Documentation

Index

• Constants
• Variables
• type AccessLevel
  • func (l AccessLevel) MarshalText() (text []byte, err error)
  • func (l AccessLevel) String() string
  • func (l *AccessLevel) UnmarshalText(text []byte) error
• type Channel
• type Chat
• type Clear
• type Common
  • func (c *Common) Discriminator() string
  • func (c *Common) ID() string
  • func (c *Common) SetID(id string)
• type Config
  • func (c *Config) FindTrigger(s string) *Trigger
  • func (c *Config) Responder(gw Gateway, uid string, forcePrivate bool) Responder
  • func (c *Config) Trigger() string
• type ConfigUpdate
• type Connected
• type Disconnected
• type Gateway
• type Join
• type Leave
• type PrivateChat
• type Responder
• type Say
• type SystemMessage
• type Trigger
  • func ExtractTrigger(s string) *Trigger
  • func FindTrigger(t, s string) *Trigger
• type TriggerConfig
• type User
  • func FindUser(gw Gateway, pat string) []*User
  • func FindUserInChannel(gw Gateway, pat string) []*User

Constants

const Delimiter = ":"

Delimiter between main/sub gateway name in ID (i.e. discord:{CHANNELID})

Variables

var (
	AccessMax       = AccessLevel(math.MaxInt32)
	AccessOwner     = AccessLevel(1000)
	AccessAdmin     = AccessLevel(300)
	AccessOperator  = AccessLevel(200)
	AccessWhitelist = AccessLevel(100)
	AccessVoice     = AccessLevel(1)
	AccessDefault   = AccessLevel(0)
	AccessIgnore    = AccessLevel(-1)
	AccessKick      = AccessLevel(-100)
	AccessBan       = AccessLevel(-200)
	AccessBlacklist = AccessLevel(-300)
	AccessMin       = AccessLevel(math.MinInt32)

	ConStrings = []string{"max", "owner", "admin", "operator", "whitelist", "voice", "", "ignore", "kick", "ban", "blacklist", "min"}
	ConLevels  = []AccessLevel{AccessMax, AccessOwner, AccessAdmin, AccessOperator, AccessWhitelist, AccessVoice, AccessDefault, AccessIgnore, AccessKick, AccessBan, AccessBlacklist, AccessMin}
)

Access constants

var (
	ErrUnknownEvent   = errors.New("gw: Unknown event")
	ErrUnknownAccess  = errors.New("gw: Unknown access level")
	ErrNoChannel      = errors.New("gw: No channel")
	ErrNoUser         = errors.New("gw: No user")
	ErrNoPermission   = errors.New("gw: No permission")
	ErrNotImplemented = errors.New("gw: Not implemented")
)

Errors

var RelayEvents = []interface{}{
	&network.AsyncError{},
	&Clear{},
	&Connected{},
	&Disconnected{},
	&SystemMessage{},
	&Channel{},
	&Chat{},
	&PrivateChat{},
	&Say{},
	&Join{},
	&Leave{},
	&User{},
}

RelayEvents types

Types

type AccessLevel

type AccessLevel int32

AccessLevel for user

func (AccessLevel) MarshalText

func (l AccessLevel) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler

func (AccessLevel) String

func (l AccessLevel) String() string

func (*AccessLevel) UnmarshalText

func (l *AccessLevel) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler

type Channel

type Channel struct {
	ID   string
	Name string
}

Channel struct

type Chat

type Chat struct {
	User
	Content string
}

Chat event

type Clear

type Clear struct{}

Clear event

type Common

type Common struct {
	// contains filtered or unexported fields
}

Common gateway struct

func (*Common) Discriminator

func (c *Common) Discriminator() string

Discriminator tag

func (*Common) ID

func (c *Common) ID() string

ID returns the unique gateway identifier

func (*Common) SetID

func (c *Common) SetID(id string)

SetID set the unique gateway identifier

type Config

type Config struct {
	Commands TriggerConfig
}

Config common struct

func (*Config) FindTrigger

func (c *Config) FindTrigger(s string) *Trigger

FindTrigger checks if s starts with trigger, return Trigger{} if true

func (*Config) Responder

func (c *Config) Responder(gw Gateway, uid string, forcePrivate bool) Responder

Responder for trigger

func (*Config) Trigger

func (c *Config) Trigger() string

Trigger for commands

type ConfigUpdate

type ConfigUpdate struct{}

ConfigUpdate event

type Connected

type Connected struct{}

Connected event

type Disconnected

type Disconnected struct{}

Disconnected event

type Gateway

type Gateway interface {
	network.Emitter
	network.Listener
	ID() string
	SetID(id string)
	Discriminator() string
	Channel() *Channel
	ChannelUsers() []User
	User(uid string) (*User, error)
	Users() map[string]AccessLevel
	SetUserAccess(uid string, a AccessLevel) (*AccessLevel, error)
	Trigger() string
	Say(s string) error
	SayPrivate(uid string, s string) error
	Kick(uid string) error
	Ban(uid string) error
	Unban(uid string) error
	Ping(uid string) (time.Duration, error)
	Responder(gw Gateway, uid string, forcePrivate bool) Responder
	Run(ctx context.Context) error
	Relay(ev *network.Event, from Gateway) error
}

Gateway interface

type Join

type Join struct {
	User
}

Join event

type Leave

type Leave struct {
	User
}

Leave event

type PrivateChat

type PrivateChat struct {
	User
	Content string
}

PrivateChat event

type Responder

type Responder func(s string) error

Responder callback

type Say

type Say struct {
	Content string
}

Say event

type SystemMessage

type SystemMessage struct {
	Type    string
	Content string
}

SystemMessage event

type Trigger

type Trigger struct {
	User
	Cmd  string
	Raw  []string
	Arg  []string
	Resp Responder
}

Trigger event

func ExtractTrigger

func ExtractTrigger(s string) *Trigger

ExtractTrigger from s

func FindTrigger

func FindTrigger(t, s string) *Trigger

FindTrigger checks if s starts with trigger t, return Trigger{} if true

type TriggerConfig

type TriggerConfig struct {
	Trigger        string
	Access         AccessLevel
	RespondPrivate bool
}

TriggerConfig for commands

type User

type User struct {
	ID        string
	Name      string
	Access    AccessLevel
	AvatarURL string
}

User struct

func FindUser

func FindUser(gw Gateway, pat string) []*User

FindUser finds user(s) by pattern

func FindUserInChannel

func FindUserInChannel(gw Gateway, pat string) []*User

FindUserInChannel finds user(s) by pattern