Stateful Matrix Client Helpers
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘mx.client’ version 0.2.1
Help Pages
| mx.client-package | Stateful Matrix Client Helpers |
| mx.client | Stateful Matrix Client Helpers |
| mx_accept_invites | Accept pending Matrix room invites |
| mx_client_configure | Configure and save a Matrix client |
| mx_client_config_path | Path to a Matrix client config file |
| mx_client_from_config | Wrap a list as an mx.client config |
| mx_client_legacy_config_path | Legacy Matrix config path for an application |
| mx_client_load | Load a Matrix client config |
| mx_client_relogin | Re-login with stored credentials and refresh the saved token |
| mx_client_save | Save a Matrix client config |
| mx_client_session | Build an mx.api session from a client config |
| mx_crypto_account | Load or create this client's Olm account |
| mx_crypto_account_save | Persist an Olm account to the store |
| mx_crypto_claim_otks | Claim a one-time key for each device |
| mx_crypto_cross_signing_bootstrap | Bootstrap and sign this Matrix device's cross-signing identity |
| mx_crypto_cross_signing_load | Load locally persisted Matrix cross-signing keys |
| mx_crypto_decrypt_event | Decrypt an m.room.encrypted event (Megolm) |
| mx_crypto_device_keys | Build a signed device_keys object for upload |
| mx_crypto_encrypt_event | Encrypt event content for a room (Megolm) |
| mx_crypto_encrypt_for_devices | Encrypt an event for an encrypted room's devices |
| mx_crypto_handle_to_device | Decrypt an inbound Olm to-device payload |
| mx_crypto_inbound_session | Build an inbound Megolm session from a shared room key |
| mx_crypto_known_devices | List the devices (and identity keys) of some users |
| mx_crypto_mark_key_requests_sent | Mark successfully transmitted room-key requests |
| mx_crypto_process_sync | Process a sync response: store room keys, decrypt room events |
| mx_crypto_publish_keys | Publish this device's identity and one-time keys |
| mx_crypto_room_key_payload | Encrypt a Megolm room key to one device as a to-device payload |
| mx_crypto_send_key_requests | Send queued Matrix room-key requests or cancellations |
| mx_crypto_sessions_load | Load a session set from the crypto store |
| mx_crypto_sessions_new | Create an empty E2EE session set |
| mx_crypto_sessions_save | Persist a session set to the crypto store |
| mx_crypto_store_dir | Directory holding this client's encryption state |
| mx_crypto_user_trust | Check a directional Matrix identity verification |
| mx_crypto_verify_user | Verify another Matrix user's independently authenticated identity |
| mx_extract_invites | Extract pending invite room ids from a sync response |
| mx_extract_invite_records | Extract pending invites with the member who sent them |
| mx_extract_media_events | Extract media message events from a sync response |
| mx_extract_reactions | Extract reaction events from a sync response |
| mx_extract_reaction_verdict | Extract a reaction approval verdict from sync events |
| mx_extract_text_events | Extract text message events from a sync response |
| mx_markdown_to_html | Convert a conservative markdown subset to Matrix custom HTML |
| mx_pill_mentions | Turn textual @mentions into Matrix pills in formatted HTML |
| mx_resolve_room | Resolve a room id, name, or default room |
| mx_room_encrypted | Is a room end-to-end encrypted? |
| mx_room_lookup_by_name | Look up a joined room by display name |
| mx_sas_accept | Accept an incoming SAS verification request |
| mx_sas_cancel | Cancel a SAS transaction without granting trust |
| mx_sas_confirm | Confirm or reject the displayed Matrix SAS |
| mx_sas_console | Compare a Matrix SAS through a trusted interactive console |
| mx_sas_from_request | Create a SAS transaction from an incoming verification request |
| mx_sas_outgoing | Read or acknowledge queued SAS protocol messages |
| mx_sas_receive | Receive one standard Matrix SAS protocol event |
| mx_sas_record_trust | Record trust after a human-confirmed, authenticated SAS exchange |
| mx_sas_session | Create an in-memory Matrix SAS transaction |
| mx_sas_start | Begin the SAS key agreement after request negotiation |
| mx_sas_status | Inspect a Matrix SAS verification transaction |
| mx_send_encrypted | Send an end-to-end encrypted message to a room |
| mx_send_media | Send a media file to a Matrix room |
| mx_send_table | Send tabular data to a Matrix room |
| mx_send_text | Send plain text to a Matrix room |
| mx_set_displayname | Set the account's profile display name |
| mx_sync_update | Sync once and update the stored cursor |
| mx_table_html | Render tabular data as Matrix custom HTML |
| mx_verify_console | Verify a Matrix client interactively from an R console |
| mx_with_relogin | Run a client operation, re-logging in once on an expired token |
| print.mx_client_config | Print a Matrix client config |