capi

Documentation

Index

• Variables
• type Config
• type Gateway
  • func New(conf *Config) (*Gateway, error)
  • func (b *Gateway) Ban(uid string) error
  • func (b *Gateway) Channel() *gateway.Channel
  • func (b *Gateway) ChannelUsers() []gateway.User
  • func (b *Gateway) FindTrigger(s string) *gateway.Trigger
  • func (b *Gateway) InitDefaultHandlers()
  • func (b *Gateway) Kick(uid string) error
  • func (b *Gateway) Operator() bool
  • func (b *Gateway) Ping(uid string) (time.Duration, error)
  • func (b *Gateway) Relay(ev *network.Event, from gateway.Gateway) error
  • func (b *Gateway) Run(ctx context.Context) error
  • func (b *Gateway) Say(s string) error
  • func (b *Gateway) SayPrivate(uid string, s string) error
  • func (b *Gateway) SetUserAccess(uid string, a gateway.AccessLevel) (*gateway.AccessLevel, error)
  • func (b *Gateway) Unban(uid string) error
  • func (b *Gateway) User(uid string) (*gateway.User, error)
  • func (b *Gateway) Users() map[string]gateway.AccessLevel
• type GatewayConfig

Variables

var (
	ErrSayBufferFull = errors.New("gw-capi: Say buffer full")
)

Errors

Types

type Config

type Config struct {
	GatewayConfig
	chat.Config
}

Config stores the configuration of a single CAPI connection

type Gateway

type Gateway struct {
	gateway.Common
	*chat.Bot

	// Set once before Run(), read-only after that
	*GatewayConfig
	// contains filtered or unexported fields
}

Gateway manages a CAPI connection

func New

func New(conf *Config) (*Gateway, error)

New initializes a new Gateway struct

func (*Gateway) Ban

func (b *Gateway) Ban(uid string) error

Ban user from channel

func (*Gateway) Channel

func (b *Gateway) Channel() *gateway.Channel

Channel residing in

func (*Gateway) ChannelUsers

func (b *Gateway) ChannelUsers() []gateway.User

ChannelUsers online

func (*Gateway) FindTrigger

func (b *Gateway) FindTrigger(s string) *gateway.Trigger

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

func (*Gateway) InitDefaultHandlers

func (b *Gateway) InitDefaultHandlers()

InitDefaultHandlers adds the default callbacks for relevant packets

func (*Gateway) Kick

func (b *Gateway) Kick(uid string) error

Kick user from channel

func (*Gateway) Operator

func (b *Gateway) Operator() bool

Operator in chat

func (*Gateway) Ping

func (b *Gateway) Ping(uid string) (time.Duration, error)

Ping user to calculate RTT in milliseconds

func (*Gateway) Relay

func (b *Gateway) Relay(ev *network.Event, from gateway.Gateway) error

Relay dumps the event content in current channel

func (*Gateway) Run

func (b *Gateway) Run(ctx context.Context) error

Run reads packets and emits an event for each received packet

func (*Gateway) Say

func (b *Gateway) Say(s string) error

Say sends a chat message

func (*Gateway) SayPrivate

func (b *Gateway) SayPrivate(uid string, s string) error

SayPrivate sends a private chat message to uid

func (*Gateway) SetUserAccess

func (b *Gateway) SetUserAccess(uid string, a gateway.AccessLevel) (*gateway.AccessLevel, error)

SetUserAccess overrides accesslevel for a specific user

func (*Gateway) Unban

func (b *Gateway) Unban(uid string) error

Unban user from channel

func (*Gateway) User

func (b *Gateway) User(uid string) (*gateway.User, error)

User by ID

func (*Gateway) Users

func (b *Gateway) Users() map[string]gateway.AccessLevel

Users with non-default access level

type GatewayConfig

type GatewayConfig struct {
	gateway.Config

	ReconnectDelay   time.Duration
	BufSize          uint8
	AvatarDefaultURL string

	AccessWhisper  gateway.AccessLevel
	AccessTalk     gateway.AccessLevel
	AccessOperator gateway.AccessLevel
	AccessUser     map[string]gateway.AccessLevel
}

GatewayConfig stores the config additions of capi.Gateway over chat.Bot