mx_room_name: Get a room's human-readable name

In mx.api: Minimal Matrix Client-Server API

Get a room's human-readable name

Description

Reads the m.room.name state event. Returns NULL if the room has no name set or the state event is inaccessible.

Usage

mx_room_name(session, room_id)

Arguments

session	An "mx_session" object.
room_id	Character. The room ID.

Value

Character scalar or NULL.

Examples

## Not run: 
mx_room_name(s, "!abc:matrix.example")

## End(Not run)

mx.api documentation built on Sept. 12, 2026, 1:07 a.m.