irc

Documentation

Index

• Constants
• Variables
• type ChatClient
  • func New(token string) (*ChatClient, error)
  • func (c *ChatClient) Close() error
  • func (c *ChatClient) JoinContext(ctx context.Context, channel string) error
  • func (c *ChatClient) OnMessage(handler func(msg *Message) error)
  • func (c *ChatClient) OpenContext(ctx context.Context, url string) error
  • func (c *ChatClient) Send(channel, content string) error
  • func (c *ChatClient) SendTimeout(channel, content string, timeout time.Duration) error
• type Message

Constants

const (
	// TagBadgeInfo ...
	TagBadgeInfo string = "badge-info"
	// TagBadges ...
	TagBadges string = "badges"
	// TagColor ...
	TagColor string = "color"
	// TagDisplayName ...
	TagDisplayName string = "display-name"
	// TagEmotes ...
	TagEmotes string = "emotes"
	// TagFlags ...
	TagFlags string = "flags"
	// TagSubscriber 1 if the user has a subscriber badge; otherwise, 0.
	//
	// [deprecated] use badges
	TagSubscriber string = "subscriber"
)

Variables

var ErrRateExceeded = errors.New("ratelimit exceeded")

Types

type ChatClient

type ChatClient struct {
	Nick string

	OnSend     func(command string)
	OnReceived func(command string)
	OnError    func(format string, args ...interface{})
	// contains filtered or unexported fields
}

ChatClient ...

func New

func New(token string) (*ChatClient, error)

New ...

func (*ChatClient) Close

func (c *ChatClient) Close() error

Close ...

func (*ChatClient) JoinContext

func (c *ChatClient) JoinContext(ctx context.Context, channel string) error

func (*ChatClient) OnMessage

func (c *ChatClient) OnMessage(handler func(msg *Message) error)

OnMessage ...

func (*ChatClient) OpenContext

func (c *ChatClient) OpenContext(ctx context.Context, url string) error

OpenContext ...

func (*ChatClient) Send

func (c *ChatClient) Send(channel, content string) error

Send

func (*ChatClient) SendTimeout

func (c *ChatClient) SendTimeout(channel, content string, timeout time.Duration) error

SendTimeout

type Message

type Message struct {
	Tags    map[string]string
	Trailer string
	Sender  string
	Channel string
	Command string
	Prefix  string
	Args    []string
}

Message ...