mautrix.types

class mautrix.types.StateFilter: State event filter object, as specified in the create filter endpoint. Currently this is the same as RoomEventFilter.

class mautrix.types.RoomEventFilter

Room event filter object, as specified in the create filter endpoint.

lazy_load_members: bool

include_redundant_members: bool

not_rooms: List[mautrix.types.RoomID]

rooms: List[mautrix.types.RoomID]

contains_url: bool

class mautrix.types.EventType

An event type.

t

t_class

ALL = EventType("__ALL__", EventType.Class.UNKNOWN)

CALL_ANSWER = EventType("m.call.answer", EventType.Class.MESSAGE)

CALL_CANDIDATES = EventType("m.call.candidates", EventType.Class.MESSAGE)

CALL_HANGUP = EventType("m.call.hangup", EventType.Class.MESSAGE)

CALL_INVITE = EventType("m.call.invite", EventType.Class.MESSAGE)

CALL_NEGOTIATE = EventType("m.call.negotiate", EventType.Class.MESSAGE)

CALL_REJECT = EventType("m.call.reject", EventType.Class.MESSAGE)

CALL_SELECT_ANSWER = EventType("m.call.select_answer", EventType.Class.MESSAGE)

class Class

An enumeration.

UNKNOWN = 'unknown'

STATE = 'state'

MESSAGE = 'message'

ACCOUNT_DATA = 'account_data'

EPHEMERAL = 'ephemeral'

TO_DEVICE = 'to_device'

DIRECT = EventType("m.direct", EventType.Class.ACCOUNT_DATA)

FORWARDED_ROOM_KEY = EventType("m.forwarded_room_key", EventType.Class.TO_DEVICE)

IGNORED_USER_LIST = EventType("m.ignored_user_list", EventType.Class.ACCOUNT_DATA)

ORG_MATRIX_ROOM_KEY_WITHHELD = EventType("org.matrix.room_key.withheld", EventType.Class.TO_DEVICE)

PRESENCE = EventType("m.presence", EventType.Class.EPHEMERAL)

PUSH_RULES = EventType("m.push_rules", EventType.Class.ACCOUNT_DATA)

REACTION = EventType("m.reaction", EventType.Class.MESSAGE)

RECEIPT = EventType("m.receipt", EventType.Class.EPHEMERAL)

ROOM_ALIASES = EventType("m.room.aliases", EventType.Class.STATE)

ROOM_AVATAR = EventType("m.room.avatar", EventType.Class.STATE)

ROOM_CANONICAL_ALIAS = EventType("m.room.canonical_alias", EventType.Class.STATE)

ROOM_CREATE = EventType("m.room.create", EventType.Class.STATE)

ROOM_ENCRYPTED = EventType("m.room.encrypted", EventType.Class.MESSAGE)

ROOM_ENCRYPTION = EventType("m.room.encryption", EventType.Class.STATE)

ROOM_HISTORY_VISIBILITY = EventType("m.room.history_visibility", EventType.Class.STATE)

ROOM_JOIN_RULES = EventType("m.room.join_rules", EventType.Class.STATE)

ROOM_KEY = EventType("m.room_key", EventType.Class.TO_DEVICE)

ROOM_KEY_REQUEST = EventType("m.room_key_request", EventType.Class.TO_DEVICE)

ROOM_KEY_WITHHELD = EventType("m.room_key.withheld", EventType.Class.TO_DEVICE)

ROOM_MEMBER = EventType("m.room.member", EventType.Class.STATE)

ROOM_MESSAGE = EventType("m.room.message", EventType.Class.MESSAGE)

ROOM_NAME = EventType("m.room.name", EventType.Class.STATE)

ROOM_PINNED_EVENTS = EventType("m.room.pinned_events", EventType.Class.STATE)

ROOM_POWER_LEVELS = EventType("m.room.power_levels", EventType.Class.STATE)

ROOM_REDACTION = EventType("m.room.redaction", EventType.Class.MESSAGE)

ROOM_TOMBSTONE = EventType("m.room.tombstone", EventType.Class.STATE)

ROOM_TOPIC = EventType("m.room.topic", EventType.Class.STATE)

SPACE_CHILD = EventType("m.space.child", EventType.Class.STATE)

SPACE_PARENT = EventType("m.space.parent", EventType.Class.STATE)

STICKER = EventType("m.sticker", EventType.Class.MESSAGE)

TAG = EventType("m.tag", EventType.Class.ACCOUNT_DATA)

TO_DEVICE_ENCRYPTED = EventType("m.room.encrypted", EventType.Class.TO_DEVICE)

TYPING = EventType("m.typing", EventType.Class.EPHEMERAL)

by_event_type: Dict[str, mautrix.types.EventType] = {'__ALL__': EventType("__ALL__", EventType.Class.UNKNOWN), 'm.call.answer': EventType("m.call.answer", EventType.Class.MESSAGE), 'm.call.candidates': EventType("m.call.candidates", EventType.Class.MESSAGE), 'm.call.hangup': EventType("m.call.hangup", EventType.Class.MESSAGE), 'm.call.invite': EventType("m.call.invite", EventType.Class.MESSAGE), 'm.call.negotiate': EventType("m.call.negotiate", EventType.Class.MESSAGE), 'm.call.reject': EventType("m.call.reject", EventType.Class.MESSAGE), 'm.call.select_answer': EventType("m.call.select_answer", EventType.Class.MESSAGE), 'm.direct': EventType("m.direct", EventType.Class.ACCOUNT_DATA), 'm.forwarded_room_key': EventType("m.forwarded_room_key", EventType.Class.TO_DEVICE), 'm.ignored_user_list': EventType("m.ignored_user_list", EventType.Class.ACCOUNT_DATA), 'm.presence': EventType("m.presence", EventType.Class.EPHEMERAL), 'm.push_rules': EventType("m.push_rules", EventType.Class.ACCOUNT_DATA), 'm.reaction': EventType("m.reaction", EventType.Class.MESSAGE), 'm.receipt': EventType("m.receipt", EventType.Class.EPHEMERAL), 'm.room.aliases': EventType("m.room.aliases", EventType.Class.STATE), 'm.room.avatar': EventType("m.room.avatar", EventType.Class.STATE), 'm.room.canonical_alias': EventType("m.room.canonical_alias", EventType.Class.STATE), 'm.room.create': EventType("m.room.create", EventType.Class.STATE), 'm.room.encrypted': EventType("m.room.encrypted", EventType.Class.MESSAGE), 'm.room.encryption': EventType("m.room.encryption", EventType.Class.STATE), 'm.room.history_visibility': EventType("m.room.history_visibility", EventType.Class.STATE), 'm.room.join_rules': EventType("m.room.join_rules", EventType.Class.STATE), 'm.room.member': EventType("m.room.member", EventType.Class.STATE), 'm.room.message': EventType("m.room.message", EventType.Class.MESSAGE), 'm.room.name': EventType("m.room.name", EventType.Class.STATE), 'm.room.pinned_events': EventType("m.room.pinned_events", EventType.Class.STATE), 'm.room.power_levels': EventType("m.room.power_levels", EventType.Class.STATE), 'm.room.redaction': EventType("m.room.redaction", EventType.Class.MESSAGE), 'm.room.tombstone': EventType("m.room.tombstone", EventType.Class.STATE), 'm.room.topic': EventType("m.room.topic", EventType.Class.STATE), 'm.room_key': EventType("m.room_key", EventType.Class.TO_DEVICE), 'm.room_key.withheld': EventType("m.room_key.withheld", EventType.Class.TO_DEVICE), 'm.room_key_request': EventType("m.room_key_request", EventType.Class.TO_DEVICE), 'm.space.child': EventType("m.space.child", EventType.Class.STATE), 'm.space.parent': EventType("m.space.parent", EventType.Class.STATE), 'm.sticker': EventType("m.sticker", EventType.Class.MESSAGE), 'm.tag': EventType("m.tag", EventType.Class.ACCOUNT_DATA), 'm.typing': EventType("m.typing", EventType.Class.EPHEMERAL), 'org.matrix.room_key.withheld': EventType("org.matrix.room_key.withheld", EventType.Class.TO_DEVICE)}

classmethod deserialize(raw)

Convert the given data parsed from JSON into an object of this type.

Parameters: raw (mautrix.types.JSON) –
Return type: Any

classmethod find(t, t_class=None)

Parameters

t (str) –
t_class (Optional[mautrix.types.event.type.EventType.Class]) –

Return type

mautrix.types.EventType

property is_account_data: bool: Whether or not the event is an account data event.

property is_ephemeral: bool: Whether or not the event is ephemeral.

property is_message: bool: Whether or not the event is a message event.

property is_state: bool: Whether or not the event is a state event.

property is_to_device: bool: Whether or not the event is a to-device event.

json()

Serialize this object and dump the output as JSON.

Return type: str

classmethod parse_json(data)

Parse the given string as JSON and deserialize the result into this type.

Parameters: data (str) –
Return type: mautrix.types.EventType

serialize()

Convert this object into objects directly serializable with json.

Return type: mautrix.types.JSON

with_class(t_class)

Parameters: t_class (mautrix.types.event.type.EventType.Class) –
Return type: mautrix.types.EventType

class mautrix.types.GenericEvent

An event class that contains all possible top-level event keys and uses generic Obj’s for object keys (content and unsigned)

content: mautrix.types.Obj

type: mautrix.types.EventType

room_id: Optional[mautrix.types.RoomID]

event_id: Optional[mautrix.types.EventID]

sender: Optional[mautrix.types.UserID]

timestamp: Optional[int]

state_key: Optional[str]

unsigned: mautrix.types.Obj

redacts: Optional[mautrix.types.EventID]

class mautrix.types.BaseRoomEvent

Base room event class. Room events must have a room ID, event ID, sender and timestamp in addition to the content and type in the base event.

room_id: mautrix.types.RoomID

event_id: mautrix.types.EventID

sender: mautrix.types.UserID

timestamp: int

class mautrix.types.BaseEvent

Base event class. The only things an event must have are content and event type.

content: mautrix.types.Obj

type: mautrix.types.EventType

class mautrix.types.BaseUnsigned

Base unsigned information.

age: int

class mautrix.types.RedactionEvent

A m.room.redaction event

property unsigned: mautrix.types.BaseUnsigned

content: mautrix.types.RedactionEventContent

redacts: mautrix.types.EventID

class mautrix.types.RedactionEventContent

The content of an m.room.redaction event

reason: str

class mautrix.types.ReactionEventContent

The content of an m.reaction event

property relates_to: mautrix.types.RelatesTo

class mautrix.types.ReactionEvent

A m.reaction event

property unsigned: mautrix.types.BaseUnsigned

content: mautrix.types.ReactionEventContent

class mautrix.types.MessageEvent

An m.room.message event

static deserialize_content(data)

Parameters: data (mautrix.types.JSON) –
Return type: Union[mautrix.types.TextMessageEventContent, mautrix.types.MediaMessageEventContent, mautrix.types.LocationMessageEventContent, mautrix.types.Obj]

make_reply_fallback_html(displayname=None)

Generate the HTML fallback for messages replying to this event.

Parameters: displayname (Optional[str]) –
Return type: str

make_reply_fallback_text(displayname=None)

Generate the plaintext fallback for messages replying to this event.

Parameters: displayname (Optional[str]) –
Return type: str

content: Union[mautrix.types.TextMessageEventContent, mautrix.types.MediaMessageEventContent, mautrix.types.LocationMessageEventContent, mautrix.types.Obj]

unsigned: Optional[mautrix.types.MessageUnsigned]

class mautrix.types.MessageUnsigned

Unsigned information sent with message events.

transaction_id: str

class mautrix.types.MediaMessageEventContent

The content of a media message event (m.image, m.audio, m.video, m.file)

static deserialize_info(data)

Parameters: data (mautrix.types.JSON) –
Return type: Union[mautrix.types.ImageInfo, mautrix.types.VideoInfo, mautrix.types.AudioInfo, mautrix.types.FileInfo, mautrix.types.Obj]

url: Optional[mautrix.types.ContentURI]

info: Optional[Union[mautrix.types.ImageInfo, mautrix.types.VideoInfo, mautrix.types.AudioInfo, mautrix.types.FileInfo, mautrix.types.Obj]]

file: Optional[mautrix.types.EncryptedFile]

class mautrix.types.LocationMessageEventContent

geo_uri: str

info: mautrix.types.LocationInfo

class mautrix.types.LocationInfo

Information about a location message.

thumbnail_url: Optional[mautrix.types.ContentURI]

thumbnail_info: Optional[mautrix.types.ThumbnailInfo]

thumbnail_file: Optional[mautrix.types.EncryptedFile]

class mautrix.types.RelationType

ANNOTATION: mautrix.types.RelationType = <RelationType.ANNOTATION: 'm.annotation'>

REFERENCE: mautrix.types.RelationType = <RelationType.REFERENCE: 'm.reference'>

REPLACE: mautrix.types.RelationType = <RelationType.REPLACE: 'm.replace'>

REPLY: mautrix.types.RelationType = <RelationType.REPLY: 'net.maunium.reply'>

class mautrix.types.MessageType

A message type.

property is_media: bool

property is_text: bool

TEXT: mautrix.types.MessageType = <MessageType.TEXT: 'm.text'>

EMOTE: mautrix.types.MessageType = <MessageType.EMOTE: 'm.emote'>

NOTICE: mautrix.types.MessageType = <MessageType.NOTICE: 'm.notice'>

IMAGE: mautrix.types.MessageType = <MessageType.IMAGE: 'm.image'>

STICKER: mautrix.types.MessageType = <MessageType.STICKER: 'm.sticker'>

VIDEO: mautrix.types.MessageType = <MessageType.VIDEO: 'm.video'>

AUDIO: mautrix.types.MessageType = <MessageType.AUDIO: 'm.audio'>

FILE: mautrix.types.MessageType = <MessageType.FILE: 'm.file'>

LOCATION: mautrix.types.MessageType = <MessageType.LOCATION: 'm.location'>

class mautrix.types.Format

A message format. Currently only org.matrix.custom.html is available. This will probably be deprecated when extensible events are implemented.

HTML: mautrix.types.Format = <Format.HTML: 'org.matrix.custom.html'>

class mautrix.types.FileInfo

Information about a document message.

thumbnail_info: Optional[mautrix.types.ThumbnailInfo]

thumbnail_file: Optional[mautrix.types.EncryptedFile]

thumbnail_url: Optional[mautrix.types.ContentURI]

class mautrix.types.AudioInfo

Information about an audio message.

duration: int

class mautrix.types.VideoInfo

Information about a video message.

duration: int

orientation: int

class mautrix.types.ImageInfo

Information about an image message.

height: int

width: int

orientation: int

class mautrix.types.ThumbnailInfo

Information about the thumbnail for a document, video, image or location.

height: int

width: int

orientation: int

class mautrix.types.TextMessageEventContent

The content of a text message event (m.text, m.notice, m.emote)

formatted(format)

Parameters: format (mautrix.types.Format) –
Return type: Optional[str]

set_reply(reply_to, *, displayname=None)

Parameters

reply_to (Union[mautrix.types.MessageEvent, mautrix.types.EventID]) –
displayname (Optional[str]) –

Return type

None

trim_reply_fallback()

Return type: None

format: mautrix.types.Format

formatted_body: str

class mautrix.types.BaseMessageEventContent

Base event content for all m.room.message-type events.

msgtype: mautrix.types.MessageType

body: str

external_url: str

class mautrix.types.RelatesTo

Message relations. Used for reactions, edits and replies.

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: Optional[mautrix.types.RelatesTo]

serialize()

Convert this object into objects directly serializable with json.

Return type: mautrix.types.JSON

rel_type: mautrix.types.RelationType

event_id: Optional[mautrix.types.EventID]

key: Optional[str]

class mautrix.types.BaseFileInfo

mimetype: str

size: int

class mautrix.types.EncryptedFile

key: mautrix.types.JSONWebKey

iv: str

hashes: Dict[str, str]

url: Optional[mautrix.types.ContentURI]

version: str

class mautrix.types.JSONWebKey

key: str

algorithm: str

extractable: bool

key_type: str

key_ops: List[str]

class mautrix.types.PowerLevelStateEventContent

The content of a power level event.

ensure_event_level(event_type, level)

Parameters

event_type (mautrix.types.EventType) –
level (int) –

Return type

bool

ensure_user_level(user_id, level)

Parameters

user_id (mautrix.types.UserID) –
level (int) –

Return type

bool

get_event_level(event_type)

Parameters: event_type (mautrix.types.EventType) –
Return type: int

get_user_level(user_id)

Parameters: user_id (mautrix.types.UserID) –
Return type: int

set_event_level(event_type, level)

Parameters

event_type (mautrix.types.EventType) –
level (int) –

Return type

None

set_user_level(user_id, level)

Parameters

user_id (mautrix.types.UserID) –
level (int) –

Return type

None

users: Dict[mautrix.types.UserID, int]

users_default: int

events: Dict[mautrix.types.EventType, int]

events_default: int

state_default: int

invite: int

kick: int

ban: int

redact: int

class mautrix.types.Membership

A room membership state.

JOIN = 'join'

LEAVE = 'leave'

INVITE = 'invite'

BAN = 'ban'

KNOCK = 'knock'

class mautrix.types.MemberStateEventContent

The content of a membership event.

membership: mautrix.types.Membership

avatar_url: mautrix.types.ContentURI

displayname: str

is_direct: bool

reason: str

third_party_invite: mautrix.types.JSON

class mautrix.types.StateEvent

A room state event.

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: mautrix.types.StateEvent

static deserialize_content(data)

Parameters: data (mautrix.types.JSON) –
Return type: Union[mautrix.types.PowerLevelStateEventContent, mautrix.types.MemberStateEventContent, mautrix.types.AliasesStateEventContent, mautrix.types.CanonicalAliasStateEventContent, mautrix.types.RoomNameStateEventContent, mautrix.types.RoomAvatarStateEventContent, mautrix.types.RoomTopicStateEventContent, mautrix.types.RoomPinnedEventsStateEventContent, mautrix.types.RoomTombstoneStateEventContent, mautrix.types.RoomEncryptionStateEventContent, mautrix.types.event.state.RoomCreateStateEventContent, mautrix.types.event.state.SpaceChildStateEventContent, mautrix.types.event.state.SpaceParentStateEventContent, mautrix.types.Obj]

property prev_content: Union[mautrix.types.PowerLevelStateEventContent, mautrix.types.MemberStateEventContent, mautrix.types.AliasesStateEventContent, mautrix.types.CanonicalAliasStateEventContent, mautrix.types.RoomNameStateEventContent, mautrix.types.RoomAvatarStateEventContent, mautrix.types.RoomTopicStateEventContent, mautrix.types.RoomPinnedEventsStateEventContent, mautrix.types.RoomTombstoneStateEventContent, mautrix.types.RoomEncryptionStateEventContent, mautrix.types.event.state.RoomCreateStateEventContent, mautrix.types.event.state.SpaceChildStateEventContent, mautrix.types.event.state.SpaceParentStateEventContent, mautrix.types.Obj]

state_key: str

content: Union[mautrix.types.PowerLevelStateEventContent, mautrix.types.MemberStateEventContent, mautrix.types.AliasesStateEventContent, mautrix.types.CanonicalAliasStateEventContent, mautrix.types.RoomNameStateEventContent, mautrix.types.RoomAvatarStateEventContent, mautrix.types.RoomTopicStateEventContent, mautrix.types.RoomPinnedEventsStateEventContent, mautrix.types.RoomTombstoneStateEventContent, mautrix.types.RoomEncryptionStateEventContent, mautrix.types.event.state.RoomCreateStateEventContent, mautrix.types.event.state.SpaceChildStateEventContent, mautrix.types.event.state.SpaceParentStateEventContent, mautrix.types.Obj]

unsigned: Optional[mautrix.types.StateUnsigned]

class mautrix.types.AliasesStateEventContent

aliases: List[mautrix.types.RoomAlias]

class mautrix.types.CanonicalAliasStateEventContent

canonical_alias: mautrix.types.RoomAlias

alt_aliases: List[mautrix.types.RoomAlias]

class mautrix.types.StrippedStateEvent

Stripped state events included with some invite events.

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: mautrix.types.StrippedStateEvent

property prev_content: Union[mautrix.types.PowerLevelStateEventContent, mautrix.types.MemberStateEventContent, mautrix.types.AliasesStateEventContent, mautrix.types.CanonicalAliasStateEventContent, mautrix.types.RoomNameStateEventContent, mautrix.types.RoomAvatarStateEventContent, mautrix.types.RoomTopicStateEventContent, mautrix.types.RoomPinnedEventsStateEventContent, mautrix.types.RoomTombstoneStateEventContent, mautrix.types.RoomEncryptionStateEventContent, mautrix.types.event.state.RoomCreateStateEventContent, mautrix.types.event.state.SpaceChildStateEventContent, mautrix.types.event.state.SpaceParentStateEventContent, mautrix.types.Obj]

content: Union[mautrix.types.PowerLevelStateEventContent, mautrix.types.MemberStateEventContent, mautrix.types.AliasesStateEventContent, mautrix.types.CanonicalAliasStateEventContent, mautrix.types.RoomNameStateEventContent, mautrix.types.RoomAvatarStateEventContent, mautrix.types.RoomTopicStateEventContent, mautrix.types.RoomPinnedEventsStateEventContent, mautrix.types.RoomTombstoneStateEventContent, mautrix.types.RoomEncryptionStateEventContent, mautrix.types.event.state.RoomCreateStateEventContent, mautrix.types.event.state.SpaceChildStateEventContent, mautrix.types.event.state.SpaceParentStateEventContent, mautrix.types.Obj]

room_id: mautrix.types.RoomID

sender: mautrix.types.UserID

type: mautrix.types.EventType

state_key: str

unsigned: Optional[mautrix.types.event.state.StrippedStateUnsigned]

class mautrix.types.RoomNameStateEventContent

name: str

class mautrix.types.RoomTopicStateEventContent

topic: str

class mautrix.types.RoomPinnedEventsStateEventContent

pinned: List[mautrix.types.EventID]

class mautrix.types.StateUnsigned

invite_room_state: Optional[List[mautrix.types.StrippedStateEvent]]

class mautrix.types.RoomAvatarStateEventContent

url: Optional[mautrix.types.ContentURI]

class mautrix.types.RoomTombstoneStateEventContent

body: str

replacement_room: mautrix.types.RoomID

class mautrix.types.RoomEncryptionStateEventContent

algorithm: mautrix.types.EncryptionAlgorithm

rotation_period_ms: int

rotation_period_msgs: int

class mautrix.types.AccountDataEvent

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: mautrix.types.AccountDataEvent

static deserialize_content(data)

Parameters: data (mautrix.types.JSON) –
Return type: Union[mautrix.types.RoomTagAccountDataEventContent, Dict[mautrix.types.UserID, List[mautrix.types.RoomID]], mautrix.types.Obj]

content: Union[mautrix.types.RoomTagAccountDataEventContent, Dict[mautrix.types.UserID, List[mautrix.types.RoomID]], mautrix.types.Obj]

class mautrix.types.RoomTagInfo

order: Union[int, float, str]

class mautrix.types.RoomTagAccountDataEventContent

tags: Dict[str, mautrix.types.RoomTagInfo]

class mautrix.types.TypingEventContent

user_ids: List[mautrix.types.UserID]

class mautrix.types.TypingEvent

room_id: mautrix.types.RoomID

content: mautrix.types.TypingEventContent

class mautrix.types.PresenceEvent

sender: mautrix.types.UserID

content: mautrix.types.PresenceEventContent

class mautrix.types.PresenceState

An enumeration.

ONLINE = 'online'

OFFLINE = 'offline'

UNAVAILABLE = 'unavailable'

class mautrix.types.PresenceEventContent

presence: mautrix.types.PresenceState

last_active_ago: int

status_msg: str

currently_active: bool

class mautrix.types.SingleReceiptEventContent

ts: int

class mautrix.types.ReceiptEvent

room_id: mautrix.types.RoomID

content: Dict[mautrix.types.EventID, Dict[mautrix.types.ReceiptType, Dict[mautrix.types.UserID, mautrix.types.SingleReceiptEventContent]]]

class mautrix.types.ReceiptType

An enumeration.

READ = 'm.read'

class mautrix.types.EncryptedEvent

A m.room.encrypted event

property unsigned: mautrix.types.BaseUnsigned

content: mautrix.types.EncryptedEventContent

class mautrix.types.EncryptionAlgorithm

OLM_V1: mautrix.types.EncryptionAlgorithm = <EncryptionAlgorithm.OLM_V1: 'm.olm.v1.curve25519-aes-sha2'>

MEGOLM_V1: mautrix.types.EncryptionAlgorithm = <EncryptionAlgorithm.MEGOLM_V1: 'm.megolm.v1.aes-sha2'>

class mautrix.types.EncryptedOlmEventContent

ciphertext: Dict[str, mautrix.types.OlmCiphertext]

sender_key: mautrix.types.IdentityKey

algorithm: mautrix.types.EncryptionAlgorithm

class mautrix.types.EncryptedMegolmEventContent

The content of an m.room.encrypted event

property relates_to: mautrix.types.RelatesTo

ciphertext: str

sender_key: mautrix.types.IdentityKey

device_id: mautrix.types.DeviceID

session_id: mautrix.types.SessionID

algorithm: mautrix.types.EncryptionAlgorithm

class mautrix.types.EncryptionKeyAlgorithm

CURVE25519: mautrix.types.EncryptionKeyAlgorithm = <EncryptionKeyAlgorithm.CURVE25519: 'curve25519'>

ED25519: mautrix.types.EncryptionKeyAlgorithm = <EncryptionKeyAlgorithm.ED25519: 'ed25519'>

SIGNED_CURVE25519: mautrix.types.EncryptionKeyAlgorithm = <EncryptionKeyAlgorithm.SIGNED_CURVE25519: 'signed_curve25519'>

class mautrix.types.OlmMsgType

An enumeration.

PREKEY = 0

MESSAGE = 1

__new__(value)

class mautrix.types.OlmCiphertext

body: str

type: mautrix.types.OlmMsgType

class mautrix.types.ToDeviceEvent

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: mautrix.types.ToDeviceEvent

static deserialize_content(data)

Parameters: data (mautrix.types.JSON) –
Return type: Union[mautrix.types.Obj, mautrix.types.EncryptedOlmEventContent, mautrix.types.RoomKeyWithheldEventContent, mautrix.types.RoomKeyEventContent, mautrix.types.RoomKeyRequestEventContent, mautrix.types.ForwardedRoomKeyEventContent]

sender: mautrix.types.UserID

content: Union[mautrix.types.Obj, mautrix.types.EncryptedOlmEventContent, mautrix.types.RoomKeyWithheldEventContent, mautrix.types.RoomKeyEventContent, mautrix.types.RoomKeyRequestEventContent, mautrix.types.ForwardedRoomKeyEventContent]

class mautrix.types.RoomKeyWithheldCode

BLACKLISTED: mautrix.types.RoomKeyWithheldCode = <RoomKeyWithheldCode.BLACKLISTED: 'm.blacklisted'>

UNVERIFIED: mautrix.types.RoomKeyWithheldCode = <RoomKeyWithheldCode.UNVERIFIED: 'm.unverified'>

UNAUTHORIZED: mautrix.types.RoomKeyWithheldCode = <RoomKeyWithheldCode.UNAUTHORIZED: 'm.unauthorized'>

UNAVAILABLE: mautrix.types.RoomKeyWithheldCode = <RoomKeyWithheldCode.UNAVAILABLE: 'm.unavailable'>

NO_OLM_SESSION: mautrix.types.RoomKeyWithheldCode = <RoomKeyWithheldCode.NO_OLM_SESSION: 'm.no_olm'>

class mautrix.types.RoomKeyWithheldEventContent

algorithm: mautrix.types.EncryptionAlgorithm

sender_key: mautrix.types.IdentityKey

code: mautrix.types.RoomKeyWithheldCode

reason: Optional[str]

room_id: Optional[mautrix.types.RoomID]

session_id: Optional[mautrix.types.SessionID]

class mautrix.types.RoomKeyEventContent

algorithm: mautrix.types.EncryptionAlgorithm

room_id: mautrix.types.RoomID

session_id: mautrix.types.SessionID

session_key: str

class mautrix.types.KeyRequestAction

REQUEST: mautrix.types.KeyRequestAction = <KeyRequestAction.REQUEST: 'request'>

CANCEL: mautrix.types.KeyRequestAction = <KeyRequestAction.CANCEL: 'request_cancellation'>

class mautrix.types.RequestedKeyInfo

algorithm: mautrix.types.EncryptionAlgorithm

room_id: mautrix.types.RoomID

sender_key: mautrix.types.IdentityKey

session_id: mautrix.types.SessionID

class mautrix.types.RoomKeyRequestEventContent

action: mautrix.types.KeyRequestAction

requesting_device_id: mautrix.types.DeviceID

request_id: str

body: Optional[mautrix.types.RequestedKeyInfo]

class mautrix.types.ForwardedRoomKeyEventContent

sender_key: mautrix.types.IdentityKey

signing_key: mautrix.types.SigningKey

forwarding_key_chain: List[str]

class mautrix.types.CallData

sdp: str

type: mautrix.types.CallDataType

class mautrix.types.CallHangupReason

value: Any

class mautrix.types.CallDataType

value: Any

class mautrix.types.CallCandidate

candidate: str

sdp_m_line_index: int

sdp_mid: str

class mautrix.types.CallInviteEventContent

call_id: str

lifetime: int

version: int

offer: mautrix.types.CallData

party_id: Optional[str]

invitee: Optional[mautrix.types.UserID]

class mautrix.types.CallCandidatesEventContent

call_id: str

version: int

candidates: List[mautrix.types.CallCandidate]

party_id: Optional[str]

class mautrix.types.CallSelectAnswerEventContent

call_id: str

version: int

party_id: str

selected_party_id: str

class mautrix.types.CallAnswerEventContent

call_id: str

version: int

answer: mautrix.types.CallData

party_id: Optional[str]

class mautrix.types.CallHangupEventContent

call_id: str

version: int

reason: mautrix.types.CallHangupReason

party_id: Optional[str]

class mautrix.types.CallNegotiateEventContent

call_id: str

version: int

lifetime: int

party_id: str

description: mautrix.types.CallData

class mautrix.types.CallEvent

classmethod deserialize(data, event_type=None)

Convert the given data parsed from JSON into an object of this type.

Parameters

data (mautrix.types.JSON) –
event_type (Optional[mautrix.types.EventType]) –

Return type

mautrix.types.CallEvent

content: mautrix.types.event.voip.T

class mautrix.types.CallRejectEventContent

call_id: str

version: int

party_id: str

class mautrix.types.RoomCreatePreset

Room creation preset, as specified in the createRoom endpoint

PRIVATE = 'private_chat'

TRUSTED_PRIVATE = 'trusted_private_chat'

PUBLIC = 'public_chat'

class mautrix.types.RoomDirectoryVisibility

Room directory visibility, as specified in the createRoom endpoint

PRIVATE = 'private'

PUBLIC = 'public'

class mautrix.types.PaginationDirection

Pagination direction, as specified in the pagination section.

FORWARD = 'f'

BACKWARD = 'b'

class mautrix.types.RoomAliasInfo

Room alias query result, as specified in the alias resolve endpoint

room_id: mautrix.types.RoomID

servers: List[str]

class mautrix.types.RoomDirectoryResponse

chunk: List[mautrix.types.misc.PublicRoomInfo]

next_batch: mautrix.types.DirectoryPaginationToken

prev_batch: mautrix.types.DirectoryPaginationToken

total_room_count_estimate: int

class mautrix.types.PaginatedMessages

PaginatedMessages(start, end, events)

static __new__(_cls, start, end, events)

Create new instance of PaginatedMessages(start, end, events)

Parameters

start (mautrix.types.SyncToken) –
end (mautrix.types.SyncToken) –
events (List[mautrix.types.Event]) –

end: mautrix.types.SyncToken: Alias for field number 1

events: List[mautrix.types.Event]: Alias for field number 2

start: mautrix.types.SyncToken: Alias for field number 0

class mautrix.types.DeviceLists

changed: List[mautrix.types.UserID]

left: List[mautrix.types.UserID]

class mautrix.types.DeviceOTKCount

curve25519: int

signed_curve25519: int

class mautrix.types.VersionsResponse

versions: List[str]

unstable_features: Dict[str, bool]

class mautrix.types.User

user_id: mautrix.types.UserID

avatar_url: mautrix.types.ContentURI

displayname: str

class mautrix.types.Member

membership: mautrix.types.Membership

avatar_url: mautrix.types.ContentURI

displayname: str

class mautrix.types.UserSearchResults

UserSearchResults(results, limit)

static __new__(_cls, results, limit)

Create new instance of UserSearchResults(results, limit)

Parameters

results (List[mautrix.types.User]) –
limit (int) –

limit: int: Alias for field number 1

results: List[mautrix.types.User]: Alias for field number 0

class mautrix.types.LoginType

A login type, as specified in the POST /login endpoint

PASSWORD: mautrix.types.LoginType = <LoginType.PASSWORD: 'm.login.password'>

TOKEN: mautrix.types.LoginType = <LoginType.TOKEN: 'm.login.token'>

SSO: mautrix.types.LoginType = <LoginType.SSO: 'm.login.sso'>

APPSERVICE: mautrix.types.LoginType = <LoginType.APPSERVICE: 'm.login.application_service'>

UNSTABLE_JWT: mautrix.types.LoginType = <LoginType.UNSTABLE_JWT: 'org.matrix.login.jwt'>

UNSTABLE_APPSERVICE: mautrix.types.LoginType = <LoginType.UNSTABLE_APPSERVICE: 'uk.half-shot.msc2778.login.application_service'>

class mautrix.types.UserIdentifierType

A user identifier type, as specified in the Identifier types section of the login spec.

MATRIX_USER: mautrix.types.UserIdentifierType = <UserIdentifierType.MATRIX_USER: 'm.id.user'>

THIRD_PARTY: mautrix.types.UserIdentifierType = <UserIdentifierType.THIRD_PARTY: 'm.id.thirdparty'>

PHONE: mautrix.types.UserIdentifierType = <UserIdentifierType.PHONE: 'm.id.phone'>

class mautrix.types.MatrixUserIdentifier

A client can identify a user using their Matrix ID. This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.

user: str

type: mautrix.types.UserIdentifierType

class mautrix.types.ThirdPartyIdentifier

A client can identify a user using a 3PID associated with the user’s account on the homeserver, where the 3PID was previously associated using the /account/3pid API. See the 3PID Types Appendix for a list of Third-party ID media.

medium: str

address: str

type: mautrix.types.UserIdentifierType

class mautrix.types.PhoneIdentifier

A client can identify a user using a phone number associated with the user’s account, where the phone number was previously associated using the /account/3pid API. The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it. If the client wishes to canonicalise the phone number, then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.

country: str

phone: str

type: mautrix.types.UserIdentifierType

class mautrix.types.LoginResponse

The response for a login request, as specified in the POST /login endpoint

user_id: mautrix.types.UserID

device_id: mautrix.types.DeviceID

access_token: str

well_known: mautrix.types.DiscoveryInformation

class mautrix.types.DiscoveryInformation

homeserver: Optional[mautrix.types.DiscoveryServer]

identity_server: Optional[mautrix.types.DiscoveryServer]

integrations: Optional[mautrix.types.DiscoveryServer]

class mautrix.types.DiscoveryServer

base_url: Optional[str]

class mautrix.types.DiscoveryIntegrations

managers: List[mautrix.types.DiscoveryIntegrationServer]

class mautrix.types.DiscoveryIntegrationServer

ui_url: Optional[str]

api_url: Optional[str]

class mautrix.types.LoginFlow

A login flow, as specified in the GET /login endpoint

type: mautrix.types.LoginType

class mautrix.types.LoginFlowList

get_first_of_type(*types)

Parameters: types (mautrix.types.LoginType) –
Return type: Optional[mautrix.types.LoginFlow]

supports_type(*types)

Parameters: types (mautrix.types.LoginType) –
Return type: bool

flows: List[mautrix.types.LoginFlow]

class mautrix.types.WhoamiResponse

The response for a whoami request, as specified in the GET /account/whoami endpoint

user_id: mautrix.types.UserID

device_id: Optional[mautrix.types.DeviceID]

class mautrix.types.UnsignedDeviceInfo

device_display_name: Optional[str]

class mautrix.types.DeviceKeys

property curve25519: mautrix.types.IdentityKey

property ed25519: mautrix.types.SigningKey

user_id: mautrix.types.UserID

device_id: mautrix.types.DeviceID

algorithms: List[mautrix.types.EncryptionAlgorithm]

keys: Dict[str, str]

signatures: Dict[mautrix.types.UserID, Dict[str, str]]

unsigned: mautrix.types.UnsignedDeviceInfo

class mautrix.types.ClaimKeysResponse

failures: Dict[str, Any]

one_time_keys: Dict[mautrix.types.UserID, Dict[mautrix.types.DeviceID, Dict[str, Any]]]

class mautrix.types.QueryKeysResponse

failures: Dict[str, Any]

device_keys: Dict[mautrix.types.UserID, Dict[mautrix.types.DeviceID, mautrix.types.DeviceKeys]]

class mautrix.types.MediaRepoConfig

Matrix media repo config. See GET /_matrix/media/r0/config.

upload_size: int

class mautrix.types.MXOpenGraph

Matrix URL preview response. See GET /_matrix/media/r0/preview_url.

title: str

description: str

image: mautrix.types.OpenGraphImage

video: mautrix.types.OpenGraphVideo

audio: mautrix.types.OpenGraphAudio

class mautrix.types.OpenGraphVideo

url: mautrix.types.ContentURI

mimetype: str

height: int

width: int

size: int

class mautrix.types.OpenGraphImage

url: mautrix.types.ContentURI

mimetype: str

height: int

width: int

size: int

class mautrix.types.OpenGraphAudio

url: mautrix.types.ContentURI

mimetype: str

class mautrix.types.Obj

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (Dict[str, mautrix.types.JSON]) –
Return type: mautrix.types.Obj

get(key, default=None)

popitem()

serialize()

Convert this object into objects directly serializable with json.

Return type: Dict[str, mautrix.types.JSON]

class mautrix.types.Lst

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (List[mautrix.types.JSON]) –
Return type: mautrix.types.Lst

serialize()

Convert this object into objects directly serializable with json.

Return type: List[mautrix.types.JSON]

exception mautrix.types.SerializerError: SerializerErrors are raised if something goes wrong during serialization or deserialization.

class mautrix.types.Serializable

Serializable is the base class for types with custom JSON serializers.

classmethod deserialize(raw)

Convert the given data parsed from JSON into an object of this type.

Parameters: raw (mautrix.types.JSON) –
Return type: mautrix.types.util.serializable.SerializableSubtype

json()

Serialize this object and dump the output as JSON.

Return type: str

classmethod parse_json(data)

Parse the given string as JSON and deserialize the result into this type.

Parameters: data (str) –
Return type: mautrix.types.util.serializable.SerializableSubtype

serialize()

Convert this object into objects directly serializable with json.

Return type: mautrix.types.JSON

class mautrix.types.SerializableEnum

A simple Serializable implementation for Enums.

Examples

>>> class MyEnum(SerializableEnum):
...     FOO = "foo value"
...     BAR = "hmm"
>>> MyEnum.FOO.serialize()
"foo value"
>>> MyEnum.BAR.json()
'"hmm"'

__init__(_)

A fake __init__ to stop the type checker from complaining. Enum’s __new__ overrides this.

Return type: None

__new__(value)

class mautrix.types.SerializableAttrs

An abstract Serializable that assumes the subclass is an attrs dataclass.

Examples

>>> from attr import dataclass
>>> from mautrix.types import SerializableAttrs
>>> @dataclass
... class Foo(SerializableAttrs):
...     index: int
...     field: Optional[str] = None

classmethod deserialize(data)

Convert the given data parsed from JSON into an object of this type.

Parameters: data (mautrix.types.JSON) –
Return type: mautrix.types.util.serializable.SerializableSubtype

get(item, default=None)

serialize()

Convert this object into objects directly serializable with json.

Return type: mautrix.types.JSON

unrecognized_: Dict[str, mautrix.types.JSON]

mautrix.types.field(default=NOTHING, factory=None, json=None, flatten=False, hidden=False, ignore_errors=False, omit_empty=True, omit_default=False, metadata=None, **kwargs)

A wrapper around attr.ib() to conveniently add SerializableAttrs metadata fields.

Parameters

default (Any) – Same as attr.ib, the default value for the field.
factory (Optional[Callable[[], Any]]) – Same as attr.ib, a factory function that creates the default value.
json (Optional[str]) – The JSON key used for de/serializing the object.
flatten (bool) – Set to flatten subfields inside this field to be a part of the parent object in serialized objects. When deserializing, the input data will be deserialized into both the parent and child fields, so the classes should ignore unknown keys.
hidden (bool) – Set to always omit the key from serialized objects.
ignore_errors (bool) – Set to ignore type errors while deserializing.
omit_empty (bool) – Set to omit the key from serialized objects if the value is None.
omit_default (bool) – Set to omit the key from serialized objects if the value is equal to the default.
metadata (Optional[Dict[str, Any]]) – Additional metadata for attr.ib.
**kwargs – Additional keyword arguments for attr.ib.

Returns

The decorator function returned by attr.ib.

Examples

>>> from attr import dataclass
>>> from mautrix.types import SerializableAttrs, field
>>> @dataclass
... class SomeData(SerializableAttrs):
...     my_field: str = field(json="com.example.namespaced_field", default="hi")
...
>>> SomeData().serialize()
{'com.example.namespaced_field': 'hi'}
>>> SomeData.deserialize({"com.example.namespaced_field": "hmm"})
SomeData(my_field='hmm')

mautrix.types.serializer(elem_type)

Define a custom serialization function for the given type.

Parameters: elem_type (Type[mautrix.types.util.serializable_attrs.T]) – The type to define the serializer for.
Returns: Decorator for the function. The decorator will simply add the function to a map of deserializers and return the function.
Return type: Callable[[mautrix.types.util.serializable_attrs.Serializer], mautrix.types.util.serializable_attrs.Serializer]

Examples

>>> from datetime import datetime
>>> from mautrix.types import serializer, JSON
>>> @serializer(datetime)
... def serialize_datetime(dt: datetime) -> JSON:
...     return dt.timestamp()

mautrix.types.deserializer(elem_type)

Define a custom deserialization function for a given type hint.

Parameters: elem_type (Type[mautrix.types.util.serializable_attrs.T]) – The type hint to define the deserializer for.
Returns: Decorator for the function. The decorator will simply add the function to a map of deserializers and return the function.
Return type: Callable[[mautrix.types.util.serializable_attrs.Deserializer], mautrix.types.util.serializable_attrs.Deserializer]

Examples

>>> from datetime import datetime
>>> from mautrix.types import deserializer, JSON
>>> @deserializer(datetime)
... def deserialize_datetime(data: JSON) -> datetime:
...     return datetime.fromtimestamp(data)