ruma::api

Crate client

Source
Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.
Expand description

(De)serializable types for the Matrix Client-Server API. These types can be shared by client and server code.

Modules§

  • account
    Endpoints for account registration and management.
  • alias
    Endpoints for room aliases.
  • appservice
    Endpoints part of the application service extension of the client-server API
  • authenticated_media
    Authenticated endpoints for the content repository.
  • backup
    Endpoints for server-side key backups.
  • config
    Endpoints for client configuration.
  • context
    Endpoints for event context.
  • dehydrated_deviceunstable-msc3814
    Endpoints for managing dehydrated devices.
  • delayed_eventsunstable-msc4140
    Endpoints for sending and interacting with delayed events.
  • device
    Endpoints for managing devices.
  • directory
    Endpoints for the public room directory.
  • discovery
    Server discovery endpoints.
  • error
    Errors that can be sent from the homeserver.
  • filter
    Endpoints for event filters.
  • http_headers
    Helpers for HTTP headers with the http crate.
  • keys
    Endpoints for key management
  • knock
    Endpoints to knock on a room.
  • media
    Endpoints and helpers for the media repository.
  • membership
    Endpoints for room membership.
  • message
    Endpoints for sending and receiving messages
  • presence
    Endpoints for user presence.
  • profile
    Endpoints for user profiles.
  • push
    Endpoints for push notifications.
  • read_marker
    Endpoints for “fully read markers”
  • receipt
    Endpoints for event receipts.
  • redact
    Endpoints for event redaction.
  • relations
    Endpoints for querying relations
  • rendezvousunstable-msc4108
    Endpoints for managing rendezvous sessions.
  • room
    Endpoints for room management.
  • search
    Endpoints for event searches.
  • server
    Endpoints for server administration.
  • session
    Endpoints for user session management.
  • space
    Endpoints for spaces.
  • state
    Endpoints for managing room state
  • sync
    Endpoints for getting and synchronizing events.
  • tag
    Endpoints for tagging rooms.
  • thirdparty
    Endpoints for third party lookups
  • threads
    Endpoints for querying threads in a room.
  • to_device
    Endpoints for client devices to exchange information not persisted in room DAG.
  • typing
    Endpoints for typing notifications.
  • uiaa
    Module for User-Interactive Authentication API types.
  • user_directory
    Endpoints for the user directory.
  • voip
    Endpoints for Voice over IP.

Structs§