Commit 55fa9f19815af5b0cf3144df0d5bc787bd4de820
Document mentions more
cel committed on 8/23/2019, 1:27:26 AMParent: 73bb7c6cea0efa5a8352159d71fc7d30aac10e6b
Files changed
| tmpl/docs/message-types/post.md | changed |
| tmpl/docs/message-types/post.md | |||
|---|---|---|---|
| @@ -45,8 +45,10 @@ | |||
| 45 | 45 … | - Blob mentions: for when a file is referected in the `text`. | |
| 46 | 46 … | - Message mentions: for when a message is referenced in the `text`. | |
| 47 | 47 … | - Channel/hashtag mentions: for when a channel/hashtag is referenced in the `text`. Note: these are not returned in queries using the [`sbot.links`](/docs/advanced/links.html) method, but they are in queries using the [`ssb-backlinks`](https://www.npmjs.com/package/ssb-backlinks) plugin. | |
| 48 | 48 … | ||
| 49 … | +A link in `mentions` should be an object with property `link` set to a feed id, blob id, message id or hashtag. Additional properties may also be set, such as `name` for a name for the linked entity. For blob mentions, properties describing the file can be used, such as `size` (size in bytes), and `type` (mime-type). | ||
| 50 … | + | ||
| 49 | 51 … | ### Recps | |
| 50 | 52 … | ||
| 51 | 53 … | `recps` is a list of user-links specifying who the message is for. | |
| 52 | 54 … | This is typically used for encrypted messages, to specify who the message was encrypted for, but it can be used in unencrypted messages as well. | |
Built with git-ssb-web