version

Documentation

Index

• func DefaultRoomVersion() gomatrixserverlib.RoomVersion
• func RoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.RoomVersionDescription, error)
• func RoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.RoomVersionDescription
• func SupportedRoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.RoomVersionDescription, error)
• func SupportedRoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.RoomVersionDescription
• type UnknownVersionError
  • func (e UnknownVersionError) Error() string
• type UnsupportedVersionError
  • func (e UnsupportedVersionError) Error() string

Functions

func DefaultRoomVersion

func DefaultRoomVersion() gomatrixserverlib.RoomVersion

DefaultRoomVersion contains the room version that will, by default, be used to create new rooms on this server.

func RoomVersion

func RoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.RoomVersionDescription, error)

RoomVersion returns information about a specific room version. An UnknownVersionError is returned if the version is not known to the server.

func RoomVersions

func RoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.RoomVersionDescription

RoomVersions returns a map of all known room versions to this server.

func SupportedRoomVersion

func SupportedRoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.RoomVersionDescription, error)

SupportedRoomVersion returns information about a specific room version. An UnknownVersionError is returned if the version is not known to the server, or an UnsupportedVersionError is returned if the version is known but specifically marked as unsupported.

func SupportedRoomVersions

func SupportedRoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.RoomVersionDescription

SupportedRoomVersions returns a map of descriptions for room versions that are supported by this homeserver.

Types

type UnknownVersionError

type UnknownVersionError struct {
	Version gomatrixserverlib.RoomVersion
}

UnknownVersionError is caused when the room version is not known.

func (UnknownVersionError) Error

func (e UnknownVersionError) Error() string

type UnsupportedVersionError

type UnsupportedVersionError struct {
	Version gomatrixserverlib.RoomVersion
}

UnsupportedVersionError is caused when the room version is specifically marked as unsupported.

func (UnsupportedVersionError) Error

func (e UnsupportedVersionError) Error() string