matrix

README

healthcheck

Client module for matrix.

This project is released under GNU Affero General Public License v3.0, see LICENCE file in this repo for more info.

Documentation

Overview

Package matrix allows interfacing with a matrix server.

Index

• func HTTP(ctx context.Context, cli http.Client, homeserver, token, method, path string, ...) error
• type Client
  • func New(ctx context.Context, homeserver, token string) (Client, error)
  • func (c Client) HTTP(ctx context.Context, method, path string, request, response interface{}) error
• type Response
  • func (r Response) AsError() error

Functions

func HTTP

func HTTP(
	ctx context.Context, cli http.Client, homeserver, token, method, path string, request, response interface{},
) error

HTTP performs a http exchange via the matrix client. It takes the homeserver url, the client token, the http method, the path including the query and pointers to request and response payload as arguments. Request payload may be nil. Token may be "" to send an unauthenticated request.

Types

type Client

type Client struct {
	User   string
	Device string
	// contains filtered or unexported fields
}

Client to interface with a matrix server.

func New

func New(ctx context.Context, homeserver, token string) (Client, error)

New creates a new matrix client. It takes the homeserver url to contact and the client token to use as an argument. It does a whoami request to get user ID and device ID of the token. Returns an error if that fails.

func (Client) HTTP

func (c Client) HTTP(ctx context.Context, method, path string, request, response interface{}) error

HTTP performs a http exchange with the matrix server. It takes the http method, the path including the query and pointers to request and response payload as arguments. Request payload may be nil.

type Response

type Response struct {
	ErrCode string `json:"errcode"`
	ErrMsg  string `json:"error"`
}

Response is the base for all HTTP responses returned by a matrix server.

func (Response) AsError

func (r Response) AsError() error

AsError returns a descriptive error instance if the matrix server has included an error in the response. Returns nil otherwise.