embedFormat

fun Statuses.embedFormat(    url: String,     maxWidth: Int? = null,     hideMedia: Boolean? = null,     hideThread: Boolean? = null,     omitScript: Boolean? = null,     align: EmbedAlign = EmbedAlign.Default,     related: List<String>? = null,     lang: String? = null,     theme: EmbedTheme = EmbedTheme.Default,     linkColor: String? = null,     widgetType: EmbedWidgetType = EmbedWidgetType.Default,     dnt: Boolean? = null,     vararg options: Option): JsonObjectApiAction<Embed>

Returns a single Tweet, specified by either a Tweet web URL or the Tweet ID, in an oEmbed-compatible format. The returned HTML snippet will be automatically recognized as an Embedded Tweet when Twitter's widget JavaScript is included on the page. The oEmbed endpoint allows customization of the final appearance of an Embedded Tweet by setting the corresponding properties in HTML markup to be interpreted by Twitter's JavaScript bundled with the HTML response by default. The format of the returned markup may change over time as Twitter adds new features or adjusts its Tweet representation. The Tweet fallback markup is meant to be cached on your servers for up to the suggested cache lifetime specified in the cache_age.

Twitter API reference

Receiver

Statuses endpoint instance.

Return

JsonObjectApiAction for Embed model.

Parameters

url

The URL of the Tweet to be embedded.

maxWidth

The maximum width of a rendered Tweet in whole pixels. A supplied value under or over the allowed range will be returned as the minimum or maximum supported width respectively; the reset width value will be reflected in the returned width property. Note that Twitter does not support the oEmbed maxheight parameter. Tweets are fundamentally text, and are therefore of unpredictable height that cannot be scaled like an image or video. Relatedly, the oEmbed response will not provide a value for height. Implementations that need consistent heights for Tweets should refer to the hide_thread and hide_media parameters below.

hideMedia

When set to true, "t", or 1 links in a Tweet are not expanded to photo, video, or link previews.

hideThread

When set to true, "t", or 1 a collapsed version of the previous Tweet in a conversation thread will not be displayed when the requested Tweet is in reply to another Tweet.

omitScript

When set to true, "t", or 1 the