tgbot-cpp
Chat.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_CHAT_H
24 #define TGBOT_CPP_CHAT_H
25 
26 #include <string>
27 #include <memory>
28 
29 #include "tgbot/types/ChatPhoto.h"
30 
31 namespace TgBot {
32 
33 class Message;
38 class Chat {
39 
40 public:
41  typedef std::shared_ptr<Chat> Ptr;
42 
46  enum class Type {
48  };
49 
53  int64_t id;
54 
59 
63  std::string title;
64 
69  std::string username;
70 
75  std::string firstName;
76 
81  std::string lastName;
82 
88 
94 
99  std::string description;
100 
105  std::string inviteLink;
106 
111  std::shared_ptr<Message> pinnedMessage;
112 
117  std::string stickerSetName;
118 
124 };
125 
126 }
127 
128 #endif //TGBOT_CPP_CHAT_H
Type type
Type of chat: can be either "private", "group", "supergroup, or "channel".
Definition: Chat.h:58
std::string stickerSetName
Optional. For supergroups, name of group sticker set. Returned only in getChat.
Definition: Chat.h:117
std::shared_ptr< Message > pinnedMessage
Optional. Pinned message, for supergroups and channel chats. Returned only in getChat.
Definition: Chat.h:111
bool canSetStickerSet
Optional. True, if the bot can change the group sticker set. Returned only in getChat.
Definition: Chat.h:123
Definition: Api.h:49
std::string firstName
Optional. First name of the other party in private chat.
Definition: Chat.h:75
std::shared_ptr< ChatPhoto > Ptr
Definition: ChatPhoto.h:38
bool allMembersAreAdministrators
Optional. True if a group has ‘All Members Are Admins’ enabled.
Definition: Chat.h:87
Type
Enum of possible types of a chat.
Definition: Chat.h:46
std::string inviteLink
Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.
Definition: Chat.h:105
This object represents a Telegram Chat.
Definition: Chat.h:38
int64_t id
Unique identifier for this chat, not exceeding 1e13 by absolute value.
Definition: Chat.h:53
ChatPhoto::Ptr photo
Optional. Chat photo. Returned only in getChat.
Definition: Chat.h:93
std::shared_ptr< Chat > Ptr
Definition: Chat.h:41
std::string description
Optional. Description, for supergroups and channel chats. Returned only in getChat.
Definition: Chat.h:99
std::string lastName
Optional. Last name of the other party in private chat.
Definition: Chat.h:81
std::string title
Optional. Title for channels and group chat.
Definition: Chat.h:63
std::string username
Optional. Username for private chats and channels.
Definition: Chat.h:69