whois

Documentation

Index

• Constants
• Variables
• type Plugin
  • func New(b bot.Bot, isupportPlugin *isupport.Plugin) *Plugin
  • func Register(b bot.Bot, isupportPlugin *isupport.Plugin) *Plugin
  • func (p *Plugin) WhoIs(nick string) (resp *WhoIsResponse, err error)
• type WhoIsChannelMode
• type WhoIsResponse
• type WhoIsServerInfo

Constants

const (
	WhoIsChannelModeNone = WhoIsChannelMode(0)
)

Variables

var ErrInvalidNick = errors.New("Invalid or no nickname given")

var ErrNoSuchNick = errors.New("No such nick/channel")

Types

type Plugin

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

func New

func New(b bot.Bot, isupportPlugin *isupport.Plugin) *Plugin

func Register

func Register(b bot.Bot, isupportPlugin *isupport.Plugin) *Plugin

func (*Plugin) WhoIs

func (p *Plugin) WhoIs(nick string) (resp *WhoIsResponse, err error)

type WhoIsChannelMode

type WhoIsChannelMode rune

type WhoIsResponse

type WhoIsResponse struct {

	// The user's nickname.
	Nick     string
	Ident    string
	Host     string
	Realname string

	// TODO 312 RPL_WHOISSERVER "<nick> <server> :<server info>"
	Server WhoIsServerInfo

	// TODO 313 RPL_WHOISOPERATOR "<nick> :is an IRC operator"
	IsOperator bool

	// TODO 301 RPL_AWAY "<nick> :<away message>"
	IsAway      bool
	AwayMessage string

	// TODO 317 RPL_WHOISIDLE "<nick> <integer> :seconds idle"
	IdleDuration time.Duration
	SignOnTime   time.Time

	// TODO 319 RPL_WHOISCHANNELS "<nick> :*( ( "@" / "+" ) <channel> " " )"
	Channels map[string]WhoIsChannelMode
}

type WhoIsServerInfo

type WhoIsServerInfo struct {
	// The server's hostname
	Host string

	// The information associated with this server
	Info string
}