tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::linkPreview Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::linkPreview:
td::td_api::Object td::TlObject

Public Member Functions

 linkPreview ()
 
 linkPreview (string const &url_, string const &display_url_, string const &site_name_, string const &title_, object_ptr< formattedText > &&description_, string const &author_, object_ptr< LinkPreviewType > &&type_, bool has_large_media_, bool show_large_media_, bool show_media_above_description_, bool skip_confirmation_, bool show_above_text_, int32 instant_view_version_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string url_
 Original URL of the link.
 
string display_url_
 URL to display.
 
string site_name_
 Short name of the site (e.g., Google Docs, App Store).
 
string title_
 Title of the content.
 
object_ptr< formattedTextdescription_
 Description of the content.
 
string author_
 Author of the content.
 
object_ptr< LinkPreviewTypetype_
 Type of the link preview.
 
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 show_media_above_description_
 True, if media must be shown above link preview description; otherwise, the media must be shown below the description.
 
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.
 
int32 instant_view_version_
 Version of instant view (currently, can be 1 or 2) for the web page; 0 if none.
 

Static Public Attributes

static const std::int32_t ID = 1729417714
 Identifier uniquely determining a type of the object.
 

Detailed Description

Describes a link preview.

Definition at line 35905 of file td_api.h.

Constructor & Destructor Documentation

◆ linkPreview() [1/2]

td::td_api::linkPreview::linkPreview ( )

Describes a link preview.

◆ linkPreview() [2/2]

td::td_api::linkPreview::linkPreview ( string const &  url_,
string const &  display_url_,
string const &  site_name_,
string const &  title_,
object_ptr< formattedText > &&  description_,
string const &  author_,
object_ptr< LinkPreviewType > &&  type_,
bool  has_large_media_,
bool  show_large_media_,
bool  show_media_above_description_,
bool  skip_confirmation_,
bool  show_above_text_,
int32  instant_view_version_ 
)

Describes a link preview.

Parameters
[in]url_Original URL of the link.
[in]display_url_URL to display.
[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]author_Author of the content.
[in]type_Type of the link preview.
[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]show_media_above_description_True, if media must be shown above link preview description; otherwise, the media must be shown below the description.
[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]instant_view_version_Version of instant view (currently, can be 1 or 2) for the web page; 0 if none.

Member Function Documentation

◆ store()

void td::td_api::linkPreview::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ author_

string td::td_api::linkPreview::author_

Author of the content.

Definition at line 35926 of file td_api.h.

◆ description_

object_ptr<formattedText> td::td_api::linkPreview::description_

Description of the content.

Definition at line 35924 of file td_api.h.

◆ display_url_

string td::td_api::linkPreview::display_url_

URL to display.

Definition at line 35918 of file td_api.h.

◆ has_large_media_

bool td::td_api::linkPreview::has_large_media_

True, if size of media in the preview can be changed.

Definition at line 35930 of file td_api.h.

◆ ID

const std::int32_t td::td_api::linkPreview::ID = 1729417714
static

Identifier uniquely determining a type of the object.

Definition at line 35967 of file td_api.h.

◆ instant_view_version_

int32 td::td_api::linkPreview::instant_view_version_

Version of instant view (currently, can be 1 or 2) for the web page; 0 if none.

Definition at line 35940 of file td_api.h.

◆ show_above_text_

bool td::td_api::linkPreview::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.

Definition at line 35938 of file td_api.h.

◆ show_large_media_

bool td::td_api::linkPreview::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.

Definition at line 35932 of file td_api.h.

◆ show_media_above_description_

bool td::td_api::linkPreview::show_media_above_description_

True, if media must be shown above link preview description; otherwise, the media must be shown below the description.

Definition at line 35934 of file td_api.h.

◆ site_name_

string td::td_api::linkPreview::site_name_

Short name of the site (e.g., Google Docs, App Store).

Definition at line 35920 of file td_api.h.

◆ skip_confirmation_

bool td::td_api::linkPreview::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.

Definition at line 35936 of file td_api.h.

◆ title_

string td::td_api::linkPreview::title_

Title of the content.

Definition at line 35922 of file td_api.h.

◆ type_

object_ptr<LinkPreviewType> td::td_api::linkPreview::type_

Type of the link preview.

Definition at line 35928 of file td_api.h.

◆ url_

string td::td_api::linkPreview::url_

Original URL of the link.

Definition at line 35916 of file td_api.h.


The documentation for this class was generated from the following file: