2016-01-07 05:26:29 +01:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 16:10:52 +02: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.
|
2014-08-13 04:14:34 +02:00
|
|
|
|
2021-10-18 21:01:10 +02:00
|
|
|
from typing import Any, Optional
|
|
|
|
|
|
|
|
import attr
|
2018-07-09 08:09:20 +02:00
|
|
|
|
2016-02-15 18:10:40 +01:00
|
|
|
from synapse.api.constants import PresenceState
|
2021-10-18 21:01:10 +02:00
|
|
|
from synapse.types import JsonDict
|
2015-05-22 17:11:17 +02:00
|
|
|
|
2014-08-12 16:10:52 +02:00
|
|
|
|
2021-10-18 21:01:10 +02:00
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
|
|
class UserPresenceState:
|
2016-02-15 18:10:40 +01:00
|
|
|
"""Represents the current presence state of the user.
|
|
|
|
|
2021-10-18 21:01:10 +02:00
|
|
|
user_id
|
|
|
|
last_active: Time in msec that the user last interacted with server.
|
|
|
|
last_federation_update: Time in msec since either a) we sent a presence
|
2016-02-15 18:10:40 +01:00
|
|
|
update to other servers or b) we received a presence update, depending
|
|
|
|
on if is a local user or not.
|
2021-10-18 21:01:10 +02:00
|
|
|
last_user_sync: Time in msec that the user last *completed* a sync
|
2016-02-15 18:10:40 +01:00
|
|
|
(or event stream).
|
2021-10-18 21:01:10 +02:00
|
|
|
status_msg: User set status message.
|
2016-02-15 18:10:40 +01:00
|
|
|
"""
|
|
|
|
|
2021-10-18 21:01:10 +02: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)
|
2016-11-16 18:34:44 +01:00
|
|
|
|
|
|
|
@staticmethod
|
2021-10-18 21:01:10 +02:00
|
|
|
def from_dict(d: JsonDict) -> "UserPresenceState":
|
2016-11-16 18:34:44 +01:00
|
|
|
return UserPresenceState(**d)
|
|
|
|
|
2021-10-18 21:01:10 +02:00
|
|
|
def copy_and_replace(self, **kwargs: Any) -> "UserPresenceState":
|
|
|
|
return attr.evolve(self, **kwargs)
|
2016-02-15 18:10:40 +01:00
|
|
|
|
|
|
|
@classmethod
|
2021-10-18 21:01:10 +02:00
|
|
|
def default(cls, user_id: str) -> "UserPresenceState":
|
2021-02-16 23:32:34 +01:00
|
|
|
"""Returns a default presence state."""
|
2016-02-15 18:10:40 +01:00
|
|
|
return cls(
|
|
|
|
user_id=user_id,
|
|
|
|
state=PresenceState.OFFLINE,
|
2016-02-18 11:11:43 +01:00
|
|
|
last_active_ts=0,
|
|
|
|
last_federation_update_ts=0,
|
|
|
|
last_user_sync_ts=0,
|
2016-02-15 18:10:40 +01:00
|
|
|
status_msg=None,
|
|
|
|
currently_active=False,
|
2014-08-12 16:10:52 +02:00
|
|
|
)
|