Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
74cc722b
Commit
74cc722b
authored
10 years ago
by
Kegan Dougal
Browse files
Options
Downloads
Patches
Plain Diff
Added case-sensitivity notes on IDs, added TODO on UTF-8.
parent
6dd50da5
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/specification.rst
+15
-7
15 additions, 7 deletions
docs/specification.rst
with
15 additions
and
7 deletions
docs/specification.rst
+
15
−
7
View file @
74cc722b
...
@@ -35,8 +35,8 @@ namespaced to the home server which allocated the account and looks like::
...
@@ -35,8 +35,8 @@ namespaced to the home server which allocated the account and looks like::
@localpart:domain
@localpart:domain
The ``localpart`` of a user ID may be a user name, or an opaque ID identifying this user.
The ``localpart`` of a user ID may be a user name, or an opaque ID identifying this user.
They are
case-insensitive.
A "Home Server" is a server which provides C-S APIs and has the ability to federate with other HSes.
A "Home Server" is a server which provides C-S APIs and has the ability to federate with other HSes.
It is typically responsible for multiple clients. "Federation" is the term used to describe the
It is typically responsible for multiple clients. "Federation" is the term used to describe the
...
@@ -60,7 +60,8 @@ identified via a "Room ID", which look like::
...
@@ -60,7 +60,8 @@ identified via a "Room ID", which look like::
There is exactly one room ID for each room. Whilst the room ID does contain a
There is exactly one room ID for each room. Whilst the room ID does contain a
domain, it is simply for namespacing room IDs. The room does NOT reside on the
domain, it is simply for namespacing room IDs. The room does NOT reside on the
domain specified. Room IDs are not meant to be human readable.
domain specified. Room IDs are not meant to be human readable. They ARE
case-sensitive.
The following diagram shows an ``m.room.message`` event being sent in the room
The following diagram shows an ``m.room.message`` event being sent in the room
``!qporfwt:matrix.org``::
``!qporfwt:matrix.org``::
...
@@ -102,10 +103,10 @@ Each room can also have multiple "Room Aliases", which looks like::
...
@@ -102,10 +103,10 @@ Each room can also have multiple "Room Aliases", which looks like::
A room alias "points" to a room ID. The room ID the alias is pointing to can be obtained
A room alias "points" to a room ID. The room ID the alias is pointing to can be obtained
by visiting the domain specified. Room aliases are designed to be human readable strings
by visiting the domain specified. Room aliases are designed to be human readable strings
which can be used to publicise rooms.
Note that the mapping from a room alias to a
which can be used to publicise rooms.
They are case-insensitive. Note that the mapping
room ID is not fixed, and may change over time to point to a
different room ID. For this
from a room alias to a
room ID is not fixed, and may change over time to point to a
reason, Clients SHOULD resolve the room alias to a room ID
once and then use that ID on
different room ID. For this
reason, Clients SHOULD resolve the room alias to a room ID
subsequent requests.
once and then use that ID on
subsequent requests.
::
::
...
@@ -214,6 +215,12 @@ In contrast, these are invalid requests::
...
@@ -214,6 +215,12 @@ In contrast, these are invalid requests::
"key": "This is a put but it is missing a txnId."
"key": "This is a put but it is missing a txnId."
}
}
- TODO: All strings everywhere are UTF-8
Receiving live updates on a client
Receiving live updates on a client
----------------------------------
----------------------------------
Clients can receive new events by long-polling the home server. This will hold open the
Clients can receive new events by long-polling the home server. This will hold open the
...
@@ -288,6 +295,7 @@ Joining rooms
...
@@ -288,6 +295,7 @@ Joining rooms
Leaving rooms
Leaving rooms
-------------
-------------
- API to hit (``$roomid/leave``).
- API to hit (``$roomid/leave``).
- If no more HSes in room, can delete room?
- Is there a dance?
- Is there a dance?
Room events
Room events
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment