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

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<LinkPreviewOptions>

Public Attributes
std::optional< bool >	isDisabled { }
	Optional. True, if the link preview is disabled.
std::optional< std::string >	url { }
	Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used.
std::optional< 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.
std::optional< 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.
std::optional< 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 8523 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::LinkPreviewOptions::Ptr = std::shared_ptr<LinkPreviewOptions>

Definition at line 8524 of file Types.h.

Member Data Documentation

◆ isDisabled

std::optional<bool> TgBot::LinkPreviewOptions::isDisabled { }

Optional. True, if the link preview is disabled.

Definition at line 8529 of file Types.h.

◆ preferLargeMedia

std::optional<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 8547 of file Types.h.

◆ preferSmallMedia

std::optional<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 8541 of file Types.h.

◆ showAboveText

std::optional<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 8553 of file Types.h.

◆ url

std::optional<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 8535 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes