Minimal Matrix Client-Server API
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘mx.api’ version 0.2.0
Help Pages
| mx.api-package | mx.api: Minimal Matrix Client-Server API |
| mx.api | mx.api: Minimal Matrix Client-Server API |
| mx_canonical_json | Encode a value as Matrix canonical JSON |
| mx_download | Download a media file by mxc URI |
| mx_keys_claim | Claim one-time keys for an Olm handshake |
| mx_keys_query | Query device keys for one or more users |
| mx_keys_upload | Upload device identity and one-time keys |
| 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_send_to_device | Send a to-device event |
| 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 |