gateway

Documentation

Index

• Constants
• Variables
• type AccessLevel
• type Channel
• type Chat
• type Connected
• type Disconnected
• type Gateway
• type Join
• type Leave
• type PrivateChat
• type SystemMessage
• type User

Constants

const Delimiter = ":"

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

Variables

var (
	ErrUnknownEvent = errors.New("gw: Unknown event")
)

Errors

var Events = []interface{}{
	&Connected{},
	&Disconnected{},
	&SystemMessage{},
	&Channel{},
	&Chat{},
	&PrivateChat{},
	&Join{},
	&Leave{},
}

Events types

Types

type AccessLevel

type AccessLevel int32

AccessLevel for user

const (
	AccessMax       AccessLevel = 1000
	AccessOwner     AccessLevel = 1000
	AccessAdmin     AccessLevel = 300
	AccessOperator  AccessLevel = 200
	AccessWhitelist AccessLevel = 100
	AccessVoice     AccessLevel = 1
	AccessDefault   AccessLevel = 0
	AccessIgnore    AccessLevel = -1
	AccessBlacklist AccessLevel = -100
	AccessKick      AccessLevel = -200
	AccessBan       AccessLevel = -300
	AccessMin       AccessLevel = -1000
)

Access constants

type Channel

type Channel struct {
	ID   string
	Name string
}

Channel event

type Chat

type Chat struct {
	User
	Channel
	Content string
}

Chat event

type Connected

type Connected struct{}

Connected event

type Disconnected

type Disconnected struct{}

Disconnected event

type Gateway

type Gateway interface {
	network.Emitter
	Run(ctx context.Context) error
	Relay(ev *network.Event, sender string)
}

Gateway interface

type Join

type Join struct {
	User
	Channel
}

Join event

type Leave

type Leave struct {
	User
	Channel
}

Leave event

type PrivateChat

type PrivateChat struct {
	User
	Content string
}

PrivateChat event

type SystemMessage

type SystemMessage struct {
	Content string
}

SystemMessage event

type User

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

User base