matrixbot

README

matrixbot

matrixbot is a golang library for matrix bots

Status

In development

Documentation

Index

• func GetInitialEvent(c Config, token string, txtmsg string) int
• func JoinRoom(server string, roomID string, token string)
• func ListenAndAct(actionFunc actFunc)
• func SendTXTToRoom()
• type AuthResponse
  • func GetTokenJSON(server string, username string, passwd string) AuthResponse
• type Config
  • func ReadConfig(confFile string) Config

Functions

func GetInitialEvent

func GetInitialEvent(c Config, token string, txtmsg string) int

GetInitialEvent gets the first event id

func JoinRoom

func JoinRoom(server string, roomID string, token string)

JoinRoom lets your bot join a room

func ListenAndAct

func ListenAndAct(actionFunc actFunc)

ListenAndAct listens for incoming text messages and reacts with a function

func SendTXTToRoom

func SendTXTToRoom()

SendTXTToRoom sends a text message

Types

type AuthResponse

type AuthResponse struct {
	AccessToken string `json:"access_token"`
	DeviceID    string `json:"device_id"`
	HomeServer  string `json:"home_server"`
	UserID      string `json:"user_id"`
}

AuthResponse is a struct that holds authentication information

func GetTokenJSON

func GetTokenJSON(server string, username string, passwd string) AuthResponse

GetTokenJSON gets a session json object

type Config

type Config struct {
	Server   string
	User     string
	Password string
	RoomID   string
}

func ReadConfig

func ReadConfig(confFile string) Config

ReadConfig reads the configuration of a toml file into a Config struct