tgbotxx 1.1.9.2
Telegram Bot C++ Library
Loading...
Searching...
No Matches
tgbotxx::ChecklistTask Struct Reference

Describes a task in a checklist. https://core.telegram.org/bots/api#checklisttask. More...

#include <ChecklistTask.hpp>

Public Member Functions

 ChecklistTask ()=default
 
 ChecklistTask (const nl::json &json)
 
nl::json toJson () const
 Serializes this object to JSON.
 
void fromJson (const nl::json &json)
 Deserializes this object from JSON.
 

Public Attributes

std::int32_t id {}
 Unique identifier of the task.
 
std::string text
 Text of the task.
 
std::vector< Ptr< MessageEntity > > textEntities
 Optional. Special entities that appear in the task text.
 
Ptr< UsercompletedByUser
 Optional. User that completed the task; omitted if the task wasn't completed.
 
std::time_t completionDate {}
 Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed.
 

Detailed Description

Describes a task in a checklist. https://core.telegram.org/bots/api#checklisttask.

Definition at line 9 of file ChecklistTask.hpp.

Constructor & Destructor Documentation

◆ ChecklistTask() [1/2]

tgbotxx::ChecklistTask::ChecklistTask ( )
default

◆ ChecklistTask() [2/2]

tgbotxx::ChecklistTask::ChecklistTask ( const nl::json &  json)
inlineexplicit

Definition at line 11 of file ChecklistTask.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::ChecklistTask::fromJson ( const nl::json &  json)
inline

Deserializes this object from JSON.

Definition at line 44 of file ChecklistTask.hpp.

◆ toJson()

nl::json tgbotxx::ChecklistTask::toJson ( ) const
inline

Serializes this object to JSON.

Returns
JSON representation of this object

Definition at line 33 of file ChecklistTask.hpp.

Member Data Documentation

◆ completedByUser

Ptr<User> tgbotxx::ChecklistTask::completedByUser

Optional. User that completed the task; omitted if the task wasn't completed.

Definition at line 25 of file ChecklistTask.hpp.

◆ completionDate

std::time_t tgbotxx::ChecklistTask::completionDate {}

Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed.

Definition at line 28 of file ChecklistTask.hpp.

◆ id

std::int32_t tgbotxx::ChecklistTask::id {}

Unique identifier of the task.

Definition at line 16 of file ChecklistTask.hpp.

◆ text

std::string tgbotxx::ChecklistTask::text

Text of the task.

Definition at line 19 of file ChecklistTask.hpp.

◆ textEntities

std::vector<Ptr<MessageEntity> > tgbotxx::ChecklistTask::textEntities

Optional. Special entities that appear in the task text.

Definition at line 22 of file ChecklistTask.hpp.


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