tgbot-cpp
Public Types | Public Attributes | List of all members
TgBot::MessageEntity Class Reference
Types

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. More...

#include <MessageEntity.h>

Public Types

typedef std::shared_ptr< MessageEntity > Ptr
 

Public Attributes

std::string type
 Type of the entity. One of mention (), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs). More...
 
int32_t offset
 Offset in UTF-16 code units to the start of the entity. More...
 
int32_t length
 Length of the entity in UTF-16 code units. More...
 
std::string url
 Optional. For “text_link” only, url that will be opened after user taps on the text. More...
 
User::Ptr user
 Optional. For “text_mention” only, the mentioned user. More...
 

Detailed Description

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

Definition at line 19 of file MessageEntity.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<MessageEntity> TgBot::MessageEntity::Ptr

Definition at line 21 of file MessageEntity.h.

Member Data Documentation

◆ length

int32_t TgBot::MessageEntity::length

Length of the entity in UTF-16 code units.

Definition at line 36 of file MessageEntity.h.

◆ offset

int32_t TgBot::MessageEntity::offset

Offset in UTF-16 code units to the start of the entity.

Definition at line 31 of file MessageEntity.h.

◆ type

std::string TgBot::MessageEntity::type

Type of the entity. One of mention (), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs).

Definition at line 26 of file MessageEntity.h.

◆ url

std::string TgBot::MessageEntity::url

Optional. For “text_link” only, url that will be opened after user taps on the text.

Definition at line 41 of file MessageEntity.h.

◆ user

User::Ptr TgBot::MessageEntity::user

Optional. For “text_mention” only, the mentioned user.

Definition at line 46 of file MessageEntity.h.

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