matrix package

Submodules

matrix.API module

matrix.classes module

class matrix.classes.Authentication(access_token, home_server, user_id, device_id)

Bases: object

Class to keep authentication data.

access_token

device_id

home_server

user_id

class matrix.classes.Device_Keys(algorithms, device_id, keys, user_id, unsigned, signatures)

Bases: object

Class to keep device keys data.

algorithms

device_id

keys

signatures

unsigned

user_id

class matrix.classes.Device_Keys_Response(device_keys, failures, master_keys, self_signing_keys, user_signing_keys)

Bases: object

Class to keep device keys response data.

device_keys

failures

master_keys

self_signing_keys

user_signing_keys

class matrix.classes.Event(event_id=None, type=None, content=None, timestamp=None, sender=None, parsed_message=None, state_key=None)

Bases: object

Class to keep event data.

content = None

event_id = None

parsed_message = None

sender = None

state_key = None

timestamp = None

type = None

class matrix.classes.Invite(invite_state, room_id, invitee)

Bases: object

Class to keep invite data

invite_state

invitee

room_id

class matrix.classes.Invite_State(events)

Bases: object

Class to keep invite state data.

events

class matrix.classes.Message(type, body, format=None, formatted_body=None)

Bases: object

Class to keep message data.

body

format = None

formatted_body = None

type

class matrix.classes.Room(timeline, state, account_data, unread_notifications, summary, unread_count, id, encrypted)

Bases: object

Class to keep room data.

account_data

encrypted

id

state

summary

timeline

unread_count

unread_notifications

class matrix.classes.Room_Preset

Bases: object

Class to keep room preset data.

private_chat = 'private_chat'

public_chat = 'public_chat'

trusted_private_chat = 'trusted_private_chat'

class matrix.classes.State(next_batch=None, account_data=None, joined_rooms=None, invited_rooms=None)

Bases: object

Class to keep state data.

account_data = None

invited_rooms = None

joined_rooms = None

next_batch = None

class matrix.classes.Timeline(events, prev_batch, limited)

Bases: object

Class to keep timeline data.

events

limited

prev_batch

class matrix.classes.Unread_Notification(notification_count, highlight_count)

Bases: object

Class to keep unread notification data.

highlight_count

notification_count

class matrix.classes.User(user_id, device_id=None, is_guest=None, displayname=None, avatar_url=None)

Bases: object

Class to keep user data.

avatar_url = None

device_id = None

displayname = None

is_guest = None

user_id

matrix.client module

matrix.constants module

matrix.discord_like_classes module

matrix.e2ee module

matrix.exceptions module

matrix.parsers module

matrix.parsers.check_if_encrypted(room)

Check if room is encrypted.

matrix.parsers.get_invitee_from_events(events)

Get invitee from events.

matrix.parsers.parse_account_data(data)

Parse account data.

matrix.parsers.parse_device_key(data)

Parse device key data.

matrix.parsers.parse_device_keys_response(data)

Parse device keys data.

matrix.parsers.parse_event(event)

Parse event data.

matrix.parsers.parse_invite(invite, room_id)

Parse invite data.

matrix.parsers.parse_message(message)

Parse message data.

matrix.parsers.parse_notification(notification)

Parse unread notification data.

matrix.parsers.parse_room(room, room_id)

Parse room data.

matrix.parsers.parse_room_events(events)

Parse room events data.

matrix.parsers.parse_state(state)

Parse state data.

matrix.utils module

Module contents