ircTransport

Documentation

Index

• Constants
• type IRCTransport
  • func (transport *IRCTransport) GetChannelsOn() []string
  • func (transport *IRCTransport) GetNicks(channel string) []string
  • func (transport *IRCTransport) Init(botName string, fullConfig *toml.Tree, logger *logrus.Logger, ...)
  • func (transport *IRCTransport) Name() string
  • func (transport *IRCTransport) NickIsMe(nick string) bool
  • func (transport *IRCTransport) Run()
  • func (transport *IRCTransport) SendMassNotice(message string)
  • func (transport *IRCTransport) SendMessage(sourceEvent *events.EventMessage, message string)
  • func (transport *IRCTransport) SendNotice(sourceEvent *events.EventMessage, message string)
  • func (transport *IRCTransport) SendPrivateMessage(sourceEvent *events.EventMessage, nick, message string)
  • func (transport *IRCTransport) SendRawMessage(command string, params []string, trailing string)

Constants

const MsgLengthLimit = 440 // IRC message length limit.

Types

type IRCTransport

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

func (*IRCTransport) GetChannelsOn

func (transport *IRCTransport) GetChannelsOn() []string

GetChannelsOn will return a list of channels the transport is currently on.

func (*IRCTransport) GetNicks

func (transport *IRCTransport) GetNicks(channel string) []string

GetNicks is not implemented!

func (*IRCTransport) Init

func (transport *IRCTransport) Init(botName string, fullConfig *toml.Tree, logger *logrus.Logger,
	eventDispatcher *events.EventDispatcher,
)

Init initializes a transport instance.

func (*IRCTransport) Name

func (transport *IRCTransport) Name() string

Name of the transport.

func (*IRCTransport) NickIsMe

func (transport *IRCTransport) NickIsMe(nick string) bool

NickIsMe checks if the sender is the transport.

func (*IRCTransport) Run

func (transport *IRCTransport) Run()

Run starts the transport's main loop.

func (*IRCTransport) SendMassNotice

func (transport *IRCTransport) SendMassNotice(message string)

SendMassNotice sends a notice to all the channels transport is on.

func (*IRCTransport) SendMessage

func (transport *IRCTransport) SendMessage(sourceEvent *events.EventMessage, message string)

SendMessage sends a message to the channel.

func (*IRCTransport) SendNotice

func (transport *IRCTransport) SendNotice(sourceEvent *events.EventMessage, message string)

SendNotice sends a notice to the channel.

func (*IRCTransport) SendPrivateMessage

func (transport *IRCTransport) SendPrivateMessage(sourceEvent *events.EventMessage, nick, message string)

SendPrivateMessage sends a message to the nick.

func (*IRCTransport) SendRawMessage

func (transport *IRCTransport) SendRawMessage(command string, params []string, trailing string)

sendRawMessage sends raw command to the server.