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

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

#include <Checklist.hpp>

Public Member Functions

 Checklist ()=default
 
 Checklist (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::string title
 Title of the checklist.
 
std::vector< Ptr< MessageEntity > > titleEntities
 Optional. Special entities that appear in the checklist title.
 
std::vector< Ptr< ChecklistTask > > tasks
 List of tasks in the checklist.
 
bool othersCanAddTasks {}
 Optional. True, if users other than the creator of the list can add tasks to the list.
 
bool othersCanMarkTasksAsDone {}
 Optional. True, if users other than the creator of the list can mark tasks as done or not done.
 

Detailed Description

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

Definition at line 9 of file Checklist.hpp.

Constructor & Destructor Documentation

◆ Checklist() [1/2]

tgbotxx::Checklist::Checklist ( )
default

◆ Checklist() [2/2]

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

Definition at line 11 of file Checklist.hpp.

Member Function Documentation

◆ fromJson()

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

Deserializes this object from JSON.

Definition at line 44 of file Checklist.hpp.

◆ toJson()

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

Serializes this object to JSON.

Returns
JSON representation of this object

Definition at line 33 of file Checklist.hpp.

Member Data Documentation

◆ othersCanAddTasks

bool tgbotxx::Checklist::othersCanAddTasks {}

Optional. True, if users other than the creator of the list can add tasks to the list.

Definition at line 25 of file Checklist.hpp.

◆ othersCanMarkTasksAsDone

bool tgbotxx::Checklist::othersCanMarkTasksAsDone {}

Optional. True, if users other than the creator of the list can mark tasks as done or not done.

Definition at line 28 of file Checklist.hpp.

◆ tasks

std::vector<Ptr<ChecklistTask> > tgbotxx::Checklist::tasks

List of tasks in the checklist.

Definition at line 22 of file Checklist.hpp.

◆ title

std::string tgbotxx::Checklist::title

Title of the checklist.

Definition at line 16 of file Checklist.hpp.

◆ titleEntities

std::vector<Ptr<MessageEntity> > tgbotxx::Checklist::titleEntities

Optional. Special entities that appear in the checklist title.

Definition at line 19 of file Checklist.hpp.


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