From f13b7029e9af43282ebe6c2e9bb4dd749c8e450a Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Mon, 23 Jul 2018 02:09:18 +0300 Subject: Move docs to gh-pages branch --- docs/class_tg_bot_1_1_message.html | 945 ------------------------------------- 1 file changed, 945 deletions(-) delete mode 100644 docs/class_tg_bot_1_1_message.html (limited to 'docs/class_tg_bot_1_1_message.html') diff --git a/docs/class_tg_bot_1_1_message.html b/docs/class_tg_bot_1_1_message.html deleted file mode 100644 index 3a13aa9..0000000 --- a/docs/class_tg_bot_1_1_message.html +++ /dev/null @@ -1,945 +0,0 @@ - - - - - - -tgbot-cpp: TgBot::Message Class Reference - - - - - - - - - - - - - - - -
-
- - - - - - -
-
tgbot-cpp -
-
-
- - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
-Public Types | -Public Attributes | -List of all members
-
-
TgBot::Message Class Reference
Types
-
-
- -

This object represents a message. - More...

- -

#include <Message.h>

- - - - -

-Public Types

typedef std::shared_ptr< Message > Ptr
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Attributes

int32_t messageId
 Unique message identifier. More...
 
User::Ptr from
 Optional. Sender, can be empty for messages sent to channels. More...
 
int32_t date
 Date the message was sent in Unix time. More...
 
Chat::Ptr chat
 Conversation the message belongs to. More...
 
User::Ptr forwardFrom
 Optional. For forwarded messages, sender of the original message. More...
 
Chat::Ptr forwardFromChat
 Optional. For messages forwarded from a channel, information about the original channel. More...
 
int32_t forwardFromMessageId
 Optional. For forwarded channel posts, identifier of the original message in the channel. More...
 
std::string forwardSignature
 Optional. For messages forwarded from channels, signature of the post author if present. More...
 
int32_t forwardDate
 Optional. For forwarded messages, date the original message was sent in Unix time. More...
 
Message::Ptr replyToMessage
 Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. More...
 
int32_t editDate
 Optional. Date the message was last edited in Unix time. More...
 
std::string authorSignature
 Optional. Signature of the post author for messages in channels. More...
 
std::string text
 Optional. For text messages, the actual UTF-8 text of the message. More...
 
std::vector< MessageEntity::Ptr > entities
 Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text. More...
 
std::vector< MessageEntity::Ptr > captionEntities
 Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption. More...
 
Audio::Ptr audio
 Optional. Message is an audio file, information about the file. More...
 
Document::Ptr document
 Optional. Message is a general file, information about the file. More...
 
Game::Ptr game
 Optional. Message is a game, information about the game. More...
 
std::vector< PhotoSize::Ptr > photo
 Optional. Message is a photo, available sizes of the photo. More...
 
Sticker::Ptr sticker
 Optional. Message is a sticker, information about the sticker. More...
 
Video::Ptr video
 Optional. Message is a video, information about the video. More...
 
Voice::Ptr voice
 Optional. Message is a voice message, information about the file. More...
 
std::string caption
 Optional. Caption for the document, photo or video, 0-200 characters. More...
 
Contact::Ptr contact
 Optional. Message is a shared contact, information about the contact. More...
 
Location::Ptr location
 Optional. Message is a shared location, information about the location. More...
 
Venue::Ptr venue
 Optional. Message is a venue, information about the venue. More...
 
User::Ptr newChatMember
 Optional. A new member was added to the group, information about them (this member may be bot itself). More...
 
std::vector< User::Ptr > newChatMembers
 Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) More...
 
User::Ptr leftChatMember
 Optional. A member was removed from the group, information about them (this member may be bot itself). More...
 
std::string newChatTitle
 Optional. A group title was changed to this value. More...
 
std::vector< PhotoSize::Ptr > newChatPhoto
 Optional. A group photo was change to this value. More...
 
bool deleteChatPhoto = false
 Optional. Informs that the group photo was deleted. More...
 
bool groupChatCreated = false
 Optional. Informs that the group has been created. More...
 
bool supergroupChatCreated = false
 Optional. Service message: the supergroup has been created. More...
 
bool channelChatCreated = false
 Optional. Service message: the channel has been created. More...
 
int64_t migrateToChatId = 0
 Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value. More...
 
int64_t migrateFromChatId = 0
 Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value. More...
 
Message::Ptr pinnedMessage
 Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply. More...
 
Invoice::Ptr invoice
 Optional. Message is an invoice for a payment, information about the invoice. More...
 
SuccessfulPayment::Ptr successfulPayment
 Optional. Message is a service message about a successful payment, information about the payment. More...
 
std::string connectedWebsite
 Optional. The domain name of the website on which the user has logged in. More...
 
-

Detailed Description

-

This object represents a message.

- -

Definition at line 54 of file Message.h.

-

Member Typedef Documentation

- -
-
- - - - -
typedef std::shared_ptr<Message> TgBot::Message::Ptr
-
- -

Definition at line 56 of file Message.h.

- -
-
-

Member Data Documentation

- -
-
- - - - -
Audio::Ptr TgBot::Message::audio
-
- -

Optional. Message is an audio file, information about the file.

- -

Definition at line 136 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::authorSignature
-
- -

Optional. Signature of the post author for messages in channels.

- -

Definition at line 116 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::caption
-
- -

Optional. Caption for the document, photo or video, 0-200 characters.

- -

Definition at line 171 of file Message.h.

- -
-
- -
-
- - - - -
std::vector<MessageEntity::Ptr> TgBot::Message::captionEntities
-
- -

Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption.

- -

Definition at line 131 of file Message.h.

- -
-
- -
-
- - - - -
bool TgBot::Message::channelChatCreated = false
-
- -

Optional. Service message: the channel has been created.

- -

Definition at line 231 of file Message.h.

- -
-
- -
-
- - - - -
Chat::Ptr TgBot::Message::chat
-
- -

Conversation the message belongs to.

- -

Definition at line 76 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::connectedWebsite
-
- -

Optional. The domain name of the website on which the user has logged in.

- -

Definition at line 261 of file Message.h.

- -
-
- -
-
- - - - -
Contact::Ptr TgBot::Message::contact
-
- -

Optional. Message is a shared contact, information about the contact.

- -

Definition at line 176 of file Message.h.

- -
-
- -
-
- - - - -
int32_t TgBot::Message::date
-
- -

Date the message was sent in Unix time.

- -

Definition at line 71 of file Message.h.

- -
-
- -
-
- - - - -
bool TgBot::Message::deleteChatPhoto = false
-
- -

Optional. Informs that the group photo was deleted.

- -

Definition at line 216 of file Message.h.

- -
-
- -
-
- - - - -
Document::Ptr TgBot::Message::document
-
- -

Optional. Message is a general file, information about the file.

- -

Definition at line 141 of file Message.h.

- -
-
- -
-
- - - - -
int32_t TgBot::Message::editDate
-
- -

Optional. Date the message was last edited in Unix time.

- -

Definition at line 111 of file Message.h.

- -
-
- -
-
- - - - -
std::vector<MessageEntity::Ptr> TgBot::Message::entities
-
- -

Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.

- -

Definition at line 126 of file Message.h.

- -
-
- -
-
- - - - -
int32_t TgBot::Message::forwardDate
-
- -

Optional. For forwarded messages, date the original message was sent in Unix time.

- -

Definition at line 101 of file Message.h.

- -
-
- -
-
- - - - -
User::Ptr TgBot::Message::forwardFrom
-
- -

Optional. For forwarded messages, sender of the original message.

- -

Definition at line 81 of file Message.h.

- -
-
- -
-
- - - - -
Chat::Ptr TgBot::Message::forwardFromChat
-
- -

Optional. For messages forwarded from a channel, information about the original channel.

- -

Definition at line 86 of file Message.h.

- -
-
- -
-
- - - - -
int32_t TgBot::Message::forwardFromMessageId
-
- -

Optional. For forwarded channel posts, identifier of the original message in the channel.

- -

Definition at line 91 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::forwardSignature
-
- -

Optional. For messages forwarded from channels, signature of the post author if present.

- -

Definition at line 96 of file Message.h.

- -
-
- -
-
- - - - -
User::Ptr TgBot::Message::from
-
- -

Optional. Sender, can be empty for messages sent to channels.

- -

Definition at line 66 of file Message.h.

- -
-
- -
-
- - - - -
Game::Ptr TgBot::Message::game
-
- -

Optional. Message is a game, information about the game.

- -

Definition at line 146 of file Message.h.

- -
-
- -
-
- - - - -
bool TgBot::Message::groupChatCreated = false
-
- -

Optional. Informs that the group has been created.

- -

Definition at line 221 of file Message.h.

- -
-
- -
-
- - - - -
Invoice::Ptr TgBot::Message::invoice
-
- -

Optional. Message is an invoice for a payment, information about the invoice.

- -

Definition at line 251 of file Message.h.

- -
-
- -
-
- - - - -
User::Ptr TgBot::Message::leftChatMember
-
- -

Optional. A member was removed from the group, information about them (this member may be bot itself).

- -

Definition at line 201 of file Message.h.

- -
-
- -
-
- - - - -
Location::Ptr TgBot::Message::location
-
- -

Optional. Message is a shared location, information about the location.

- -

Definition at line 181 of file Message.h.

- -
-
- -
-
- - - - -
int32_t TgBot::Message::messageId
-
- -

Unique message identifier.

- -

Definition at line 61 of file Message.h.

- -
-
- -
-
- - - - -
int64_t TgBot::Message::migrateFromChatId = 0
-
- -

Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value.

- -

Definition at line 241 of file Message.h.

- -
-
- -
-
- - - - -
int64_t TgBot::Message::migrateToChatId = 0
-
- -

Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value.

- -

Definition at line 236 of file Message.h.

- -
-
- -
-
- - - - -
User::Ptr TgBot::Message::newChatMember
-
- -

Optional. A new member was added to the group, information about them (this member may be bot itself).

- -

Definition at line 191 of file Message.h.

- -
-
- -
-
- - - - -
std::vector<User::Ptr> TgBot::Message::newChatMembers
-
- -

Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)

- -

Definition at line 196 of file Message.h.

- -
-
- -
-
- - - - -
std::vector<PhotoSize::Ptr> TgBot::Message::newChatPhoto
-
- -

Optional. A group photo was change to this value.

- -

Definition at line 211 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::newChatTitle
-
- -

Optional. A group title was changed to this value.

- -

Definition at line 206 of file Message.h.

- -
-
- -
-
- - - - -
std::vector<PhotoSize::Ptr> TgBot::Message::photo
-
- -

Optional. Message is a photo, available sizes of the photo.

- -

Definition at line 151 of file Message.h.

- -
-
- -
-
- - - - -
Message::Ptr TgBot::Message::pinnedMessage
-
- -

Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.

- -

Definition at line 246 of file Message.h.

- -
-
- -
-
- - - - -
Message::Ptr TgBot::Message::replyToMessage
-
- -

Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.

- -

Definition at line 106 of file Message.h.

- -
-
- -
-
- - - - -
Sticker::Ptr TgBot::Message::sticker
-
- -

Optional. Message is a sticker, information about the sticker.

- -

Definition at line 156 of file Message.h.

- -
-
- -
-
- - - - -
SuccessfulPayment::Ptr TgBot::Message::successfulPayment
-
- -

Optional. Message is a service message about a successful payment, information about the payment.

- -

Definition at line 256 of file Message.h.

- -
-
- -
-
- - - - -
bool TgBot::Message::supergroupChatCreated = false
-
- -

Optional. Service message: the supergroup has been created.

- -

Definition at line 226 of file Message.h.

- -
-
- -
-
- - - - -
std::string TgBot::Message::text
-
- -

Optional. For text messages, the actual UTF-8 text of the message.

- -

Definition at line 121 of file Message.h.

- -
-
- -
-
- - - - -
Venue::Ptr TgBot::Message::venue
-
- -

Optional. Message is a venue, information about the venue.

- -

Definition at line 186 of file Message.h.

- -
-
- -
-
- - - - -
Video::Ptr TgBot::Message::video
-
- -

Optional. Message is a video, information about the video.

- -

Definition at line 161 of file Message.h.

- -
-
- -
-
- - - - -
Voice::Ptr TgBot::Message::voice
-
- -

Optional. Message is a voice message, information about the file.

- -

Definition at line 166 of file Message.h.

- -
-
-
The documentation for this class was generated from the following file: -
-
- - - - -- cgit v1.2.3