mx_get_state: Get a room state event

In mx.api: Minimal Matrix Client-Server API

Get a room state event

Description

Read-side counterpart of mx_set_state, e.g. to check whether a room is encrypted before joining the send path.

Usage

mx_get_state(session, room_id, event_type, state_key = "")

Arguments

session	An "mx_session" object.
room_id	Character. The room ID.
event_type	Character. State event type, e.g. "m.room.encryption".
state_key	Character. State key (default empty string).

Value

The state event content as a list, or NULL when the state event is not set.

Examples

## Not run: 
enc <- mx_get_state(s, "!abc:example", "m.room.encryption")
is.null(enc)   # FALSE in an encrypted room

## End(Not run)

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