Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 00:48:38 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Proposal for adding full_state param to v2 sync

Browse source
This commit is contained in:
Richard van der Hoff 2015-10-26 15:52:45 +00:00
parent 696f75d80b
commit 13eddd456f
2 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
api/client-server/v2_alpha/sync.yaml
View file

@ -22,7 +22,7 @@ paths:
summary: Synchronise the client's state and receive new messages. summary: Synchronise the client's state and receive new messages.
description: |- description: |-
Synchronise the client's state with the latest state on the server. Synchronise the client's state with the latest state on the server.
Client's use this API when they first log in to get an initial snapshot Clients use this API when they first log in to get an initial snapshot
of the state on the server, and then continue to call this API to get of the state on the server, and then continue to call this API to get
incremental deltas to the state, and to receive new messages. incremental deltas to the state, and to receive new messages.
security: security:
@ -40,6 +40,22 @@ paths:
description: |- description: |-
A point in time to continue a sync from. A point in time to continue a sync from.
x-example: "s72594_4483_1934" x-example: "s72594_4483_1934"
- in: query
name: full_state
type: boolean
description: |-
Controls whether to include the full state for all rooms the user
is a member of.
If this is set to ``true``, then all state events will be returned,
even if ``since`` is non-empty. The timeline will still be limited
by the ``since`` parameter.
If ``false``, and ``since`` is non-empty, only state which has
changed since the point indicated by ``since`` will be returned.
By default, this is ``false``.
x-example: "false"
- in: query - in: query
name: set_presence name: set_presence
type: string type: string
@ -135,7 +151,7 @@ paths:
type: object type: object
description: |- description: |-
The state of a room that the user has been invited The state of a room that the user has been invited
to. These state events may only have the `sender``, to. These state events may only have the ``sender``,
``type``, ``state_key`` and ``content`` keys ``type``, ``state_key`` and ``content`` keys
present. These events do not replace any state that present. These events do not replace any state that
the client already has for the room, for example if the client already has for the room, for example if

2
specification/client_server_api.rst
View file

@ -659,6 +659,8 @@ This API also returns an ``end`` token which can be used with the event stream.
{{sync_http_api}} {{sync_http_api}}
{{v2_sync_http_api}}
Getting events for a room Getting events for a room
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~