Package: mx.api 0.3.0

Troy Hernandez

mx.api: Minimal Matrix Client-Server API

A minimal-dependency client for the 'Matrix' Client-Server HTTP API <https://spec.matrix.org/>, suitable for talking to a 'Synapse' <https://element-hq.github.io/synapse/> or 'Conduit' <https://conduit.rs/> homeserver. Covers login, room management, message send and history, media upload or download, and the transport endpoints needed to coordinate end-to-end encryption (device-key and one-time-key publication, key query and claim, to-device events). Encryption itself is out of scope; pair with a separate crypto package.

Authors:Troy Hernandez [aut, cre], cornball.ai [cph]

mx.api_0.3.0.tar.gz
mx.api_0.3.0.tar.gz(r-4.7-any)mx.api_0.3.0.tar.gz(r-4.6-any)
mx.api_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
mx.api/json (API)
NEWS

# Install 'mx.api' in R:
install.packages('mx.api', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/cornball-ai/mx.api/issues

On CRAN:

Conda:

2.18 score 491 downloads 44 exports 2 dependencies

Last updated from:b396737d2d. Checks:4 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK103
source / vignettesOK182
linux-release-x86_64OK103
wasm-releaseOK100

Exports:mx_canonical_jsonmx_delete_devicemx_devicesmx_downloadmx_get_account_datamx_get_statemx_guess_mimemx_keys_claimmx_keys_querymx_keys_uploadmx_loginmx_logoutmx_media_configmx_messagesmx_profilemx_reactmx_read_receiptmx_redactmx_registermx_room_createmx_room_invitemx_room_joinmx_room_leavemx_room_membersmx_room_namemx_room_topicmx_roomsmx_sendmx_send_audiomx_send_eventmx_send_filemx_send_imagemx_send_mediamx_send_to_devicemx_send_videomx_sessionmx_set_account_datamx_set_avatar_urlmx_set_displaynamemx_set_statemx_syncmx_typingmx_uploadmx_whoami

Dependencies:curljsonlite

Readme and manuals

Help Manual

Help pageTopics
Minimal Matrix Client-Server APImx.api-package mx.api
Encode a value as Matrix canonical JSONmx_canonical_json
Delete a devicemx_delete_device
List this account's devicesmx_devices
Download a media file by mxc URImx_download
Get account datamx_get_account_data
Get a room state eventmx_get_state
Guess a MIME type from a file extensionmx_guess_mime
Claim one-time keys for an Olm handshakemx_keys_claim
Query device keys for one or more usersmx_keys_query
Upload device identity and one-time keysmx_keys_upload
Log in to a Matrix homeservermx_login
Log out of a Matrix sessionmx_logout
Query the homeserver's media configurationmx_media_config
Fetch historical messages from a roommx_messages
Get a user's profilemx_profile
Send a reaction (annotation) to a room eventmx_react
Send a read receipt for a room eventmx_read_receipt
Redact an eventmx_redact
Register a new account on a Matrix homeservermx_register
Create a roommx_room_create
Invite a user to a roommx_room_invite
Join a room by ID or aliasmx_room_join
Leave a roommx_room_leave
List the members of a roommx_room_members
Get a room's human-readable namemx_room_name
Get a room's topicmx_room_topic
List rooms the user has joinedmx_rooms
Send a message to a roommx_send
Send an arbitrary room eventmx_send_event
Send a media file to a roommx_send_audio mx_send_file mx_send_image mx_send_media mx_send_video
Send a to-device eventmx_send_to_device
Reconstruct a session from saved credentialsmx_session
Set account datamx_set_account_data
Set this user's avatarmx_set_avatar_url
Set this user's display namemx_set_displayname
Set a room state eventmx_set_state
One-shot sync against the homeservermx_sync
Send a typing notificationmx_typing
Upload a file to the homeserver media repositorymx_upload
Return the identity of the current sessionmx_whoami