synapse.api.constants module¶
Contains constants from the specification.
-
class
synapse.api.constants.
EventContentFields
¶ Bases:
object
Fields found in events’ content, regardless of type.
-
LABELS
= 'org.matrix.labels'¶
-
SELF_DESTRUCT_AFTER
= 'org.matrix.self_destruct_after'¶
-
-
class
synapse.api.constants.
EventTypes
¶ Bases:
object
-
Aliases
= 'm.room.aliases'¶
-
CanonicalAlias
= 'm.room.canonical_alias'¶
-
Create
= 'm.room.create'¶
-
Encryption
= 'm.room.encryption'¶
-
GuestAccess
= 'm.room.guest_access'¶
-
JoinRules
= 'm.room.join_rules'¶
-
Member
= 'm.room.member'¶
-
Message
= 'm.room.message'¶
-
Name
= 'm.room.name'¶
-
Pinned
= 'm.room.pinned_events'¶
-
PowerLevels
= 'm.room.power_levels'¶
-
Redaction
= 'm.room.redaction'¶
-
RelatedGroups
= 'm.room.related_groups'¶
-
Retention
= 'm.room.retention'¶
-
RoomAvatar
= 'm.room.avatar'¶
-
RoomEncryption
= 'm.room.encryption'¶
-
RoomHistoryVisibility
= 'm.room.history_visibility'¶
-
ServerACL
= 'm.room.server_acl'¶
-
ThirdPartyInvite
= 'm.room.third_party_invite'¶
-
Tombstone
= 'm.room.tombstone'¶
-
Topic
= 'm.room.topic'¶
-
-
class
synapse.api.constants.
JoinRules
¶ Bases:
object
-
INVITE
= 'invite'¶
-
KNOCK
= 'knock'¶
-
PRIVATE
= 'private'¶
-
PUBLIC
= 'public'¶
-
-
class
synapse.api.constants.
LimitBlockingTypes
¶ Bases:
object
Reasons that a server may be blocked
-
HS_DISABLED
= 'hs_disabled'¶
-
MONTHLY_ACTIVE_USER
= 'monthly_active_user'¶
-
-
class
synapse.api.constants.
LoginType
¶ Bases:
object
-
APPLICATION_SERVICE
= 'm.login.application_service'¶
-
DUMMY
= 'm.login.dummy'¶
-
EMAIL_IDENTITY
= 'm.login.email.identity'¶
-
MSISDN
= 'm.login.msisdn'¶
-
PASSWORD
= 'm.login.password'¶
-
RECAPTCHA
= 'm.login.recaptcha'¶
-
SHARED_SECRET
= 'org.matrix.login.shared_secret'¶
-
TERMS
= 'm.login.terms'¶
-
-
class
synapse.api.constants.
Membership
¶ Bases:
object
Represents the membership states of a user in a room.
-
BAN
= 'ban'¶
-
INVITE
= 'invite'¶
-
JOIN
= 'join'¶
-
KNOCK
= 'knock'¶
-
LEAVE
= 'leave'¶
-
LIST
= ('invite', 'join', 'knock', 'leave', 'ban')¶
-
-
class
synapse.api.constants.
PresenceState
¶ Bases:
object
Represents the presence state of a user.
-
OFFLINE
= 'offline'¶
-
ONLINE
= 'online'¶
-
UNAVAILABLE
= 'unavailable'¶
-
-
class
synapse.api.constants.
RelationTypes
¶ Bases:
object
The types of relations known to this server.
-
ANNOTATION
= 'm.annotation'¶
-
REFERENCE
= 'm.reference'¶
-
REPLACE
= 'm.replace'¶
-
-
class
synapse.api.constants.
RoomCreationPreset
¶ Bases:
object
-
PRIVATE_CHAT
= 'private_chat'¶
-
PUBLIC_CHAT
= 'public_chat'¶
-
TRUSTED_PRIVATE_CHAT
= 'trusted_private_chat'¶
-