Update the room creation API spec to include new keys: 'preset' and 'initial_state'

erikj/room_create_preset
Erik Johnston 10 years ago
parent ca9f30a7fd
commit 078dd0165f

@ -750,10 +750,41 @@ options which can be set when creating a room:
This will tell the server to invite everyone in the list to the newly This will tell the server to invite everyone in the list to the newly
created room. created room.
``preset``
Type:
String
Optional:
Yes
Value:
``private_chat`` or ``public_chat``
Description:
Convenience parameter for setting various default state events based on a
preset.
Two presets are defined:
- ``private_chat``: Sets the ``join_rules`` to ``invite`` and
``history_visibility`` to ``shared``
- ``public_chat``: Sets the ``join_rules`` to ``public`` and
``history_visibility`` to ``shared``
``initial_state``
Type:
List
Optional:
Yes
Value:
A list of state events to set in the new room.
Description:
Allows the user to override the default state events set in the new room.
The expected format of the state events are an object with ``type``,
``state_key`` and ``content`` keys set.
Example:: Example::
{ {
"visibility": "public", "preset": "public_chat",
"room_alias_name": "thepub", "room_alias_name": "thepub",
"name": "The Grand Duke Pub", "name": "The Grand Duke Pub",
"topic": "All about happy hour" "topic": "All about happy hour"

Loading…
Cancel
Save