Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sticker messages (m.sticker) #1158

Merged
merged 19 commits into from
Mar 27, 2018
Merged

Sticker messages (m.sticker) #1158

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a87cd82
Example m.sticker event
rxl881 Mar 14, 2018
2989406
Very basic m.sticker description.
rxl881 Mar 14, 2018
91f1834
m.sticker event definition.
rxl881 Mar 14, 2018
c471f48
Additional event structure detail.
rxl881 Mar 14, 2018
0f8e34d
Update m.sticker description with more detail.
rxl881 Mar 14, 2018
f421337
Wrap lines at 80 cols.
rxl881 Mar 15, 2018
c59b879
Add backlink to m.image event definition.
rxl881 Mar 15, 2018
250ada7
Update sticker resolution recommendation.
rxl881 Mar 15, 2018
a1fdecc
Misc fixes.
rxl881 Mar 15, 2018
8dd7bd5
Fix grammar (slightly).
rxl881 Mar 15, 2018
1d9de28
Fix formatting.
rxl881 Mar 15, 2018
43d9543
Improve wording.
rxl881 Mar 15, 2018
90d9960
Specify that the `url` key should point to a valid MXC URI
rxl881 Mar 23, 2018
eb7bbcf
Clarify image sizing guidelines.
rxl881 Mar 23, 2018
618096e
Move MXC requirement to schema.
rxl881 Mar 23, 2018
114e9e2
Fix multiline formatting.
rxl881 Mar 23, 2018
761ad98
Fix errant comma.
rxl881 Mar 23, 2018
56dc295
Improve thumbnail dimension descriptions.
rxl881 Mar 23, 2018
02c5afb
Update changelog.
rxl881 Mar 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion event-schemas/schema/m.sticker
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ properties:
Metadata about the image referred to in ``url`` including a thumbnail
representation.
url:
description: The URL to the sticker image.
description: |-
The URL to the sticker image. This must be a valid ``mxc://`` URI.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, if we're expecting clients to check this, we should probably say so.

type: string
required:
- body
Expand Down
2 changes: 0 additions & 2 deletions specification/modules/stickers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ Client behaviour
Clients supporting this message type should display the image content from the
event URL directly in the timeline.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might want to have some warning about sanitising URLs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, hopefully clarifying that we expect these to be valid MXC URIs should be enough(?)


The event ``url`` key must specify a valid ``mxc://`` URI.

A thumbnail image should be provided in the ``info`` object. This is
largely intended as a fallback for clients that do not fully support the
``m.sticker`` event type. In most cases it is fine to set the thumbnail URL to the
Expand Down