tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ForwardMessageArgs Struct Reference

Arguments for Api::forwardMessage. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
std::variant< std::int64_t, std::string > fromChatId { }
 Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username).
std::int32_t messageId { }
 Message identifier in the chat specified in from_chat_id.
bool disableNotification = false
 Sends the message silently. Users will receive a notification with no sound.
bool protectContent = false
 Protects the contents of the forwarded message from forwarding and saving.
std::int32_t messageThreadId = 0
 Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.
std::int64_t directMessagesTopicId = 0
 Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat.
std::string messageEffectId = ""
 Unique identifier of the message effect to be added to the message; only available when forwarding to private chats.
std::shared_ptr< SuggestedPostParameters > suggestedPostParameters = nullptr
 A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.
std::int32_t videoStartTimestamp = 0
 New start timestamp for the forwarded video in the message.

Detailed Description

Arguments for Api::forwardMessage.

Definition at line 16161 of file Types.h.

Member Data Documentation

◆ chatId

std::variant<std::int64_t, std::string> TgBot::ForwardMessageArgs::chatId { }

Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.

Definition at line 16166 of file Types.h.

◆ directMessagesTopicId

std::int64_t TgBot::ForwardMessageArgs::directMessagesTopicId = 0

Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat.

Definition at line 16204 of file Types.h.

◆ disableNotification

bool TgBot::ForwardMessageArgs::disableNotification = false

Sends the message silently. Users will receive a notification with no sound.

Definition at line 16184 of file Types.h.

◆ fromChatId

std::variant<std::int64_t, std::string> TgBot::ForwardMessageArgs::fromChatId { }

Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username).

Definition at line 16173 of file Types.h.

◆ messageEffectId

std::string TgBot::ForwardMessageArgs::messageEffectId = ""

Unique identifier of the message effect to be added to the message; only available when forwarding to private chats.

Definition at line 16210 of file Types.h.

◆ messageId

std::int32_t TgBot::ForwardMessageArgs::messageId { }

Message identifier in the chat specified in from_chat_id.

Definition at line 16178 of file Types.h.

◆ messageThreadId

std::int32_t TgBot::ForwardMessageArgs::messageThreadId = 0

Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only.

Definition at line 16197 of file Types.h.

◆ protectContent

bool TgBot::ForwardMessageArgs::protectContent = false

Protects the contents of the forwarded message from forwarding and saving.

Definition at line 16190 of file Types.h.

◆ suggestedPostParameters

std::shared_ptr<SuggestedPostParameters> TgBot::ForwardMessageArgs::suggestedPostParameters = nullptr

A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only.

Definition at line 16216 of file Types.h.

◆ videoStartTimestamp

std::int32_t TgBot::ForwardMessageArgs::videoStartTimestamp = 0

New start timestamp for the forwarded video in the message.

Definition at line 16221 of file Types.h.


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