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::linkPreviewOptions Class Referencefinal

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

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

Public Member Functions

 linkPreviewOptions ()
 
 linkPreviewOptions (bool is_disabled_, string const &url_, bool force_small_media_, bool force_large_media_, bool show_above_text_)
 
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

bool is_disabled_
 True, if link preview must be disabled.
 
string url_
 URL to use for link preview. If empty, then the first URL found in the message text will be used.
 
bool force_small_media_
 True, if shown media preview must be small; ignored in secret chats or if the URL isn&#x27;t explicitly specified.
 
bool force_large_media_
 True, if shown media preview must be large; ignored in secret chats or if the URL isn&#x27;t explicitly specified.
 
bool show_above_text_
 True, if link preview must be shown above message text; otherwise, the link preview will be shown below the message text; ignored in secret chats.
 

Static Public Attributes

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

Detailed Description

Options to be used for generation of a link preview.

Definition at line 36070 of file td_api.h.

Constructor & Destructor Documentation

◆ linkPreviewOptions() [1/2]

td::td_api::linkPreviewOptions::linkPreviewOptions ( )

Options to be used for generation of a link preview.

◆ linkPreviewOptions() [2/2]

td::td_api::linkPreviewOptions::linkPreviewOptions ( bool  is_disabled_,
string const &  url_,
bool  force_small_media_,
bool  force_large_media_,
bool  show_above_text_ 
)

Options to be used for generation of a link preview.

Parameters
[in]is_disabled_True, if link preview must be disabled.
[in]url_URL to use for link preview. If empty, then the first URL found in the message text will be used.
[in]force_small_media_True, if shown media preview must be small; ignored in secret chats or if the URL isn&#x27;t explicitly specified.
[in]force_large_media_True, if shown media preview must be large; ignored in secret chats or if the URL isn&#x27;t explicitly specified.
[in]show_above_text_True, if link preview must be shown above message text; otherwise, the link preview will be shown below the message text; ignored in secret chats.

Member Function Documentation

◆ store()

void td::td_api::linkPreviewOptions::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

◆ force_large_media_

bool td::td_api::linkPreviewOptions::force_large_media_

True, if shown media preview must be large; ignored in secret chats or if the URL isn&#x27;t explicitly specified.

Definition at line 36087 of file td_api.h.

◆ force_small_media_

bool td::td_api::linkPreviewOptions::force_small_media_

True, if shown media preview must be small; ignored in secret chats or if the URL isn&#x27;t explicitly specified.

Definition at line 36085 of file td_api.h.

◆ ID

const std::int32_t td::td_api::linkPreviewOptions::ID = 1046590451
static

Identifier uniquely determining a type of the object.

Definition at line 36108 of file td_api.h.

◆ is_disabled_

bool td::td_api::linkPreviewOptions::is_disabled_

True, if link preview must be disabled.

Definition at line 36081 of file td_api.h.

◆ show_above_text_

bool td::td_api::linkPreviewOptions::show_above_text_

True, if link preview must be shown above message text; otherwise, the link preview will be shown below the message text; ignored in secret chats.

Definition at line 36089 of file td_api.h.

◆ url_

string td::td_api::linkPreviewOptions::url_

URL to use for link preview. If empty, then the first URL found in the message text will be used.

Definition at line 36083 of file td_api.h.


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