Clarify how to use state_after ahead of declaring full support for its spec version

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
pull/2240/head
Johannes Marbach 1 month ago
parent 9d063c8d2d
commit 617804e3c7

@ -0,0 +1 @@
Clarify how to use `state_after` ahead of declaring full support for its spec version.

@ -133,10 +133,15 @@ paths:
sync and the **start** of the timeline in `state` and MUST omit sync and the **start** of the timeline in `state` and MUST omit
`state_after`. `state_after`.
Even if this is set to `true`, clients MUST update their local state Servers MAY implement this parameter ahead of declaring support for
with events in `state` and `timeline` if `state_after` is missing in the version of the spec in which it was introduced. Consequently,
the response, for compatibility with servers that don't support this clients MAY set this parameter to `true` regardless of the
parameter. [`/versions`](/client-server-api/#get_matrixclientversions) response.
If they do, they can infer whether the server actually supports this
parameter from the presence of `state_after` in the response. If
`state_after` is missing, clients MUST behave as if they had not
specified the parameter and update their local state with events
in `state` and `timeline`.
By default, this is `false`. By default, this is `false`.
example: false example: false

Loading…
Cancel
Save