InterfacePreviewCard

Represents a rich preview card that is generated using OpenGraph tags from a URL.

See

https://docs.joinmastodon.org/entities/PreviewCard

interface PreviewCard {
    authorName?: null | string;
    authors: PreviewCardAuthor[];
    authorUrl?: null | string;
    blurhash: string;
    description: string;
    embedUrl: string;
    height?: null | number;
    html?: null | string;
    image?: null | string;
    language?: string;
    providerName?: null | string;
    providerUrl?: null | string;
    title: string;
    type: PreviewCardType;
    url: string;
    width?: null | number;
}

Hierarchy (view full)

Properties

authorName? authors authorUrl? blurhash description embedUrl height? html? image? language? providerName? providerUrl? title type url width?

Properties

OptionalauthorName

authorName?: null | string

The author of the original resource.

Deprecated

Use authors instead

authors

authors: PreviewCardAuthor[]

Fediverse account of the authors of the original resource.

OptionalauthorUrl

authorUrl?: null | string

A link to the author of the original resource.

Deprecated

Use authors instead

blurhash

blurhash: string

Blurhash

description

description: string

Description of preview.

embedUrl

embedUrl: string

Used for photo embeds, instead of custom html.

Optionalheight

height?: null | number

Height of preview, in pixels.

Optionalhtml

html?: null | string

HTML to be used for generating the preview card.

Optionalimage

image?: null | string

Preview thumbnail.

Optionallanguage

language?: string

See

https://github.com/mastodon/mastodon/pull/27503

OptionalproviderName

providerName?: null | string

The provider of the original resource.

OptionalproviderUrl

providerUrl?: null | string

A link to the provider of the original resource.

title

title: string

Title of linked resource.

type

type: PreviewCardType

The type of the preview card.

url

url: string

Location of linked resource.

Optionalwidth

width?: null | number

Width of preview, in pixels.

Settings

Member Visibility

On This Page

Properties