mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-21 00:48:38 +01:00
More typo/layout fixes
Split out identity servers to a separate file
This commit is contained in:
parent
620d3dcb26
commit
3f9d183c2a
|
|
@ -77,10 +77,10 @@ counts
|
||||||
This is a dictionary of the current number of unacknowledged communications
|
This is a dictionary of the current number of unacknowledged communications
|
||||||
for the recipient user. Counts whose value is zero are omitted.
|
for the recipient user. Counts whose value is zero are omitted.
|
||||||
unread
|
unread
|
||||||
The number of unread messages a user has accross all of the rooms they are a
|
The number of unread messages a user has across all of the rooms they are a
|
||||||
member of.
|
member of.
|
||||||
missed_calls
|
missed_calls
|
||||||
The number of unacknowledged missed calls a user has accross all rooms of
|
The number of unacknowledged missed calls a user has across all rooms of
|
||||||
which they are a member.
|
which they are a member.
|
||||||
device
|
device
|
||||||
This is an array of devices that the notification should be sent to.
|
This is an array of devices that the notification should be sent to.
|
||||||
|
|
@ -104,13 +104,13 @@ And additional key is defined but only present on member events:
|
||||||
|
|
||||||
user_is_target
|
user_is_target
|
||||||
This is true if the user receiving the notification is the subject of a member
|
This is true if the user receiving the notification is the subject of a member
|
||||||
event (ie. the state_key of the member event is equal to the user's Matrix
|
event (i.e. the state_key of the member event is equal to the user's Matrix
|
||||||
ID).
|
ID).
|
||||||
|
|
||||||
The recipient of an HTTP notification should respond with an HTTP 2xx response
|
The recipient of an HTTP notification should respond with an HTTP 2xx response
|
||||||
when the notification has been processed. If the endpoint returns an HTTP error
|
when the notification has been processed. If the endpoint returns an HTTP error
|
||||||
code, the Home Server should retry for a reasonable amount of time with a
|
code, the Home Server should retry for a reasonable amount of time with a
|
||||||
reasonable backoff scheme.
|
reasonable back-off scheme.
|
||||||
|
|
||||||
The endpoint should return a JSON dictionary as follows::
|
The endpoint should return a JSON dictionary as follows::
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,9 +5,10 @@ Client APIs
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
To set "I am typing for the next N msec"::
|
To set "I am typing for the next N msec"::
|
||||||
|
|
||||||
PUT .../rooms/<room_id>/typing/<user_id>
|
PUT .../rooms/<room_id>/typing/<user_id>
|
||||||
Content: { "typing": true, "timeout": N }
|
Content: { "typing": true, "timeout": N }
|
||||||
# timeout is in msec; I suggest no more than 20 or 30 seconds
|
# timeout is in milliseconds; suggested no more than 20 or 30 seconds
|
||||||
|
|
||||||
This should be re-sent by the client to continue informing the server the user
|
This should be re-sent by the client to continue informing the server the user
|
||||||
is still typing; I suggest a safety margin of 5 seconds before the expected
|
is still typing; I suggest a safety margin of 5 seconds before the expected
|
||||||
|
|
@ -15,6 +16,7 @@ timeout runs out. Just keep declaring a new timeout, it will replace the old
|
||||||
one.
|
one.
|
||||||
|
|
||||||
To set "I am no longer typing"::
|
To set "I am no longer typing"::
|
||||||
|
|
||||||
PUT ../rooms/<room_id>/typing/<user_id>
|
PUT ../rooms/<room_id>/typing/<user_id>
|
||||||
Content: { "typing": false }
|
Content: { "typing": false }
|
||||||
|
|
||||||
|
|
@ -46,13 +48,14 @@ Servers will emit EDUs in the following form::
|
||||||
"content": {
|
"content": {
|
||||||
"room_id": "!room-id-here:matrix.org",
|
"room_id": "!room-id-here:matrix.org",
|
||||||
"user_id": "@user-id-here:matrix.org",
|
"user_id": "@user-id-here:matrix.org",
|
||||||
"typing": true/false,
|
"typing": true/false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Server EDUs don't (currently) contain timing information; it is up to
|
Server EDUs don't (currently) contain timing information; it is up to
|
||||||
originating HSes to ensure they eventually send "stop" notifications.
|
originating HSes to ensure they eventually send "stop" notifications.
|
||||||
|
|
||||||
((This will eventually need addressing, as part of the wider typing/presence
|
.. TODO
|
||||||
timer addition work))
|
((This will eventually need addressing, as part of the wider typing/presence
|
||||||
|
timer addition work))
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,8 @@ Receipts
|
||||||
========
|
========
|
||||||
|
|
||||||
Receipts are used to publish which events in a room the user or their devices
|
Receipts are used to publish which events in a room the user or their devices
|
||||||
have interacted with. For example, which events the user has read.
|
have interacted with. For example, which events the user has read. For
|
||||||
|
efficiency this is done as "up to" markers, i.e. marking a particular event
|
||||||
For efficiency this is done as "up to" markers, i.e. marking a particular event
|
|
||||||
as, say, ``read`` indicates the user has read all events *up to* that event.
|
as, say, ``read`` indicates the user has read all events *up to* that event.
|
||||||
|
|
||||||
Client-Server API
|
Client-Server API
|
||||||
|
|
@ -43,14 +42,11 @@ For example::
|
||||||
}
|
}
|
||||||
|
|
||||||
For efficiency, receipts are batched into one event per room. In the initialSync
|
For efficiency, receipts are batched into one event per room. In the initialSync
|
||||||
and v2 sync APIs the receipts are listed in a seperate top level ``receipts``
|
and v2 sync APIs the receipts are listed in a separate top level ``receipts``
|
||||||
key.
|
key. Each ``user_id``, ``receipt_type`` pair must be associated with only a
|
||||||
|
single ``event_id``. New receipts that come down the event streams are deltas.
|
||||||
Each ``user_id``, ``receipt_type`` pair must be associated with only a single
|
Deltas update existing mappings, clobbering based on ``user_id``,
|
||||||
``event_id``.
|
``receipt_type`` pairs.
|
||||||
|
|
||||||
New receipts that come down the event streams are deltas. Deltas update
|
|
||||||
existing mappings, clobbering based on ``user_id``, ``receipt_type`` pairs.
|
|
||||||
|
|
||||||
|
|
||||||
A client can update the markers for its user by issuing a request::
|
A client can update the markers for its user by issuing a request::
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,10 @@ Address book repository
|
||||||
|
|
||||||
.. NOTE::
|
.. NOTE::
|
||||||
This section is a work in progress.
|
This section is a work in progress.
|
||||||
Do we even need it? Clients can use out-of-band addressbook servers for now;
|
|
||||||
this should definitely not be core.
|
|
||||||
|
|
||||||
.. TODO-spec
|
.. TODO-spec
|
||||||
|
Do we even need it? Clients can use out-of-band addressbook servers for now;
|
||||||
|
this should definitely not be core.
|
||||||
- format: POST(?) wodges of json, some possible processing, then return wodges of json on GET.
|
- format: POST(?) wodges of json, some possible processing, then return wodges of json on GET.
|
||||||
- processing may remove dupes, merge contacts, pepper with extra info (e.g. matrix-ability of
|
- processing may remove dupes, merge contacts, pepper with extra info (e.g. matrix-ability of
|
||||||
contacts), etc.
|
contacts), etc.
|
||||||
|
|
|
||||||
|
|
@ -128,11 +128,3 @@ Threat: Disclosure to Servers Within Chatroom
|
||||||
An attacker could take control of a server within a chatroom to expose message
|
An attacker could take control of a server within a chatroom to expose message
|
||||||
contents or metadata for messages in that room.
|
contents or metadata for messages in that room.
|
||||||
|
|
||||||
|
|
||||||
Identity Servers
|
|
||||||
================
|
|
||||||
.. NOTE::
|
|
||||||
This section is a work in progress.
|
|
||||||
|
|
||||||
.. TODO-doc Dave
|
|
||||||
- 3PIDs and identity server, functions
|
|
||||||
|
|
|
||||||
8
specification/60_identity_servers.rst
Normal file
8
specification/60_identity_servers.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
Identity Servers
|
||||||
|
================
|
||||||
|
.. NOTE::
|
||||||
|
This section is a work in progress.
|
||||||
|
|
||||||
|
.. TODO-doc Dave
|
||||||
|
- 3PIDs and identity server, functions
|
||||||
|
|
||||||
Loading…
Reference in a new issue