Source code for nio.events.account_data

# -*- coding: utf-8 -*-

# Copyright © 2018-2019 Damir Jelić <poljar@termina.org.uk>
#
# Permission to use, copy, modify, and/or distribute this software for
# any purpose with or without fee is hereby granted, provided that the
# above copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
# SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
# RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
# CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

"""nio Account data events.

Clients can store custom config data for their account on their homeserver.

This account data will be synced between different devices and can persist
across installations on a particular device.

"""

from __future__ import unicode_literals

from typing import Any, Dict, Optional

from dataclasses import dataclass, field

from ..schemas import Schemas
from .misc import verify


[docs]@dataclass class AccountDataEvent: """Abstract class for account data events."""
[docs] @classmethod @verify(Schemas.account_data) def parse_event( cls, event_dict, # type: Dict[Any, Any] ): if event_dict["type"] == "m.fully_read": return FullyReadEvent.from_dict(event_dict) elif event_dict["type"] == "m.tag": return TagEvent.from_dict(event_dict) return UnknownAccountDataEvent.from_dict(event_dict)
[docs]@dataclass class FullyReadEvent(AccountDataEvent): """Read marker location event. The current location of the user's read marker in a room. This event appears in the user's room account data for the room the marker is applicable for. Attributes: event_id (str): The event id the user's read marker is located at in the room. """ event_id: str = field()
[docs] @classmethod @verify(Schemas.fully_read) def from_dict(cls, event_dict): """Construct a FullyReadEvent from a dictionary.""" content = event_dict.pop("content") return cls( content["event_id"], )
[docs]@dataclass class TagEvent(AccountDataEvent): """Event representing the tags of a room. Room tags may include: - m.favourite for favourite rooms - m.lowpriority for low priority room A tag may have an order between 0 and 1, indicating the room's position towards other rooms with the same tag. Attributes: tags (Dict[str, Optional[Dict[str, float]]]): The tags of the room and their contents. """ tags: Dict[str, Optional[Dict[str, float]]] = field()
[docs] @classmethod @verify(Schemas.tags) def from_dict(cls, event_dict): """Construct a TagEvent from a dictionary.""" content = event_dict.pop("content") return cls( content["tags"] )
[docs]@dataclass class UnknownAccountDataEvent(AccountDataEvent): """Account data event of an unknown type. Attributes: type (str): The type of the event. content (Dict): The content of the event. """ type: str = field() content: Dict[str, Any] = field()
[docs] @classmethod def from_dict(cls, event_dict): """Construct an UnknownAccountDataEvent from a dictionary.""" content = event_dict.pop("content") return cls( event_dict["type"], content )