Minimal Matrix Client-Server API


[Up] [Top]

Documentation for package ‘mx.api’ version 0.1.0

Help Pages

mx.api-package mx.api: Minimal Matrix Client-Server API
mx.api mx.api: Minimal Matrix Client-Server API
mx_download Download a media file by mxc URI
mx_login Log in to a Matrix homeserver
mx_logout Log out of a Matrix session
mx_messages Fetch historical messages from a room
mx_react Send a reaction (annotation) to a room event
mx_read_receipt Send a read receipt for a room event
mx_register Register a new account on a Matrix homeserver
mx_rooms List rooms the user has joined
mx_room_create Create a room
mx_room_join Join a room by ID or alias
mx_room_leave Leave a room
mx_room_members List the members of a room
mx_room_name Get a room's human-readable name
mx_room_topic Get a room's topic
mx_send Send a message to a room
mx_session Reconstruct a session from saved credentials
mx_sync One-shot sync against the homeserver
mx_upload Upload a file to the homeserver media repository
mx_whoami Return the identity of the current session