Add spec for m.room.pinned_events
Signed-off-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
parent
cfb547b474
commit
a1265a274b
3 changed files with 38 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -8,3 +8,4 @@
|
|||
/templating/out
|
||||
*.pyc
|
||||
*.swp
|
||||
/env
|
12
event-schemas/examples/m.room.pinned_events
Normal file
12
event-schemas/examples/m.room.pinned_events
Normal file
|
@ -0,0 +1,12 @@
|
|||
{
|
||||
"age": 242352,
|
||||
"content": {
|
||||
"pinned": ["$someevent:localhost"]
|
||||
},
|
||||
"state_key": "",
|
||||
"origin_server_ts": 1431961217939,
|
||||
"event_id": "$WLGTSEFSEF:localhost",
|
||||
"type": "m.room.pinned_events",
|
||||
"room_id": "!Cuyf34gef24t:localhost",
|
||||
"sender": "@example:localhost"
|
||||
}
|
25
event-schemas/schema/m.room.pinned_events
Normal file
25
event-schemas/schema/m.room.pinned_events
Normal file
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
allOf:
|
||||
- $ref: core-event-schema/state_event.yaml
|
||||
description: This event is used to "pin" particular events in a room for other participants to review later. The order of the pinned events is guaranteed and based upon the order supplied in the event. Clients should be aware that the current user may not be able to see some of the events pinned due to visibility settings in the room. Clients are responsible for determining if a particular event in the pinned list is displayable, and have the option to not display it if it cannot be pinned in the client.
|
||||
properties:
|
||||
content:
|
||||
properties:
|
||||
pinned:
|
||||
description: An ordered list of event IDs to pin.
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- pinned
|
||||
type: object
|
||||
state_key:
|
||||
description: A zero-length string.
|
||||
pattern: '^$'
|
||||
type: string
|
||||
type:
|
||||
enum:
|
||||
- m.room.pinned_events
|
||||
type: string
|
||||
title: Pinned events in a room
|
||||
type: object
|
Loading…
Add table
Add a link
Reference in a new issue