MatrixSynapse/synapse/api/constants.py

147 lines
3.8 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
# Copyright 2017 Vector Creations Ltd
# Copyright 2018 New Vector 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-12 16:10:52 +02:00
"""Contains constants from the specification."""
# the "depth" field on events is limited to 2**63 - 1
MAX_DEPTH = 2**63 - 1
2014-08-12 16:10:52 +02:00
class Membership(object):
"""Represents the membership states of a user in a room."""
INVITE = u"invite"
JOIN = u"join"
KNOCK = u"knock"
LEAVE = u"leave"
2014-09-01 17:15:34 +02:00
BAN = u"ban"
LIST = (INVITE, JOIN, KNOCK, LEAVE, BAN)
2014-08-12 16:10:52 +02:00
class PresenceState(object):
"""Represents the presence state of a user."""
OFFLINE = u"offline"
UNAVAILABLE = u"unavailable"
ONLINE = u"online"
class JoinRules(object):
PUBLIC = u"public"
KNOCK = u"knock"
INVITE = u"invite"
PRIVATE = u"private"
class LoginType(object):
PASSWORD = u"m.login.password"
EMAIL_IDENTITY = u"m.login.email.identity"
MSISDN = u"m.login.msisdn"
2014-10-30 12:10:17 +01:00
RECAPTCHA = u"m.login.recaptcha"
TERMS = u"m.login.terms"
DUMMY = u"m.login.dummy"
# Only for C/S API v1
APPLICATION_SERVICE = u"m.login.application_service"
SHARED_SECRET = u"org.matrix.login.shared_secret"
2014-12-03 17:07:21 +01:00
class EventTypes(object):
Member = "m.room.member"
Create = "m.room.create"
Tombstone = "m.room.tombstone"
2014-12-03 17:07:21 +01:00
JoinRules = "m.room.join_rules"
PowerLevels = "m.room.power_levels"
Aliases = "m.room.aliases"
2014-12-09 15:49:11 +01:00
Redaction = "m.room.redaction"
ThirdPartyInvite = "m.room.third_party_invite"
Encryption = "m.room.encryption"
RoomHistoryVisibility = "m.room.history_visibility"
CanonicalAlias = "m.room.canonical_alias"
RoomAvatar = "m.room.avatar"
GuestAccess = "m.room.guest_access"
# These are used for validation
Message = "m.room.message"
Topic = "m.room.topic"
Name = "m.room.name"
2015-01-28 17:16:53 +01:00
ServerACL = "m.room.server_acl"
2018-08-15 16:04:30 +02:00
Pinned = "m.room.pinned_events"
2015-01-28 17:16:53 +01:00
class RejectedReason(object):
AUTH_ERROR = "auth_error"
REPLACED = "replaced"
NOT_ANCESTOR = "not_ancestor"
2015-07-13 17:48:06 +02:00
class RoomCreationPreset(object):
2015-07-14 11:20:31 +02:00
PRIVATE_CHAT = "private_chat"
PUBLIC_CHAT = "public_chat"
TRUSTED_PRIVATE_CHAT = "trusted_private_chat"
class ThirdPartyEntityKind(object):
USER = "user"
LOCATION = "location"
2018-08-07 16:27:19 +02:00
class RoomVersions(object):
V1 = "1"
2018-12-18 19:10:37 +01:00
V2 = "2"
2019-01-29 14:50:59 +01:00
V3 = "3" # Not currently fully supported, so we don't add to known versions below
2018-11-01 12:43:46 +01:00
STATE_V2_TEST = "state-v2-test"
2018-08-07 16:27:19 +02:00
# the version we will give rooms which are created on this server
2018-08-07 16:27:19 +02:00
DEFAULT_ROOM_VERSION = RoomVersions.V1
# vdh-test-version is a placeholder to get room versioning support working and tested
# until we have a working v2.
2018-11-01 12:43:46 +01:00
KNOWN_ROOM_VERSIONS = {
RoomVersions.V1,
2018-12-18 19:10:37 +01:00
RoomVersions.V2,
2018-11-01 12:43:46 +01:00
RoomVersions.STATE_V2_TEST,
}
2018-08-22 18:00:29 +02:00
class EventFormatVersions(object):
"""This is an internal enum for tracking the version of the event format,
independently from the room version.
"""
V1 = 1
2019-01-29 18:26:24 +01:00
V2 = 2
KNOWN_EVENT_FORMAT_VERSIONS = {
EventFormatVersions.V1,
2019-01-29 18:26:24 +01:00
EventFormatVersions.V2,
}
2018-08-22 18:00:29 +02:00
ServerNoticeMsgType = "m.server_notice"
ServerNoticeLimitReached = "m.server_notice.usage_limit_reached"
class UserTypes(object):
"""Allows for user type specific behaviour. With the benefit of hindsight
'admin' and 'guest' users should also be UserTypes. Normal users are type None
"""
SUPPORT = "support"
2019-01-15 15:38:15 +01:00
ALL_USER_TYPES = (SUPPORT,)