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.3.0
Help Pages
| mx.api-package | Minimal Matrix Client-Server API |
| mx.api | Minimal Matrix Client-Server API |
| mx_canonical_json | Encode a value as Matrix canonical JSON |
| mx_delete_device | Delete a device |
| mx_devices | List this account's devices |
| mx_download | Download a media file by mxc URI |
| mx_get_account_data | Get account data |
| mx_get_state | Get a room state event |
| mx_guess_mime | Guess a MIME type from a file extension |
| 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_media_config | Query the homeserver's media configuration |
| mx_messages | Fetch historical messages from a room |
| mx_profile | Get a user's profile |
| mx_react | Send a reaction (annotation) to a room event |
| mx_read_receipt | Send a read receipt for a room event |
| mx_redact | Redact an 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_invite | Invite a user to 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_audio | Send a media file to a room |
| mx_send_event | Send an arbitrary room event |
| mx_send_file | Send a media file to a room |
| mx_send_image | Send a media file to a room |
| mx_send_media | Send a media file to a room |
| mx_send_to_device | Send a to-device event |
| mx_send_video | Send a media file to a room |
| mx_session | Reconstruct a session from saved credentials |
| mx_set_account_data | Set account data |
| mx_set_avatar_url | Set this user's avatar |
| mx_set_displayname | Set this user's display name |
| mx_set_state | Set a room state event |
| mx_sync | One-shot sync against the homeserver |
| mx_typing | Send a typing notification |
| mx_upload | Upload a file to the homeserver media repository |
| mx_whoami | Return the identity of the current session |