noordstar/elm-matrix-sdk-beta/3.4.0

NOTE: the latest version is 3.6.1

Matrix.Room

Room

What is usually called a chat, a channel, a conversation or a group chat on other platforms, the term used in Matrix is a "room". A room is a conversation where a group of users talk to each other.

type alias Room =
Room

The Matrix Room type representing a room that the Matrix user has joined.

mostRecentEvents : Room -> List Event

Get a list of the most recent events sent in the room.

roomId : Room -> String

Get a room's room id. This is an opaque string that distinguishes rooms from each other.

This module exposes various functions that help you inspect various aspects of a room.

Account data

Account data is personal information that the user stores about this Matrix room. This may include information like:

  • What type of room this is
  • A list of members in the room to ignore
  • A list of currently ongoing chess matches in the room
  • Personal notes the user may be taking

You may consider the account data as a Dict String Json.Value type. Account data is linked to the user account: other logged in devices can see the account data too, as the server synchronizes it, but the server shouldn´t show it to other users.

getAccountData : String -> Room -> Maybe Value

Get a piece of account data linked to a certain string key.