Inherits Object.
Description
Describes a link preview.
Public Fields | |
| string | url_ |
| Original URL of the link. | |
| string | display_url_ |
| URL to display. | |
| string | type_ |
| Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else. | |
| string | site_name_ |
| Short name of the site (e.g., Google Docs, App Store). | |
| string | title_ |
| Title of the content. | |
| object_ptr< formattedText > | description_ |
| Description of the content. | |
| object_ptr< photo > | photo_ |
| Image representing the content; may be null. | |
| string | embed_url_ |
| URL to show in the embedded preview. | |
| string | embed_type_ |
| MIME type of the embedded preview, (e.g., text/html or video/mp4). | |
| int32 | embed_width_ |
| Width of the embedded preview. | |
| int32 | embed_height_ |
| Height of the embedded preview. | |
| int32 | duration_ |
| Duration of the content, in seconds. | |
| string | author_ |
| Author of the content. | |
| bool | has_large_media_ |
| True, if size of media in the preview can be changed. | |
| bool | show_large_media_ |
| True, if large media preview must be shown; otherwise, the media preview must be shown small and only the first frame must be shown for videos. | |
| bool | skip_confirmation_ |
| True, if there is no need to show an ordinary open URL confirmation, when opening the URL from the preview, because the URL is shown in the message text in clear. | |
| bool | show_above_text_ |
| True, if the link preview must be shown above message text; otherwise, the link preview must be shown below the message text. | |
| object_ptr< animation > | animation_ |
| Preview of the content as an animation, if available; may be null. | |
| object_ptr< audio > | audio_ |
| Preview of the content as an audio file, if available; may be null. | |
| object_ptr< document > | document_ |
| Preview of the content as a document, if available; may be null. | |
| object_ptr< sticker > | sticker_ |
| Preview of the content as a sticker for small WEBP files, if available; may be null. | |
| object_ptr< video > | video_ |
| Preview of the content as a video, if available; may be null. | |
| object_ptr< videoNote > | video_note_ |
| Preview of the content as a video note, if available; may be null. | |
| object_ptr< voiceNote > | voice_note_ |
| Preview of the content as a voice note, if available; may be null. | |
| int53 | story_sender_chat_id_ |
| The identifier of the sender of the previewed story; 0 if none. | |
| int32 | story_id_ |
| The identifier of the previewed story; 0 if none. | |
| array< object_ptr< sticker > > | stickers_ |
| Up to 4 stickers from the sticker set available via the link. | |
| int32 | instant_view_version_ |
| Version of web page instant view (currently, can be 1 or 2); 0 if none. | |
Public Instance Methods inherited from Static Public Attributes | |
| static const std::int32_t | ID = 594900692 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ webPage() [1/2]
| webPage | ( | ) |
Describes a link preview.
◆ webPage() [2/2]
| webPage | ( | string const & | url_, |
| string const & | display_url_, | ||
| string const & | type_, | ||
| string const & | site_name_, | ||
| string const & | title_, | ||
| object_ptr< formattedText > && | description_, | ||
| object_ptr< photo > && | photo_, | ||
| string const & | embed_url_, | ||
| string const & | embed_type_, | ||
| int32 | embed_width_, | ||
| int32 | embed_height_, | ||
| int32 | duration_, | ||
| string const & | author_, | ||
| bool | has_large_media_, | ||
| bool | show_large_media_, | ||
| bool | skip_confirmation_, | ||
| bool | show_above_text_, | ||
| object_ptr< animation > && | animation_, | ||
| object_ptr< audio > && | audio_, | ||
| object_ptr< document > && | document_, | ||
| object_ptr< sticker > && | sticker_, | ||
| object_ptr< video > && | video_, | ||
| object_ptr< videoNote > && | video_note_, | ||
| object_ptr< voiceNote > && | voice_note_, | ||
| int53 | story_sender_chat_id_, | ||
| int32 | story_id_, | ||
| array< object_ptr< sticker >> && | stickers_, | ||
| int32 | instant_view_version_ | ||
| ) |
Describes a link preview.
- Parameters
-
[in] url_ Original URL of the link. [in] display_url_ URL to display. [in] type_ Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else. [in] site_name_ Short name of the site (e.g., Google Docs, App Store). [in] title_ Title of the content. [in] description_ Description of the content. [in] photo_ Image representing the content; may be null. [in] embed_url_ URL to show in the embedded preview. [in] embed_type_ MIME type of the embedded preview, (e.g., text/html or video/mp4). [in] embed_width_ Width of the embedded preview. [in] embed_height_ Height of the embedded preview. [in] duration_ Duration of the content, in seconds. [in] author_ Author of the content. [in] has_large_media_ True, if size of media in the preview can be changed. [in] show_large_media_ True, if large media preview must be shown; otherwise, the media preview must be shown small and only the first frame must be shown for videos. [in] skip_confirmation_ True, if there is no need to show an ordinary open URL confirmation, when opening the URL from the preview, because the URL is shown in the message text in clear. [in] show_above_text_ True, if the link preview must be shown above message text; otherwise, the link preview must be shown below the message text. [in] animation_ Preview of the content as an animation, if available; may be null. [in] audio_ Preview of the content as an audio file, if available; may be null. [in] document_ Preview of the content as a document, if available; may be null. [in] sticker_ Preview of the content as a sticker for small WEBP files, if available; may be null. [in] video_ Preview of the content as a video, if available; may be null. [in] video_note_ Preview of the content as a video note, if available; may be null. [in] voice_note_ Preview of the content as a voice note, if available; may be null. [in] story_sender_chat_id_ The identifier of the sender of the previewed story; 0 if none. [in] story_id_ The identifier of the previewed story; 0 if none. [in] stickers_ Up to 4 stickers from the sticker set available via the link. [in] instant_view_version_ Version of web page instant view (currently, can be 1 or 2); 0 if none.
Method Documentation
◆ store()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h