Describes the options used for link preview generation. More...

#include <LinkPreviewOptions.h>

Public Types
typedef std::shared_ptr< LinkPreviewOptions >	Ptr

Public Attributes
bool	isDisabled
	Optional. True, if the link preview is disabled.

std::string	url
	Optional. URL to use for the link preview.

bool	preferSmallMedia
	Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

bool	preferLargeMedia
	Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

bool	showAboveText
	Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text.

Detailed Description

Describes the options used for link preview generation.

Definition at line 14 of file LinkPreviewOptions.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<LinkPreviewOptions> TgBot::LinkPreviewOptions::Ptr

Definition at line 17 of file LinkPreviewOptions.h.

Member Data Documentation

◆ isDisabled

bool TgBot::LinkPreviewOptions::isDisabled

Optional. True, if the link preview is disabled.

Definition at line 22 of file LinkPreviewOptions.h.

◆ preferLargeMedia

bool TgBot::LinkPreviewOptions::preferLargeMedia

Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

Definition at line 39 of file LinkPreviewOptions.h.

◆ preferSmallMedia

bool TgBot::LinkPreviewOptions::preferSmallMedia

Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

Definition at line 34 of file LinkPreviewOptions.h.

◆ showAboveText

bool TgBot::LinkPreviewOptions::showAboveText

Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text.

Definition at line 44 of file LinkPreviewOptions.h.

◆ url

std::string TgBot::LinkPreviewOptions::url

Optional. URL to use for the link preview.

If empty, then the first URL found in the message text will be used

Definition at line 29 of file LinkPreviewOptions.h.

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

include/tgbot/types/LinkPreviewOptions.h

Public Types

Public Attributes