gomuks/interface/matrix.go

67 lines
2.2 KiB
Go
Raw Normal View History

2018-03-15 18:45:52 +01:00
// gomuks - A terminal Matrix client written in Go.
2020-04-19 17:10:14 +02:00
// Copyright (C) 2020 Tulir Asokan
2018-03-15 18:45:52 +01:00
//
// This program is free software: you can redistribute it and/or modify
2019-01-17 13:13:25 +01:00
// it under the terms of the GNU Affero General Public License as published by
2018-03-15 18:45:52 +01:00
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2019-01-17 13:13:25 +01:00
// GNU Affero General Public License for more details.
2018-03-15 18:45:52 +01:00
//
2019-01-17 13:13:25 +01:00
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
2018-03-15 18:45:52 +01:00
2018-03-18 20:24:03 +01:00
package ifc
2018-03-15 18:45:52 +01:00
import (
2018-11-13 23:00:35 +01:00
"maunium.net/go/mautrix"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
2019-01-17 13:13:25 +01:00
"maunium.net/go/gomuks/config"
"maunium.net/go/gomuks/matrix/muksevt"
2018-03-22 22:46:43 +01:00
"maunium.net/go/gomuks/matrix/rooms"
2018-03-15 18:45:52 +01:00
)
type Relation struct {
Type event.RelationType
Event *muksevt.Event
}
2018-03-18 20:24:03 +01:00
type MatrixContainer interface {
2018-11-13 23:00:35 +01:00
Client() *mautrix.Client
Preferences() *config.UserPreferences
2018-03-18 20:24:03 +01:00
InitClient() error
Initialized() bool
2018-05-01 18:17:57 +02:00
2018-03-18 20:24:03 +01:00
Start()
Stop()
2018-05-01 18:17:57 +02:00
Login(user, password string) error
2018-05-10 14:47:24 +02:00
Logout()
2018-05-01 18:17:57 +02:00
SendPreferencesToMatrix()
PrepareMarkdownMessage(roomID id.RoomID, msgtype event.MessageType, text, html string, relation *Relation) *muksevt.Event
SendEvent(evt *muksevt.Event) (id.EventID, error)
Redact(roomID id.RoomID, eventID id.EventID, reason string) error
SendTyping(roomID id.RoomID, typing bool)
MarkRead(roomID id.RoomID, eventID id.EventID)
JoinRoom(roomID id.RoomID, server string) (*rooms.Room, error)
LeaveRoom(roomID id.RoomID) error
CreateRoom(req *mautrix.ReqCreateRoom) (*rooms.Room, error)
2018-05-01 18:17:57 +02:00
2020-02-21 23:03:57 +01:00
FetchMembers(room *rooms.Room) error
GetHistory(room *rooms.Room, limit int) ([]*muksevt.Event, error)
GetEvent(room *rooms.Room, eventID id.EventID) (*muksevt.Event, error)
GetRoom(roomID id.RoomID) *rooms.Room
GetOrCreateRoom(roomID id.RoomID) *rooms.Room
2018-05-01 18:17:57 +02:00
Download(uri id.ContentURI) ([]byte, error)
DownloadToDisk(uri id.ContentURI, target string) (string, error)
GetDownloadURL(uri id.ContentURI) string
GetCachePath(uri id.ContentURI) string
2018-03-15 18:45:52 +01:00
}