msc2946

Documentation

Overview

Package msc2946 'Spaces Summary' implements https://github.com/matrix-org/matrix-doc/pull/2946

Index

• Constants
• func Defaults(r *gomatrixserverlib.MSC2946SpacesRequest)
• func Enable(base *base.BaseDendrite, rsAPI roomserver.RoomserverInternalAPI, ...) error
• func SpaceTarget(he *gomatrixserverlib.HeaderedEvent) string
• type DB
  • func (d *DB) References(ctx context.Context, roomID string) ([]*gomatrixserverlib.HeaderedEvent, error)
  • func (d *DB) StoreReference(ctx context.Context, he *gomatrixserverlib.HeaderedEvent) error
• type Database
  • func NewDatabase(dbOpts *config.DatabaseOptions) (Database, error)

Constants

const (
	ConstCreateEventContentKey = "type"
	ConstSpaceChildEventType   = "m.space.child"
	ConstSpaceParentEventType  = "m.space.parent"
)

Functions

func Defaults

func Defaults(r *gomatrixserverlib.MSC2946SpacesRequest)

Defaults sets the request defaults

func Enable

func Enable(
	base *base.BaseDendrite, rsAPI roomserver.RoomserverInternalAPI, userAPI userapi.UserInternalAPI,
	fsAPI fs.FederationInternalAPI, keyRing gomatrixserverlib.JSONVerifier,
) error

Enable this MSC

func SpaceTarget

func SpaceTarget(he *gomatrixserverlib.HeaderedEvent) string

SpaceTarget returns the destination room ID for the space event. This is either a child or a parent depending on the event type.

Types

type DB

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

func (*DB) References

func (d *DB) References(ctx context.Context, roomID string) ([]*gomatrixserverlib.HeaderedEvent, error)

func (*DB) StoreReference

func (d *DB) StoreReference(ctx context.Context, he *gomatrixserverlib.HeaderedEvent) error

type Database

type Database interface {
	// StoreReference persists a child or parent space mapping.
	StoreReference(ctx context.Context, he *gomatrixserverlib.HeaderedEvent) error
	// References returns all events which have the given roomID as a parent or child space.
	References(ctx context.Context, roomID string) ([]*gomatrixserverlib.HeaderedEvent, error)
}

func NewDatabase

func NewDatabase(dbOpts *config.DatabaseOptions) (Database, error)

NewDatabase loads the database for msc2836