matrix

Documentation

Index

• Constants
• func Exit()
• func Init(hs, login, password string, roomID id.RoomID, alias id.RoomAlias, ...) error
• func IsRoom(room string) (bool, error)
• func ResolveServer(homeserver string) (string, error)
• type Message
  • func Messages(limit int) ([]*Message, error)

Constants

const MaxRetries = 10

MaxRetries for operations

const Page = 100

Page is a amount of messages per page

const RetryDelay = 10 * time.Second

RetryDelay between retries

Functions

func Exit

func Exit()

Exit / stop matrix client

func Init

func Init(hs, login, password string, roomID id.RoomID, alias id.RoomAlias, ignore string) error

Init matrix client

func IsRoom

func IsRoom(room string) (bool, error)

IsRoom checks if room is valid room alias or room ID. True = alias, False = room ID

func ResolveServer

func ResolveServer(homeserver string) (string, error)

ResolveServer resolves actual homeserver URL from possible delegated host

Types

type Message

type Message struct {
	// ID is a matrix event id of the message
	ID id.EventID
	// Replace is a matrix ID of old (replaced) event
	Replace id.EventID
	// ReplacedNote is a text note usable from template to mark replaced message as updated
	ReplacedNote string
	// Author is a matrix id of the sender
	Author id.UserID
	// Text is the message body in plaintext/markdown format
	Text string
	// HTML is the message body in html format
	HTML string
	// CreatedAt is a timestamp, format: 2006-01-02 15:04 UTC
	CreatedAt string
	// CreatedAtFull is a time.Time object
	CreatedAtFull time.Time
}

Message struct

func Messages

func Messages(limit int) ([]*Message, error)

Messages of the room Note on limit - the output slice may be less size than limit you sent in the following cases: * room contains less messages than limit * some room messages don't contain body/formatted body