matrixbot

Documentation

Index

• func PushEntries(feed *model.Feed, entries model.Entries, ...) error
• type Client
  • func NewClient(matrixBaseURL string) *Client
  • func (c *Client) DiscoverEndpoints() (*DiscoveryEndpointResponse, error)
  • func (c *Client) Login(homeServerURL, matrixUsername, matrixPassword string) (*LoginResponse, error)
  • func (c *Client) SendFormattedTextMessage(homeServerURL, accessToken, roomID, textMessage, formattedMessage string) (*RoomEventResponse, error)
• type DiscoveryEndpointResponse
• type HomeServerInformation
• type IdentityServerInformation
• type LoginRequest
• type LoginResponse
• type RoomEventResponse
• type TextMessageEventRequest
• type UserIdentifier

Functions

func PushEntries

func PushEntries(feed *model.Feed, entries model.Entries, matrixBaseURL, matrixUsername, matrixPassword, matrixRoomID string) error

PushEntry pushes entries to matrix chat using integration settings provided

Types

type Client

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

func NewClient

func NewClient(matrixBaseURL string) *Client

func (*Client) DiscoverEndpoints

func (c *Client) DiscoverEndpoints() (*DiscoveryEndpointResponse, error)

Specs: https://spec.matrix.org/v1.8/client-server-api/#getwell-knownmatrixclient

func (*Client) Login

func (c *Client) Login(homeServerURL, matrixUsername, matrixPassword string) (*LoginResponse, error)

Specs https://spec.matrix.org/v1.8/client-server-api/#post_matrixclientv3login

func (*Client) SendFormattedTextMessage

func (c *Client) SendFormattedTextMessage(homeServerURL, accessToken, roomID, textMessage, formattedMessage string) (*RoomEventResponse, error)

Specs https://spec.matrix.org/v1.8/client-server-api/#put_matrixclientv3roomsroomidsendeventtypetxnid

type DiscoveryEndpointResponse

type DiscoveryEndpointResponse struct {
	HomeServerInformation     HomeServerInformation     `json:"m.homeserver"`
	IdentityServerInformation IdentityServerInformation `json:"m.identity_server"`
}

type HomeServerInformation

type HomeServerInformation struct {
	BaseURL string `json:"base_url"`
}

type IdentityServerInformation

type IdentityServerInformation struct {
	BaseURL string `json:"base_url"`
}

type LoginRequest

type LoginRequest struct {
	Type       string         `json:"type"`
	Identifier UserIdentifier `json:"identifier"`
	Password   string         `json:"password"`
}

type LoginResponse

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

type RoomEventResponse

type RoomEventResponse struct {
	EventID string `json:"event_id"`
}

type TextMessageEventRequest

type TextMessageEventRequest struct {
	MsgType       string `json:"msgtype"`
	Body          string `json:"body"`
	Format        string `json:"format"`
	FormattedBody string `json:"formatted_body"`
}

type UserIdentifier

type UserIdentifier struct {
	Type string `json:"type"`
	User string `json:"user"`
}