webPage Class Reference

Inherits Object.

Description

Describes a web page 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.
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.
int32	instant_view_version_
	Version of instant view, available for the web page (currently, can be 1 or 2), 0 if none.

Public Instance Methods
	webPage ()
	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_, 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_, int32 instant_view_version_)
std::int32_t	get_id () const final
void	store (TlStorerToString &s, const char *field_name) const final
Public Instance Methods inherited from TlObject
virtual void	store (TlStorerUnsafe &s) const
virtual void	store (TlStorerCalcLength &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Static Public Attributes
static const std::int32_t	ID = -577333714
	Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

webPage() [1/2]

webPage

(

)

Describes a web page 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_,
		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_,
		int32	instant_view_version_
	)

Describes a web page 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]	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]	instant_view_version_	Version of instant view, available for the web page (currently, can be 1 or 2), 0 if none.

Method Documentation

get_id()

std::int32_t get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements TlObject.

store()

void 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h