synapse-old/synapse/api/presence.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

102 lines
3.1 KiB
Python
Raw Normal View History

2016-01-06 21:26:29 -07:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 08:10:52 -06:00
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import Any, Optional
import attr
2018-07-09 00:09:20 -06:00
2016-02-15 10:10:40 -07:00
from synapse.api.constants import PresenceState
from synapse.types import JsonDict
2014-08-12 08:10:52 -06:00
@attr.s(slots=True, auto_attribs=True)
class UserDevicePresenceState:
"""
Represents the current presence state of a user's device.
user_id: The user ID.
device_id: The user's device ID.
state: The presence state, see PresenceState.
last_active_ts: Time in msec that the device last interacted with server.
last_sync_ts: Time in msec that the device last *completed* a sync
(or event stream).
"""
user_id: str
device_id: Optional[str]
state: str
last_active_ts: int
last_sync_ts: int
@classmethod
def default(
cls, user_id: str, device_id: Optional[str]
) -> "UserDevicePresenceState":
"""Returns a default presence state."""
return cls(
user_id=user_id,
device_id=device_id,
state=PresenceState.OFFLINE,
last_active_ts=0,
last_sync_ts=0,
)
@attr.s(slots=True, frozen=True, auto_attribs=True)
class UserPresenceState:
2016-02-15 10:10:40 -07:00
"""Represents the current presence state of the user.
user_id: The user ID.
state: The presence state, see PresenceState.
last_active_ts: Time in msec that the user last interacted with server.
last_federation_update_ts: Time in msec since either a) we sent a presence
2016-02-15 10:10:40 -07:00
update to other servers or b) we received a presence update, depending
on if is a local user or not.
last_user_sync_ts: Time in msec that the user last *completed* a sync
2016-02-15 10:10:40 -07:00
(or event stream).
status_msg: User set status message.
currently_active: True if the user is currently syncing.
2016-02-15 10:10:40 -07:00
"""
user_id: str
state: str
last_active_ts: int
last_federation_update_ts: int
last_user_sync_ts: int
status_msg: Optional[str]
currently_active: bool
def as_dict(self) -> JsonDict:
return attr.asdict(self)
@staticmethod
def from_dict(d: JsonDict) -> "UserPresenceState":
return UserPresenceState(**d)
def copy_and_replace(self, **kwargs: Any) -> "UserPresenceState":
return attr.evolve(self, **kwargs)
2016-02-15 10:10:40 -07:00
@classmethod
def default(cls, user_id: str) -> "UserPresenceState":
2016-02-15 10:10:40 -07:00
"""Returns a default presence state."""
return cls(
user_id=user_id,
state=PresenceState.OFFLINE,
2016-02-18 03:11:43 -07:00
last_active_ts=0,
last_federation_update_ts=0,
last_user_sync_ts=0,
2016-02-15 10:10:40 -07:00
status_msg=None,
currently_active=False,
2014-08-12 08:10:52 -06:00
)