From c8d40dccabaaa406faed6c0797a92bac811c9d0f Mon Sep 17 00:00:00 2001 From: Oleg Morozenkov Date: Tue, 5 Jun 2018 19:07:27 +0300 Subject: Update docs --- docs/_message_8h_source.html | 107 ++++++++++++++++++++++--------------------- 1 file changed, 55 insertions(+), 52 deletions(-) (limited to 'docs/_message_8h_source.html') diff --git a/docs/_message_8h_source.html b/docs/_message_8h_source.html index 75cac4f..5ca2df2 100644 --- a/docs/_message_8h_source.html +++ b/docs/_message_8h_source.html @@ -83,70 +83,73 @@ $(document).ready(function(){initNavTree('_message_8h_source.html','');});
Message.h
-Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Oleg Morozenkov
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 
23 #ifndef TGBOT_CPP_MESSAGE_H
24 #define TGBOT_CPP_MESSAGE_H
25 
26 #include <string>
27 #include <vector>
28 #include <memory>
29 
30 #include "tgbot/types/Chat.h"
31 #include "tgbot/types/User.h"
32 #include "tgbot/types/Message.h"
33 #include "tgbot/types/Audio.h"
34 #include "tgbot/types/Document.h"
35 #include "tgbot/types/Sticker.h"
36 #include "tgbot/types/Video.h"
37 #include "tgbot/types/Contact.h"
38 #include "tgbot/types/Location.h"
39 #include "tgbot/types/PhotoSize.h"
40 #include "tgbot/types/MessageEntity.h"
41 #include "tgbot/types/Venue.h"
42 #include "tgbot/types/Voice.h"
43 
44 namespace TgBot {
45 
50 class Message {
51 public:
52  typedef std::shared_ptr<Message> Ptr;
53 
54  Message(){
55  deleteChatPhoto = false;
56  groupChatCreated = false;
57  supergroupChatCreated = false;
58  channelChatCreated = false;
59  migrateToChatId = 0;
60  migrateFromChatId = 0;
61  }
62 
66  int32_t messageId;
67 
71  User::Ptr from;
72 
76  int32_t date;
77 
81  Chat::Ptr chat;
82 
86  User::Ptr forwardFrom;
87 
91  Chat::Ptr forwardFromChat;
92 
96  int32_t forwardFromMessageId;
97 
101  std::string forwardSignature;
102 
106  int32_t forwardDate;
107 
111  Message::Ptr replyToMessage;
112 
116  int32_t editDate;
117 
121  std::string authorSignature;
122 
126  std::string text;
127 
131  std::vector<MessageEntity::Ptr> entities;
132 
136  std::vector<MessageEntity::Ptr> captionEntities;
137 
141  Audio::Ptr audio;
142 
146  Document::Ptr document;
147 
151  std::vector<PhotoSize::Ptr> photo;
152 
156  Sticker::Ptr sticker;
157 
161  Video::Ptr video;
162 
166  Voice::Ptr voice;
167 
171  std::string caption;
172 
176  Contact::Ptr contact;
177 
181  Location::Ptr location;
182 
186  Venue::Ptr venue;
187 
191  User::Ptr newChatMember;
192 
196  std::vector<User::Ptr> newChatMembers;
197 
201  User::Ptr leftChatMember;
202 
206  std::string newChatTitle;
207 
211  std::vector<PhotoSize::Ptr> newChatPhoto;
212 
216  bool deleteChatPhoto;
217 
221  bool groupChatCreated;
222 
226  bool supergroupChatCreated;
227 
231  bool channelChatCreated;
232 
236  int64_t migrateToChatId;
237 
241  int64_t migrateFromChatId;
242 
246  Message::Ptr pinnedMessage;
247 
251  std::string connectedWebsite;
252 };
253 
254 }
255 
256 #endif //TGBOT_CPP_MESSAGE_H
TgBot::Message::channelChatCreated
bool channelChatCreated
Definition: Message.h:231
-
TgBot::Message::migrateToChatId
int64_t migrateToChatId
Definition: Message.h:236
+Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Oleg Morozenkov
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in all
12  * copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  */
22 
23 #ifndef TGBOT_CPP_MESSAGE_H
24 #define TGBOT_CPP_MESSAGE_H
25 
26 #include <string>
27 #include <vector>
28 #include <memory>
29 
30 #include "tgbot/types/Chat.h"
31 #include "tgbot/types/User.h"
32 #include "tgbot/types/Message.h"
33 #include "tgbot/types/Audio.h"
34 #include "tgbot/types/Document.h"
35 #include "tgbot/types/Sticker.h"
36 #include "tgbot/types/Video.h"
37 #include "tgbot/types/Contact.h"
38 #include "tgbot/types/Location.h"
39 #include "tgbot/types/Game.h"
40 #include "tgbot/types/PhotoSize.h"
41 #include "tgbot/types/MessageEntity.h"
42 #include "tgbot/types/Venue.h"
43 #include "tgbot/types/Voice.h"
44 
45 namespace TgBot {
46 
52 class Message {
53 public:
54  typedef std::shared_ptr<Message> Ptr;
55 
56  Message(){
57  deleteChatPhoto = false;
58  groupChatCreated = false;
59  supergroupChatCreated = false;
60  channelChatCreated = false;
61  migrateToChatId = 0;
62  migrateFromChatId = 0;
63  }
64 
68  int32_t messageId;
69 
73  User::Ptr from;
74 
78  int32_t date;
79 
83  Chat::Ptr chat;
84 
88  User::Ptr forwardFrom;
89 
93  Chat::Ptr forwardFromChat;
94 
98  int32_t forwardFromMessageId;
99 
103  std::string forwardSignature;
104 
108  int32_t forwardDate;
109 
113  Message::Ptr replyToMessage;
114 
118  int32_t editDate;
119 
123  std::string authorSignature;
124 
128  std::string text;
129 
133  std::vector<MessageEntity::Ptr> entities;
134 
138  std::vector<MessageEntity::Ptr> captionEntities;
139 
143  Audio::Ptr audio;
144 
148  Document::Ptr document;
149 
153  Game::Ptr game;
154 
158  std::vector<PhotoSize::Ptr> photo;
159 
163  Sticker::Ptr sticker;
164 
168  Video::Ptr video;
169 
173  Voice::Ptr voice;
174 
178  std::string caption;
179 
183  Contact::Ptr contact;
184 
188  Location::Ptr location;
189 
193  Venue::Ptr venue;
194 
198  User::Ptr newChatMember;
199 
203  std::vector<User::Ptr> newChatMembers;
204 
208  User::Ptr leftChatMember;
209 
213  std::string newChatTitle;
214 
218  std::vector<PhotoSize::Ptr> newChatPhoto;
219 
223  bool deleteChatPhoto;
224 
228  bool groupChatCreated;
229 
233  bool supergroupChatCreated;
234 
238  bool channelChatCreated;
239 
243  int64_t migrateToChatId;
244 
248  int64_t migrateFromChatId;
249 
253  Message::Ptr pinnedMessage;
254 
258  std::string connectedWebsite;
259 };
260 
261 }
262 
263 #endif //TGBOT_CPP_MESSAGE_H
TgBot::Message::channelChatCreated
bool channelChatCreated
Optional. Service message: the channel has been created.
Definition: Message.h:238
+
TgBot::Message::migrateToChatId
int64_t migrateToChatId
Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value.
Definition: Message.h:243
PhotoSize.h
-
TgBot::Sticker::Ptr
std::shared_ptr< Sticker > Ptr
Definition: Sticker.h:41
-
TgBot::Message::supergroupChatCreated
bool supergroupChatCreated
Definition: Message.h:226
+
TgBot::Sticker::Ptr
std::shared_ptr< Sticker > Ptr
Definition: Sticker.h:42
+
TgBot::Message::supergroupChatCreated
bool supergroupChatCreated
Optional. Service message: the supergroup has been created.
Definition: Message.h:233
Sticker.h
-
TgBot::Audio::Ptr
std::shared_ptr< Audio > Ptr
Definition: Audio.h:38
-
TgBot::Message::forwardFrom
User::Ptr forwardFrom
Definition: Message.h:86
-
TgBot::Message::entities
std::vector< MessageEntity::Ptr > entities
Definition: Message.h:131
-
TgBot::Message::caption
std::string caption
Definition: Message.h:171
+
TgBot::Audio::Ptr
std::shared_ptr< Audio > Ptr
Definition: Audio.h:39
+
TgBot::Message::forwardFrom
User::Ptr forwardFrom
Optional. For forwarded messages, sender of the original message.
Definition: Message.h:88
+
TgBot::Message::entities
std::vector< MessageEntity::Ptr > entities
Optional. For text messages, special entities like usernames, URLs, bot commands, etc...
Definition: Message.h:133
+
TgBot::Message::caption
std::string caption
Optional. Caption for the document, photo or video, 0-200 characters.
Definition: Message.h:178
MessageEntity.h
Video.h
-
TgBot::Message::leftChatMember
User::Ptr leftChatMember
Definition: Message.h:201
-
TgBot::Message::text
std::string text
Definition: Message.h:126
-
TgBot
Definition: Api.h:46
-
TgBot::Message::video
Video::Ptr video
Definition: Message.h:161
-
TgBot::Message::pinnedMessage
Message::Ptr pinnedMessage
Definition: Message.h:246
-
TgBot::Message::chat
Chat::Ptr chat
Definition: Message.h:81
+
TgBot::Message::leftChatMember
User::Ptr leftChatMember
Optional. A member was removed from the group, information about them (this member may be bot itself)...
Definition: Message.h:208
+
TgBot::Message::text
std::string text
Optional. For text messages, the actual UTF-8 text of the message.
Definition: Message.h:128
+
TgBot
Definition: Api.h:47
+
TgBot::Game::Ptr
std::shared_ptr< Game > Ptr
Definition: Game.h:46
+
TgBot::Message::video
Video::Ptr video
Optional. Message is a video, information about the video.
Definition: Message.h:168
+
TgBot::Message::pinnedMessage
Message::Ptr pinnedMessage
Optional. Specified message was pinned. Note that the Message object in this field will not contain f...
Definition: Message.h:253
+
TgBot::Message::chat
Chat::Ptr chat
Conversation the message belongs to.
Definition: Message.h:83
Document.h
-
TgBot::Message::groupChatCreated
bool groupChatCreated
Definition: Message.h:221
-
TgBot::Message::newChatPhoto
std::vector< PhotoSize::Ptr > newChatPhoto
Definition: Message.h:211
-
TgBot::Message::Ptr
std::shared_ptr< Message > Ptr
Definition: Message.h:52
-
TgBot::Message::photo
std::vector< PhotoSize::Ptr > photo
Definition: Message.h:151
-
TgBot::Message::forwardSignature
std::string forwardSignature
Definition: Message.h:101
-
TgBot::Location::Ptr
std::shared_ptr< Location > Ptr
Definition: Location.h:37
-
TgBot::Message::newChatMembers
std::vector< User::Ptr > newChatMembers
Definition: Message.h:196
-
TgBot::Message::sticker
Sticker::Ptr sticker
Definition: Message.h:156
-
TgBot::Message::migrateFromChatId
int64_t migrateFromChatId
Definition: Message.h:241
-
TgBot::Message::document
Document::Ptr document
Definition: Message.h:146
-
TgBot::Message::editDate
int32_t editDate
Definition: Message.h:116
-
TgBot::Message::forwardFromChat
Chat::Ptr forwardFromChat
Definition: Message.h:91
-
TgBot::Message::venue
Venue::Ptr venue
Definition: Message.h:186
-
TgBot::Message::forwardFromMessageId
int32_t forwardFromMessageId
Definition: Message.h:96
+
TgBot::Message::groupChatCreated
bool groupChatCreated
Optional. Informs that the group has been created.
Definition: Message.h:228
+
TgBot::Message::game
Game::Ptr game
Optional. Message is a game, information about the game.
Definition: Message.h:153
+
TgBot::Message::newChatPhoto
std::vector< PhotoSize::Ptr > newChatPhoto
Optional. A group photo was change to this value.
Definition: Message.h:218
+
TgBot::Message::Ptr
std::shared_ptr< Message > Ptr
Definition: Message.h:54
+
TgBot::Message::photo
std::vector< PhotoSize::Ptr > photo
Optional. Message is a photo, available sizes of the photo.
Definition: Message.h:158
+
TgBot::Message::forwardSignature
std::string forwardSignature
Optional. For messages forwarded from channels, signature of the post author if present.
Definition: Message.h:103
+
TgBot::Location::Ptr
std::shared_ptr< Location > Ptr
Definition: Location.h:38
+
TgBot::Message::newChatMembers
std::vector< User::Ptr > newChatMembers
Optional. New members that were added to the group or supergroup and information about them (the bot ...
Definition: Message.h:203
+
TgBot::Message::sticker
Sticker::Ptr sticker
Optional. Message is a sticker, information about the sticker.
Definition: Message.h:163
+
TgBot::Message::migrateFromChatId
int64_t migrateFromChatId
Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value.
Definition: Message.h:248
+
TgBot::Message::document
Document::Ptr document
Optional. Message is a general file, information about the file.
Definition: Message.h:148
+
TgBot::Message::editDate
int32_t editDate
Optional. Date the message was last edited in Unix time.
Definition: Message.h:118
+
TgBot::Message::forwardFromChat
Chat::Ptr forwardFromChat
Optional. For messages forwarded from a channel, information about the original channel.
Definition: Message.h:93
+
TgBot::Message::venue
Venue::Ptr venue
Optional. Message is a venue, information about the venue.
Definition: Message.h:193
+
TgBot::Message::forwardFromMessageId
int32_t forwardFromMessageId
Optional. For forwarded channel posts, identifier of the original message in the channel.
Definition: Message.h:98
Venue.h
-
TgBot::Message::newChatTitle
std::string newChatTitle
Definition: Message.h:206
-
TgBot::Message::contact
Contact::Ptr contact
Definition: Message.h:176
-
TgBot::Message::captionEntities
std::vector< MessageEntity::Ptr > captionEntities
Definition: Message.h:136
-
TgBot::Message::audio
Audio::Ptr audio
Definition: Message.h:141
-
TgBot::Document::Ptr
std::shared_ptr< Document > Ptr
Definition: Document.h:40
+
TgBot::Message::newChatTitle
std::string newChatTitle
Optional. A group title was changed to this value.
Definition: Message.h:213
+
TgBot::Message::contact
Contact::Ptr contact
Optional. Message is a shared contact, information about the contact.
Definition: Message.h:183
+
TgBot::Message::captionEntities
std::vector< MessageEntity::Ptr > captionEntities
Optional. For messages with a caption, special entities like usernames, URLs, bot commands...
Definition: Message.h:138
+
TgBot::Message::audio
Audio::Ptr audio
Optional. Message is an audio file, information about the file.
Definition: Message.h:143
+
TgBot::Document::Ptr
std::shared_ptr< Document > Ptr
Definition: Document.h:41
TgBot::Chat::Ptr
std::shared_ptr< Chat > Ptr
Definition: Chat.h:41
-
TgBot::Message::forwardDate
int32_t forwardDate
Definition: Message.h:106
-
TgBot::Message::messageId
int32_t messageId
Definition: Message.h:66
-
TgBot::Message::replyToMessage
Message::Ptr replyToMessage
Definition: Message.h:111
-
TgBot::Voice::Ptr
std::shared_ptr< Voice > Ptr
Definition: Voice.h:19
-
TgBot::Message::from
User::Ptr from
Definition: Message.h:71
-
TgBot::Message::deleteChatPhoto
bool deleteChatPhoto
Definition: Message.h:216
-
TgBot::Message::connectedWebsite
std::string connectedWebsite
Definition: Message.h:251
-
TgBot::Message::location
Location::Ptr location
Definition: Message.h:181
+
TgBot::Message::forwardDate
int32_t forwardDate
Optional. For forwarded messages, date the original message was sent in Unix time.
Definition: Message.h:108
+
TgBot::Message::messageId
int32_t messageId
Unique message identifier.
Definition: Message.h:68
+
TgBot::Message::replyToMessage
Message::Ptr replyToMessage
Optional. For replies, the original message. Note that the Message object in this field will not cont...
Definition: Message.h:113
+
TgBot::Voice::Ptr
std::shared_ptr< Voice > Ptr
Definition: Voice.h:20
+
TgBot::Message::from
User::Ptr from
Optional. Sender, can be empty for messages sent to channels.
Definition: Message.h:73
+
TgBot::Message::deleteChatPhoto
bool deleteChatPhoto
Optional. Informs that the group photo was deleted.
Definition: Message.h:223
+
TgBot::Message::connectedWebsite
std::string connectedWebsite
Optional. The domain name of the website on which the user has logged in.
Definition: Message.h:258
+
TgBot::Message::location
Location::Ptr location
Optional. Message is a shared location, information about the location.
Definition: Message.h:188
Location.h
-
TgBot::Video::Ptr
std::shared_ptr< Video > Ptr
Definition: Video.h:40
-
TgBot::Contact::Ptr
std::shared_ptr< Contact > Ptr
Definition: Contact.h:38
- -
TgBot::Message::authorSignature
std::string authorSignature
Definition: Message.h:121
+
TgBot::Video::Ptr
std::shared_ptr< Video > Ptr
Definition: Video.h:41
+
TgBot::Contact::Ptr
std::shared_ptr< Contact > Ptr
Definition: Contact.h:39
+ +
TgBot::Message::authorSignature
std::string authorSignature
Optional. Signature of the post author for messages in channels.
Definition: Message.h:123
User.h
Voice.h
Audio.h
-
TgBot::Venue::Ptr
std::shared_ptr< Venue > Ptr
Definition: Venue.h:21
+
TgBot::Venue::Ptr
std::shared_ptr< Venue > Ptr
Definition: Venue.h:22
Chat.h
Contact.h
-
TgBot::Message::date
int32_t date
Definition: Message.h:76
-
TgBot::Message::newChatMember
User::Ptr newChatMember
Definition: Message.h:191
- -
TgBot::Message::voice
Voice::Ptr voice
Definition: Message.h:166
-
TgBot::User::Ptr
std::shared_ptr< User > Ptr
Definition: User.h:38
+
TgBot::Message::date
int32_t date
Date the message was sent in Unix time.
Definition: Message.h:78
+
Game.h
+
TgBot::Message::newChatMember
User::Ptr newChatMember
Optional. A new member was added to the group, information about them (this member may be bot itself)...
Definition: Message.h:198
+
TgBot::Message
This object represents a message.
Definition: Message.h:52
+
TgBot::Message::voice
Voice::Ptr voice
Optional. Message is a voice message, information about the file.
Definition: Message.h:173
+
TgBot::User::Ptr
std::shared_ptr< User > Ptr
Definition: User.h:39
Message.h
@@ -154,7 +157,7 @@ $(document).ready(function(){initNavTree('_message_8h_source.html','');});