mx_room_invite: Invite a user to a room

In mx.api: Minimal Matrix Client-Server API

Invite a user to a room

Description

Invitation at creation time is covered by mx_room_create(); this covers the other common lifecycle case, inviting into an existing room.

Usage

mx_room_invite(session, room_id, user_id)

Arguments

session	An "mx_session" object.
room_id	Character. The room ID.
user_id	Character. The Matrix ID to invite.

Value

Invisibly TRUE on success.

Examples

## Not run: 
mx_room_invite(s, "!abc:example", "@friend:example.org")

## End(Not run)

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