From e2871c54a71a8015923b8215816c2a81e1b0c209 Mon Sep 17 00:00:00 2001 From: JellyBrick Date: Fri, 22 Jun 2018 22:12:21 +0900 Subject: Regenerate docs --- docs/class_tg_bot_1_1_chat.html | 454 ---------------------------------------- 1 file changed, 454 deletions(-) delete mode 100644 docs/class_tg_bot_1_1_chat.html (limited to 'docs/class_tg_bot_1_1_chat.html') diff --git a/docs/class_tg_bot_1_1_chat.html b/docs/class_tg_bot_1_1_chat.html deleted file mode 100644 index d68e3ce..0000000 --- a/docs/class_tg_bot_1_1_chat.html +++ /dev/null @@ -1,454 +0,0 @@ - - - - - - - -tgbot-cpp: TgBot::Chat Class Reference - - - - - - - - - - - - - - -
-
- - - - - - -
-
tgbot-cpp -
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
- -
-
TgBot::Chat Class Reference
-
-
- -

This object represents a Telegram Chat. - More...

- -

#include <Chat.h>

- - - - - - - -

-Public Types

enum  Type { Type::Private, -Type::Group, -Type::Supergroup, -Type::Channel - }
 Enum of possible types of a chat. More...
 
typedef std::shared_ptr< ChatPtr
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Attributes

int64_t id
 Unique identifier for this chat, not exceeding 1e13 by absolute value. More...
 
Type type
 Type of chat: can be either "private", "group", "supergroup, or "channel". More...
 
std::string title
 Optional. Title for channels and group chat. More...
 
std::string username
 Optional. Username for private chats and channels. More...
 
std::string firstName
 Optional. First name of the other party in private chat. More...
 
std::string lastName
 Optional. Last name of the other party in private chat. More...
 
bool allMembersAreAdministrators
 Optional. True if a group has ‘All Members Are Admins’ enabled. More...
 
ChatPhoto::Ptr photo
 Optional. Chat photo. Returned only in getChat. More...
 
std::string description
 Optional. Description, for supergroups and channel chats. Returned only in getChat. More...
 
std::string inviteLink
 Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat. More...
 
std::shared_ptr< MessagepinnedMessage
 Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. More...
 
std::string stickerSetName
 Optional. For supergroups, name of group sticker set. Returned only in getChat. More...
 
bool canSetStickerSet
 Optional. True, if the bot can change the group sticker set. Returned only in getChat. More...
 
-

Detailed Description

-

This object represents a Telegram Chat.

- -

Definition at line 38 of file Chat.h.

-

Member Typedef Documentation

- -

◆ Ptr

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

Definition at line 41 of file Chat.h.

- -
-
-

Member Enumeration Documentation

- -

◆ Type

- -
-
- - - - - -
- - - - -
enum TgBot::Chat::Type
-
-strong
-
- -

Enum of possible types of a chat.

- - - - - -
Enumerator
Private 
Group 
Supergroup 
Channel 
- -

Definition at line 46 of file Chat.h.

- -
-
-

Member Data Documentation

- -

◆ allMembersAreAdministrators

- -
-
- - - - -
bool TgBot::Chat::allMembersAreAdministrators
-
- -

Optional. True if a group has ‘All Members Are Admins’ enabled.

- -

Definition at line 87 of file Chat.h.

- -
-
- -

◆ canSetStickerSet

- -
-
- - - - -
bool TgBot::Chat::canSetStickerSet
-
- -

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

- -

Definition at line 123 of file Chat.h.

- -
-
- -

◆ description

- -
-
- - - - -
std::string TgBot::Chat::description
-
- -

Optional. Description, for supergroups and channel chats. Returned only in getChat.

- -

Definition at line 99 of file Chat.h.

- -
-
- -

◆ firstName

- -
-
- - - - -
std::string TgBot::Chat::firstName
-
- -

Optional. First name of the other party in private chat.

- -

Definition at line 75 of file Chat.h.

- -
-
- -

◆ id

- -
-
- - - - -
int64_t TgBot::Chat::id
-
- -

Unique identifier for this chat, not exceeding 1e13 by absolute value.

- -

Definition at line 53 of file Chat.h.

- -
-
- -

◆ inviteLink

- -
-
- - - - -
std::string TgBot::Chat::inviteLink
-
- -

Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.

- -

Definition at line 105 of file Chat.h.

- -
-
- -

◆ lastName

- -
-
- - - - -
std::string TgBot::Chat::lastName
-
- -

Optional. Last name of the other party in private chat.

- -

Definition at line 81 of file Chat.h.

- -
-
- -

◆ photo

- -
-
- - - - -
ChatPhoto::Ptr TgBot::Chat::photo
-
- -

Optional. Chat photo. Returned only in getChat.

- -

Definition at line 93 of file Chat.h.

- -
-
- -

◆ pinnedMessage

- -
-
- - - - -
std::shared_ptr<Message> TgBot::Chat::pinnedMessage
-
- -

Optional. Pinned message, for supergroups and channel chats. Returned only in getChat.

- -

Definition at line 111 of file Chat.h.

- -
-
- -

◆ stickerSetName

- -
-
- - - - -
std::string TgBot::Chat::stickerSetName
-
- -

Optional. For supergroups, name of group sticker set. Returned only in getChat.

- -

Definition at line 117 of file Chat.h.

- -
-
- -

◆ title

- -
-
- - - - -
std::string TgBot::Chat::title
-
- -

Optional. Title for channels and group chat.

- -

Definition at line 63 of file Chat.h.

- -
-
- -

◆ type

- -
-
- - - - -
Type TgBot::Chat::type
-
- -

Type of chat: can be either "private", "group", "supergroup, or "channel".

- -

Definition at line 58 of file Chat.h.

- -
-
- -

◆ username

- -
-
- - - - -
std::string TgBot::Chat::username
-
- -

Optional. Username for private chats and channels.

- -

Definition at line 69 of file Chat.h.

- -
-
-
The documentation for this class was generated from the following file:
    -
  • include/tgbot/types/Chat.h
  • -
-
-
- - - - -- cgit v1.2.3 From 3e5a28fa0a1ba2d461271f22399476c241bcffe3 Mon Sep 17 00:00:00 2001 From: JellyBrick Date: Fri, 22 Jun 2018 22:15:42 +0900 Subject: Regenerate docs --- docs/class_tg_bot_1_1_chat.html | 455 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 455 insertions(+) create mode 100644 docs/class_tg_bot_1_1_chat.html (limited to 'docs/class_tg_bot_1_1_chat.html') diff --git a/docs/class_tg_bot_1_1_chat.html b/docs/class_tg_bot_1_1_chat.html new file mode 100644 index 0000000..2af707f --- /dev/null +++ b/docs/class_tg_bot_1_1_chat.html @@ -0,0 +1,455 @@ + + + + + + +tgbot-cpp: TgBot::Chat Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
tgbot-cpp +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
TgBot::Chat Class Reference
+
+
+ +

This object represents a Telegram Chat. + More...

+ +

#include <Chat.h>

+ + + + + + + +

+Public Types

enum  Type { Type::Private, +Type::Group, +Type::Supergroup, +Type::Channel + }
 Enum of possible types of a chat. More...
 
typedef std::shared_ptr< ChatPtr
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

int64_t id
 Unique identifier for this chat, not exceeding 1e13 by absolute value. More...
 
Type type
 Type of chat: can be either "private", "group", "supergroup, or "channel". More...
 
std::string title
 Optional. Title for channels and group chat. More...
 
std::string username
 Optional. Username for private chats and channels. More...
 
std::string firstName
 Optional. First name of the other party in private chat. More...
 
std::string lastName
 Optional. Last name of the other party in private chat. More...
 
bool allMembersAreAdministrators
 Optional. True if a group has ‘All Members Are Admins’ enabled. More...
 
ChatPhoto::Ptr photo
 Optional. Chat photo. Returned only in getChat. More...
 
std::string description
 Optional. Description, for supergroups and channel chats. Returned only in getChat. More...
 
std::string inviteLink
 Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat. More...
 
std::shared_ptr< MessagepinnedMessage
 Optional. Pinned message, for supergroups and channel chats. Returned only in getChat. More...
 
std::string stickerSetName
 Optional. For supergroups, name of group sticker set. Returned only in getChat. More...
 
bool canSetStickerSet
 Optional. True, if the bot can change the group sticker set. Returned only in getChat. More...
 
+

Detailed Description

+

This object represents a Telegram Chat.

+ +

Definition at line 38 of file Chat.h.

+

Member Typedef Documentation

+ +
+
+ + + + +
typedef std::shared_ptr<Chat> TgBot::Chat::Ptr
+
+ +

Definition at line 41 of file Chat.h.

+ +
+
+

Member Enumeration Documentation

+ +
+
+ + + + + +
+ + + + +
enum TgBot::Chat::Type
+
+strong
+
+ +

Enum of possible types of a chat.

+ + + + + +
Enumerator
Private  +
Group  +
Supergroup  +
Channel  +
+ +

Definition at line 46 of file Chat.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
bool TgBot::Chat::allMembersAreAdministrators
+
+ +

Optional. True if a group has ‘All Members Are Admins’ enabled.

+ +

Definition at line 87 of file Chat.h.

+ +
+
+ +
+
+ + + + +
bool TgBot::Chat::canSetStickerSet
+
+ +

Optional. True, if the bot can change the group sticker set. Returned only in getChat.

+ +

Definition at line 123 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::description
+
+ +

Optional. Description, for supergroups and channel chats. Returned only in getChat.

+ +

Definition at line 99 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::firstName
+
+ +

Optional. First name of the other party in private chat.

+ +

Definition at line 75 of file Chat.h.

+ +
+
+ +
+
+ + + + +
int64_t TgBot::Chat::id
+
+ +

Unique identifier for this chat, not exceeding 1e13 by absolute value.

+ +

Definition at line 53 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::inviteLink
+
+ +

Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.

+ +

Definition at line 105 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::lastName
+
+ +

Optional. Last name of the other party in private chat.

+ +

Definition at line 81 of file Chat.h.

+ +
+
+ +
+
+ + + + +
ChatPhoto::Ptr TgBot::Chat::photo
+
+ +

Optional. Chat photo. Returned only in getChat.

+ +

Definition at line 93 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::shared_ptr<Message> TgBot::Chat::pinnedMessage
+
+ +

Optional. Pinned message, for supergroups and channel chats. Returned only in getChat.

+ +

Definition at line 111 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::stickerSetName
+
+ +

Optional. For supergroups, name of group sticker set. Returned only in getChat.

+ +

Definition at line 117 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::title
+
+ +

Optional. Title for channels and group chat.

+ +

Definition at line 63 of file Chat.h.

+ +
+
+ +
+
+ + + + +
Type TgBot::Chat::type
+
+ +

Type of chat: can be either "private", "group", "supergroup, or "channel".

+ +

Definition at line 58 of file Chat.h.

+ +
+
+ +
+
+ + + + +
std::string TgBot::Chat::username
+
+ +

Optional. Username for private chats and channels.

+ +

Definition at line 69 of file Chat.h.

+ +
+
+
The documentation for this class was generated from the following file:
    +
  • include/tgbot/types/Chat.h
  • +
+
+
+ + + + -- cgit v1.2.3