Welcome to mautrix-python’s documentation!
API reference
- mautrix.api
APIPathMethodPathBuilderHTTPAPIHTTPAPI.default_uaHTTPAPI.global_default_retry_countHTTPAPI.__init__()HTTPAPI.base_urlHTTPAPI.tokenHTTPAPI.logHTTPAPI.sessionHTTPAPI.as_user_idHTTPAPI.as_device_idHTTPAPI.txn_idHTTPAPI.default_retry_countHTTPAPI.log_download_request()HTTPAPI.log_download_request_done()HTTPAPI.request()HTTPAPI.get_txn_id()HTTPAPI.get_download_url()HTTPAPI.parse_mxc_uri()
- mautrix.client.api
ClientAPIClientAPI.__init__()ClientAPI.add_room_alias()ClientAPI.ban_user()ClientAPI.beeper_update_profile()ClientAPI.claim_keys()ClientAPI.create_device_msc4190()ClientAPI.create_filter()ClientAPI.create_mxc()ClientAPI.create_room()ClientAPI.discover()ClientAPI.download_media()ClientAPI.download_thumbnail()ClientAPI.fill_member_event()ClientAPI.forget_room()ClientAPI.get_account_data()ClientAPI.get_avatar_url()ClientAPI.get_displayname()ClientAPI.get_event()ClientAPI.get_event_context()ClientAPI.get_filter()ClientAPI.get_joined_members()ClientAPI.get_joined_rooms()ClientAPI.get_login_flows()ClientAPI.get_media_repo_config()ClientAPI.get_members()ClientAPI.get_messages()ClientAPI.get_presence()ClientAPI.get_profile()ClientAPI.get_push_rule()ClientAPI.get_room_directory()ClientAPI.get_room_directory_visibility()ClientAPI.get_room_tag()ClientAPI.get_room_tags()ClientAPI.get_state()ClientAPI.get_state_event()ClientAPI.get_url_preview()ClientAPI.invite_user()ClientAPI.join_room()ClientAPI.join_room_by_id()ClientAPI.kick_user()ClientAPI.knock_room()ClientAPI.leave_room()ClientAPI.login()ClientAPI.logout()ClientAPI.logout_all()ClientAPI.mxidClientAPI.parse_user_id()ClientAPI.query_keys()ClientAPI.react()ClientAPI.redact()ClientAPI.remove_push_rule()ClientAPI.remove_room_alias()ClientAPI.remove_room_tag()ClientAPI.resolve_room_alias()ClientAPI.search_users()ClientAPI.send_emote()ClientAPI.send_file()ClientAPI.send_image()ClientAPI.send_member_event()ClientAPI.send_message()ClientAPI.send_message_event()ClientAPI.send_notice()ClientAPI.send_receipt()ClientAPI.send_state_event()ClientAPI.send_sticker()ClientAPI.send_text()ClientAPI.send_to_device()ClientAPI.send_to_one_device()ClientAPI.set_account_data()ClientAPI.set_avatar_url()ClientAPI.set_displayname()ClientAPI.set_fully_read_marker()ClientAPI.set_presence()ClientAPI.set_push_rule()ClientAPI.set_room_directory_visibility()ClientAPI.set_room_tag()ClientAPI.set_typing()ClientAPI.sync()ClientAPI.unban_user()ClientAPI.upload_cross_signing_keys()ClientAPI.upload_keys()ClientAPI.upload_many_signatures()ClientAPI.upload_media()ClientAPI.upload_one_signature()ClientAPI.versions()ClientAPI.whoami()ClientAPI.fill_member_event_callbackClientAPI.localpartClientAPI.domainClientAPI.device_idClientAPI.apiClientAPI.logClientAPI.versions_cache
- mautrix.client
- mautrix.client.state_store
StateStoreStateStore.close()StateStore.flush()StateStore.get_create()StateStore.get_encryption_info()StateStore.get_member()StateStore.get_member_profiles()StateStore.get_members()StateStore.get_members_filtered()StateStore.get_membership()StateStore.get_power_levels()StateStore.has_create_cached()StateStore.has_encryption_info_cached()StateStore.has_full_member_list()StateStore.has_power_level()StateStore.has_power_levels_cached()StateStore.invited()StateStore.is_encrypted()StateStore.is_joined()StateStore.joined()StateStore.left()StateStore.open()StateStore.set_create()StateStore.set_encryption_info()StateStore.set_member()StateStore.set_members()StateStore.set_membership()StateStore.set_power_levels()StateStore.update_state()
- Implementations
- mautrix.appservice
AppServiceAppService.__init__()AppService.http_sessionAppService.intentAppService.ping_self()AppService.start()AppService.stop()AppService.serverAppService.domainAppService.idAppService.verify_sslAppService.tls_certAppService.tls_keyAppService.as_tokenAppService.hs_tokenAppService.bot_mxidAppService.default_uaAppService.default_http_retry_countAppService.bridge_nameAppService.state_storeAppService.transactionsAppService.query_userAppService.query_aliasAppService.readyAppService.liveAppService.loopAppService.logAppService.appAppService.runner
- Appservice server mixin
AppServiceServerMixinAppServiceServerMixin.__init__()AppServiceServerMixin.handle_matrix_event()AppServiceServerMixin.handle_transaction()AppServiceServerMixin.matrix_event_handler()AppServiceServerMixin.register_routes()AppServiceServerMixin.logAppServiceServerMixin.hs_tokenAppServiceServerMixin.ephemeral_eventsAppServiceServerMixin.encryption_eventsAppServiceServerMixin.synchronous_handlersAppServiceServerMixin.query_userAppServiceServerMixin.query_aliasAppServiceServerMixin.transactionsAppServiceServerMixin.event_handlersAppServiceServerMixin.to_device_handlerAppServiceServerMixin.otk_handlerAppServiceServerMixin.device_list_handler
- Appservice client API
AppServiceAPIAppServiceAPI.__init__()AppServiceAPI.bot_intent()AppServiceAPI.intent()AppServiceAPI.real_user()AppServiceAPI.request()AppServiceAPI.user()AppServiceAPI.base_logAppServiceAPI.identityAppServiceAPI.bot_mxidAppServiceAPI.state_storeAppServiceAPI.txn_idAppServiceAPI.childrenAppServiceAPI.real_usersAppServiceAPI.is_real_userAppServiceAPI.bridge_name
ChildAppServiceAPI
- Intents
IntentAPIIntentAPI.__init__()IntentAPI.appservice_ping()IntentAPI.ban_user()IntentAPI.batch_send()IntentAPI.beeper_batch_send()IntentAPI.beeper_delete_room()IntentAPI.ensure_joined()IntentAPI.ensure_registered()IntentAPI.error_and_leave()IntentAPI.get_pinned_messages()IntentAPI.get_power_levels()IntentAPI.get_room_avatar_url()IntentAPI.get_room_displayname()IntentAPI.get_room_member_info()IntentAPI.get_room_members()IntentAPI.invite_user()IntentAPI.join_room_by_id()IntentAPI.kick_user()IntentAPI.leave_room()IntentAPI.mark_read()IntentAPI.pin_message()IntentAPI.redact()IntentAPI.send_message_event()IntentAPI.send_state_event()IntentAPI.set_join_rule()IntentAPI.set_pinned_messages()IntentAPI.set_power_levels()IntentAPI.set_presence()IntentAPI.set_room_avatar()IntentAPI.set_room_name()IntentAPI.set_room_topic()IntentAPI.set_typing()IntentAPI.unban_user()IntentAPI.unpin_message()IntentAPI.user()IntentAPI.apiIntentAPI.state_storeIntentAPI.botIntentAPI.log
- mautrix.crypto.attachments
- mautrix.types
JSONUserIDEventIDRoomIDRoomAliasFilterIDContentURISyncTokenDeviceIDSessionIDSigningKeyIdentityKeyDiscoveryInformationDiscoveryIntegrationsDiscoveryIntegrationServerDiscoveryServerLoginFlowLoginFlowListLoginResponseLoginTypeMatrixUserIdentifierPhoneIdentifierThirdPartyIdentifierUserIdentifierTypeWhoamiResponseClaimKeysResponseCrossSignerCrossSigningKeysCrossSigningUsageDecryptedOlmEventDeviceIdentityDeviceKeysOlmEventKeysQueryKeysResponseTOFUSigningKeyTrustStateUnsignedDeviceInfoAccountDataEventASToDeviceEventAudioInfoBaseEventBaseFileInfoBaseMessageEventContentBaseMessageEventContentFuncsBaseMessageEventContentFuncs.get_edit()BaseMessageEventContentFuncs.get_reply_to()BaseMessageEventContentFuncs.get_thread_parent()BaseMessageEventContentFuncs.relates_toBaseMessageEventContentFuncs.serialize()BaseMessageEventContentFuncs.set_edit()BaseMessageEventContentFuncs.set_reply()BaseMessageEventContentFuncs.set_thread_parent()BaseMessageEventContentFuncs.trim_reply_fallback()BaseMessageEventContentFuncs.body
BaseRoomEventBaseUnsignedBatchSendEventBatchSendStateEventBeeperMessageStatusEventBeeperMessageStatusEventContentCallAnswerEventContentCallCandidateCallCandidatesEventContentCallDataCallDataTypeCallEventCallHangupEventContentCallHangupReasonCallInviteEventContentCallNegotiateEventContentCallRejectEventContentCallSelectAnswerEventContentCanonicalAliasStateEventContentEncryptedEventEncryptedFileEncryptedMegolmEventContentEncryptedOlmEventContentEncryptionAlgorithmEncryptionKeyAlgorithmEventTypeEventType.tEventType.t_classEventType.ALLEventType.BEEPER_MESSAGE_STATUSEventType.BEEPER_ROOM_KEY_ACKEventType.CALL_ANSWEREventType.CALL_CANDIDATESEventType.CALL_HANGUPEventType.CALL_INVITEEventType.CALL_NEGOTIATEEventType.CALL_REJECTEventType.CALL_SELECT_ANSWEREventType.CROSS_SIGNING_MASTEREventType.CROSS_SIGNING_SELF_SIGNINGEventType.CROSS_SIGNING_USER_SIGNINGEventType.ClassEventType.DIRECTEventType.FORWARDED_ROOM_KEYEventType.IGNORED_USER_LISTEventType.MEGOLM_BACKUP_V1EventType.ORG_MATRIX_ROOM_KEY_WITHHELDEventType.PRESENCEEventType.PUSH_RULESEventType.REACTIONEventType.RECEIPTEventType.ROOM_AVATAREventType.ROOM_CANONICAL_ALIASEventType.ROOM_CREATEEventType.ROOM_ENCRYPTEDEventType.ROOM_ENCRYPTIONEventType.ROOM_HISTORY_VISIBILITYEventType.ROOM_JOIN_RULESEventType.ROOM_KEYEventType.ROOM_KEY_REQUESTEventType.ROOM_KEY_WITHHELDEventType.ROOM_MEMBEREventType.ROOM_MESSAGEEventType.ROOM_NAMEEventType.ROOM_PINNED_EVENTSEventType.ROOM_POWER_LEVELSEventType.ROOM_REDACTIONEventType.ROOM_TOMBSTONEEventType.ROOM_TOPICEventType.SECRET_STORAGE_DEFAULT_KEYEventType.SPACE_CHILDEventType.SPACE_PARENTEventType.STICKEREventType.TAGEventType.TO_DEVICE_DUMMYEventType.TO_DEVICE_ENCRYPTEDEventType.TYPINGEventType.deserialize()EventType.find()EventType.is_account_dataEventType.is_ephemeralEventType.is_messageEventType.is_stateEventType.is_to_deviceEventType.json()EventType.parse_json()EventType.serialize()EventType.with_class()
FileInfoFormatForwardedRoomKeyEventContentGenericEventImageInfoInReplyToJoinRuleJoinRulesStateEventContentJSONWebKeyKeyIDKeyRequestActionLocationInfoLocationMessageEventContentMediaMessageEventContentMembershipMemberStateEventContentMessageEventMessageStatusMessageStatusReasonMessageTypeMessageUnsignedOlmCiphertextOlmMsgTypePowerLevelStateEventContentPowerLevelStateEventContent.ensure_event_level()PowerLevelStateEventContent.ensure_user_level()PowerLevelStateEventContent.get_event_level()PowerLevelStateEventContent.get_user_level()PowerLevelStateEventContent.set_event_level()PowerLevelStateEventContent.set_user_level()PowerLevelStateEventContent.usersPowerLevelStateEventContent.users_defaultPowerLevelStateEventContent.eventsPowerLevelStateEventContent.events_defaultPowerLevelStateEventContent.notificationsPowerLevelStateEventContent.state_defaultPowerLevelStateEventContent.invitePowerLevelStateEventContent.kickPowerLevelStateEventContent.banPowerLevelStateEventContent.redact
PresenceEventPresenceEventContentPresenceStateReactionEventReactionEventContentReceiptEventReceiptTypeRedactionEventRedactionEventContentRelatesToRelationTypeRequestedKeyInfoRoomAvatarStateEventContentRoomCreateStateEventContentRoomEncryptionStateEventContentRoomKeyEventContentRoomKeyRequestEventContentRoomKeyWithheldCodeRoomKeyWithheldEventContentRoomNameStateEventContentRoomPinnedEventsStateEventContentRoomPredecessorRoomTagAccountDataEventContentRoomTagInfoRoomTombstoneStateEventContentRoomTopicStateEventContentRoomTypeSecretStorageDefaultKeyEventContentSingleReceiptEventContentSpaceChildStateEventContentSpaceParentStateEventContentStateEventStateUnsignedStrippedStateEventTextMessageEventContentThumbnailInfoToDeviceEventTypingEventTypingEventContentVideoInfoEventFilterFilterRoomEventFilterRoomFilterStateFilterIdentifierTypeMatrixURIMatrixURIErrorURIActionMediaCreateResponseMediaRepoConfigMXOpenGraphOpenGraphAudioOpenGraphImageOpenGraphVideoBatchSendResponseBeeperBatchSendResponseDeviceListsDeviceOTKCountEventContextPaginatedMessagesPaginationDirectionRoomAliasInfoRoomCreatePresetRoomDirectoryResponseRoomDirectoryVisibilityPushActionDictPushActionTypePushConditionPushConditionKindPushOperatorPushRulePushRuleKindPushRuleScopeMemberUserUserSearchResultsExtensibleEnumLstObjSerializableSerializableAttrsSerializableEnumSerializerErrordeserializer()field()serializer()SpecVersionsSpecVersions.R010SpecVersions.R020SpecVersions.R030SpecVersions.R040SpecVersions.R050SpecVersions.R060SpecVersions.R061SpecVersions.V11SpecVersions.V110SpecVersions.V111SpecVersions.V12SpecVersions.V13SpecVersions.V14SpecVersions.V15SpecVersions.V16SpecVersions.V17SpecVersions.V18SpecVersions.V19
VersionVersionFormatVersionsResponse
- mautrix.util
- async_db
DatabaseDatabase.__init__()Database.acquire()Database.create()Database.execute()Database.executemany()Database.fetch()Database.fetchrow()Database.fetchval()Database.override_pool()Database.schemesDatabase.start()Database.stop()Database.table_exists()Database.logDatabase.schemeDatabase.urlDatabase.upgrade_tableDatabase.owner_nameDatabase.ignore_foreign_tables
UpgradeTableregister_upgrade()PostgresDatabaseSQLiteDatabaseSQLiteCursorConnectionSchemeDatabaseExceptionDatabaseNotOwnedUnsupportedDatabaseVersionForeignTablesFound
- bridge_state
BridgeStateEventBridgeStateEvent.STARTINGBridgeStateEvent.UNCONFIGUREDBridgeStateEvent.RUNNINGBridgeStateEvent.BRIDGE_UNREACHABLEBridgeStateEvent.CONNECTINGBridgeStateEvent.BACKFILLINGBridgeStateEvent.CONNECTEDBridgeStateEvent.TRANSIENT_DISCONNECTBridgeStateEvent.BAD_CREDENTIALSBridgeStateEvent.UNKNOWN_ERRORBridgeStateEvent.LOGGED_OUTBridgeStateEvent.__new__()
BridgeStateBridgeState.human_readable_errorsBridgeState.default_sourceBridgeState.default_error_ttlBridgeState.default_ok_ttlBridgeState.state_eventBridgeState.user_idBridgeState.remote_idBridgeState.remote_nameBridgeState.timestampBridgeState.ttlBridgeState.sourceBridgeState.errorBridgeState.messageBridgeState.infoBridgeState.reasonBridgeState.send_attempts_BridgeState.fill()BridgeState.should_deduplicate()BridgeState.send()BridgeState.__init__()
GlobalBridgeState
- config
- db
- ffmpeg
- file_store
- formatter
AbstractEntityEntityStringSemiAbstractEntitySimpleEntityEntityTypeFormattedStringHTMLNoderead_html()MarkdownStringMatrixParserMatrixParser.basic_format_to_fstring()MatrixParser.block_tagsMatrixParser.blockquote_to_fstring()MatrixParser.color_to_fstring()MatrixParser.custom_node_to_fstring()MatrixParser.eMatrixParser.event_link_to_fstring()MatrixParser.exclude_plaintext_attribMatrixParser.fsMatrixParser.header_to_fstring()MatrixParser.hr_to_fstring()MatrixParser.ignore_less_relevant_linksMatrixParser.img_to_fstring()MatrixParser.link_to_fstring()MatrixParser.list_bullet()MatrixParser.list_bulletsMatrixParser.list_to_fstring()MatrixParser.node_to_fstring()MatrixParser.node_to_fstrings()MatrixParser.node_to_tagged_fstrings()MatrixParser.parse()MatrixParser.parse_node()MatrixParser.read_html()MatrixParser.room_id_link_to_fstring()MatrixParser.room_pill_to_fstring()MatrixParser.spoiler_to_fstring()MatrixParser.tag_aware_parse_node()MatrixParser.text_to_fstring()MatrixParser.url_to_fstring()MatrixParser.user_pill_to_fstring()
RecursionContextparse_html()
- format_duration
- logging
- magic
- manhole
compile_async()insert_returns()StatefulCommandCompilerInterpreterAsyncInterpreterAsyncInterpreter.readerAsyncInterpreter.writerAsyncInterpreter.runningAsyncInterpreter.__init__()AsyncInterpreter.namespaceAsyncInterpreter.bannerAsyncInterpreter.compilerAsyncInterpreter.send_exception()AsyncInterpreter.execute()AsyncInterpreter.handle_one_command()AsyncInterpreter.run_command()AsyncInterpreter.write_prompt()AsyncInterpreter.read_command()AsyncInterpreter.send_output()AsyncInterpreter.close()
InterpreterFactorystart_manhole()
- markdown
- message_send_checkpoint
MessageSendCheckpointStepMessageSendCheckpointStatusMessageSendCheckpointReportedByMessageSendCheckpointMessageSendCheckpoint.event_idMessageSendCheckpoint.room_idMessageSendCheckpoint.stepMessageSendCheckpoint.timestampMessageSendCheckpoint.statusMessageSendCheckpoint.event_typeMessageSendCheckpoint.reported_byMessageSendCheckpoint.retry_numMessageSendCheckpoint.message_typeMessageSendCheckpoint.infoMessageSendCheckpoint.client_typeMessageSendCheckpoint.client_versionMessageSendCheckpoint.send()MessageSendCheckpoint.__init__()
- opt_prometheus
- program
ProgramProgram.loopProgram.logProgram.parserProgram.argsProgram.configProgram.__init__()Program.moduleProgram.nameProgram.descriptionProgram.commandProgram.versionProgram.config_classProgram.startup_actionsProgram.shutdown_actionsProgram.run()Program.preinit()Program.base_config_pathProgram.prepare_arg_parser()Program.prepare_config()Program.load_and_update_config()Program.check_config()Program.prepare_log()Program.prepare()Program.init_loop()Program.start_prometheus()Program.system_exit()Program.start()Program.prepare_stop()Program.stop()Program.prepare_shutdown()Program.manual_stop()Program.add_startup_actions()Program.add_shutdown_actions()
- signed_token
- simple_lock
- simple_template
- variation_selector
- async_db