Matrix

Operations 37

• Ban User
  Ban a user from a room, removing them and blocking rejoins.
  matrix.ban_user
• Reserve Media ID
  Reserve an mxc:// URI now and upload its bytes later with matrix.upload_to_media_id.
  matrix.create_media_id
• Create Room
  Create a room and return its room id, optionally inviting members.
  matrix.create_room
• Create Room Alias
  Point a room alias at a room on this homeserver.
  matrix.create_room_alias
• Delete Room Alias
  Remove a room alias mapping from this homeserver.
  matrix.delete_room_alias
• Download Media
  Download a file from the content repository as a base64 file payload.
  matrix.download_media
• Get Event
  Read a single event from a room by its event id.
  matrix.get_event
• Get Joined Members
  Read the users currently joined to a room with their display names.
  matrix.get_joined_members
• Get Media Config
  Read the homeserver's media limits, including the maximum upload size.
  matrix.get_media_config
• Get Messages
  Read a page of a room's timeline, newest first by default.
  matrix.get_messages
• Get Profile
  Read a user's display name and avatar from their profile.
  matrix.get_profile
• Get Room State
  Read a room's whole current state, or the content of one state event when an event type is given.
  matrix.get_room_state
• Preview URL
  Ask the homeserver for the OpenGraph preview of a web page.
  matrix.get_url_preview
• Invite User
  Invite a user to a room.
  matrix.invite_user
• Join Room
  Join a room by its id or alias with the connection's account.
  matrix.join_room
• Kick User
  Remove a user from a room; they may rejoin unless they are banned.
  matrix.kick_user
• Leave Room
  Leave a room with the connection's account.
  matrix.leave_room
• List Joined Rooms
  List every room the connection's account is currently joined to.
  matrix.list_joined_rooms
• Search Public Rooms
  Search the published room directory, on this or a remote homeserver.
  matrix.list_public_rooms
• List Room Aliases
  List this homeserver's local aliases for a room.
  matrix.list_room_aliases
• List Room Members
  List a room's membership events, optionally filtered by membership state.
  matrix.list_room_members
• Redact Event
  Redact an event, stripping its content from the room's history.
  matrix.redact_event
• Resolve Room Alias
  Turn a room alias such as #ops:example.org into the room id sends need.
  matrix.resolve_room_alias
• Search Messages
  Full-text search across room events the account can see.
  matrix.search_messages
• Search Users
  Search the homeserver's user directory by name or user id.
  matrix.search_users
• Send Event
  Send any room event type with a content object you supply.
  matrix.send_event
• Send Media Message
  Post an already-uploaded file into a room as an image, file, audio or video message.
  matrix.send_media_message
• Send Message
  Post a text message to a room, optionally as HTML or as a rich reply.
  matrix.send_message
• React to Event
  Add an emoji reaction to an event as an m.reaction annotation.
  matrix.send_reaction
• Send Typing Notification
  Show or clear the account's typing indicator in a room.
  matrix.send_typing
• Set Room State
  Write a state event — the room's name, topic, avatar, join rules or any custom state type.
  matrix.set_room_state
• Set Room Directory Visibility
  Publish a room in this homeserver's room directory, or unpublish it.
  matrix.set_room_visibility
• Unban User
  Lift a user's ban so they can be invited or join again.
  matrix.unban_user
• Upgrade Room
  Replace a room with a new one on a newer room version.
  matrix.upgrade_room
• Upload Media
  Upload a file to the homeserver's content repository in one request.
  matrix.upload_media
• Upload to Reserved Media ID
  Upload a file's bytes into an mxc:// URI reserved earlier.
  matrix.upload_to_media_id
• Who Am I
  Report which Matrix account and device the access token belongs to.
  matrix.whoami