adapter

type Adapter interface {
	// GetChannelInfo provides info on a specific provider channel accessible
	// to the adapter.
	GetChannelInfo(channelID string) (*ChannelInfo, error)

	// GetName provides the name of this adapter as per the configuration.
	GetName() string

	// GetPresentChannels returns a slice of channels that a user is present in.
	GetPresentChannels(userID string) ([]*ChannelInfo, error)

	// GetUserInfo provides info on a specific provider user accessible
	// to the adapter.
	GetUserInfo(userID string) (*UserInfo, error)

	// Listen causes the Adapter to initiate a connection to its provider and
	// begin relaying back events (including errors) via the returned channel.
	Listen(ctx context.Context) <-chan *ProviderEvent

	// SendErrorMessage sends an error message to a specified channel.
	// TODO Create a MessageBuilder at some point to replace this.
	SendErrorMessage(channelID string, title string, text string) error

	// SendMessage sends a standard output message to a specified channel.
	// TODO Create a MessageBuilder at some point to replace this.
	SendMessage(channel string, message string) error
}

type AuthenticationErrorEvent struct {
	Msg string
}

type ChannelInfo struct {
	ID      string
	Members []string
	Name    string
}

type ChannelJoinedEvent struct {
	Channel string
}

type ChannelMessageEvent struct {
	ChannelID string
	Text      string
	UserID    string
}

type ConnectedEvent struct {
}

type DirectMessageEvent struct {
	ChannelID string
	Text      string
	UserID    string
}

type DisconnectedEvent struct {
	Intentional bool
}

type ErrorEvent struct {
	Code int
	Msg  string
}

type Info struct {
	User     *UserInfo
	Provider *ProviderInfo
}

type ProviderEvent struct {
	// The type of event
	EventType string

	// The event instance
	Data interface{}

	// Contextual info (user, provider)
	Info *Info

	// The adapter that generated the event
	Adapter Adapter
}

type ProviderInfo struct {
	Type string
	Name string
}

type RequestorIdentity struct {
	Adapter     Adapter
	ChatUser    *UserInfo
	ChatChannel *ChannelInfo
	GortUser    *rest.User
}

type UserInfo struct {
	ID                    string
	Name                  string
	DisplayName           string
	DisplayNameNormalized string
	Email                 string
	FirstName             string
	LastName              string
	RealName              string
	RealNameNormalized    string
}