4.8 KiB
| title | description | menu | aliases | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PreviewCard | Represents a rich preview card that is generated using OpenGraph tags from a URL. |
|
|
Examples
Video
{
"url": "https://www.youtube.com/watch?v=OMv_EPMED8Y",
"title": "♪ Brand New Friend (Christmas Song!)",
"description": "",
"type": "video",
"author_name": "YOGSCAST Lewis & Simon",
"author_url": "https://www.youtube.com/user/BlueXephos",
"provider_name": "YouTube",
"provider_url": "https://www.youtube.com/",
"html": "<iframe width=\"480\" height=\"270\" src=\"https://www.youtube.com/embed/OMv_EPMED8Y?feature=oembed\" frameborder=\"0\" allowfullscreen=\"\"></iframe>",
"width": 480,
"height": 270,
"image": "https://files.mastodon.social/preview_cards/images/014/179/145/original/9cf4b7cf5567b569.jpeg",
"embed_url": "",
"blurhash": "UvK0HNkV,:s9xBR%njog0fo2W=WBS5ozofV@"
}
Photo
{
"url": "https://www.flickr.com/photos/tomfenskephotography/49088768431/",
"title": "Oregon",
"description": "",
"type": "photo",
"author_name": "Tom Fenske Photography",
"author_url": "https://www.flickr.com/photos/tomfenskephotography/",
"provider_name": "Flickr",
"provider_url": "https://www.flickr.com/",
"html": "",
"width": 1024,
"height": 427,
"image": "https://files.mastodon.social/preview_cards/images/014/287/139/original/651b1c6976817824.jpeg",
"embed_url": "https://live.staticflickr.com/65535/49088768431_6a4322b3bb_b.jpg",
"blurhash": "UnE{@jt6M_oIAhjYs+ayT2WBf9ayRkkDXAj["
}
Link
{
"url": "https://www.theguardian.com/money/2019/dec/07/i-lost-my-193000-inheritance-with-one-wrong-digit-on-my-sort-code",
"title": "‘I lost my £193,000 inheritance – with one wrong digit on my sort code’",
"description": "When Peter Teich’s money went to another Barclays customer, the bank offered £25 as a token gesture",
"type": "link",
"author_name": "",
"author_url": "",
"provider_name": "",
"provider_url": "",
"html": "",
"width": 0,
"height": 0,
"image": null,
"embed_url": "",
"blurhash": null
}
Attributes
url
Description: Location of linked resource.
Type: String (URL)
Version history:
1.0.0 - added
title
Description: Title of linked resource.
Type: String
Version history:
1.0.0 - added
description
Description: Description of preview.
Type: String
Version history:
1.0.0 - added
type
Description: The type of the preview card.
Type: String (Enumerable, oneOf)
link = Link OEmbed
photo = Photo OEmbed
video = Video OEmbed
rich = iframe OEmbed. Not currently accepted, so won't show up in practice.
Version history:
1.3.0 - added
author_name
Description: The author of the original resource.
Type: String
Version history:
1.3.0 - added
author_url
Description: A link to the author of the original resource.
Type: String (URL)
Version history:
1.3.0 - added
provider_name
Description: The provider of the original resource.
Type: String
Version history:
1.3.0 - added
provider_url
Description: A link to the provider of the original resource.
Type: String (URL)
Version history:
1.3.0 - added
html
Description: HTML to be used for generating the preview card.
Type: String (HTML)
Version history:
1.3.0 - added
width
Description: Width of preview, in pixels.
Type: Integer
Version history:
1.3.0 - added
height
Description: Height of preview, in pixels.
Type: Integer
Version history:
1.3.0 - added
image
Description: Preview thumbnail.
Type: {{}} String (URL)
Version history:
1.0.0 - added
embed_url
Description: Used for photo embeds, instead of custom html.
Type: String (URL)
Version history:
2.1.0 - added
blurhash
Description: A hash computed by the BlurHash algorithm, for generating colorful preview thumbnails when media has not been downloaded yet.
Type: {{}} String
Version history:
3.2.0 - added
See also
{{< page-relref ref="entities/Status#card" caption="Status (card attribute)" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/preview_card_serializer.rb" caption="app/serializers/rest/preview_card_serializer.rb" >}}