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

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

#include <InputChecklist.hpp>

Public Member Functions

 InputChecklist ()=default
 
 InputChecklist (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; 1-255 characters after entities parsing.
 
std::string parseMode
 Optional. Mode for parsing entities in the title. See formatting options for more details.
 
std::vector< Ptr< MessageEntity > > titleEntities
 Optional. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.
 
std::vector< Ptr< InputChecklistTask > > tasks
 List of 1-30 tasks in the checklist.
 
bool othersCanAddTasks {}
 Optional. Pass True if other users can add tasks to the checklist.
 
bool othersCanMarkTasksAsDone {}
 Optional. Pass True if other users can mark tasks as done or not done in the checklist.
 

Detailed Description

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

Definition at line 9 of file InputChecklist.hpp.

Constructor & Destructor Documentation

◆ InputChecklist() [1/2]

tgbotxx::InputChecklist::InputChecklist ( )
default

◆ InputChecklist() [2/2]

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

Definition at line 11 of file InputChecklist.hpp.

Member Function Documentation

◆ fromJson()

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

Deserializes this object from JSON.

Definition at line 49 of file InputChecklist.hpp.

◆ toJson()

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

Serializes this object to JSON.

Returns
JSON representation of this object

Definition at line 37 of file InputChecklist.hpp.

Member Data Documentation

◆ othersCanAddTasks

bool tgbotxx::InputChecklist::othersCanAddTasks {}

Optional. Pass True if other users can add tasks to the checklist.

Definition at line 30 of file InputChecklist.hpp.

◆ othersCanMarkTasksAsDone

bool tgbotxx::InputChecklist::othersCanMarkTasksAsDone {}

Optional. Pass True if other users can mark tasks as done or not done in the checklist.

Definition at line 33 of file InputChecklist.hpp.

◆ parseMode

std::string tgbotxx::InputChecklist::parseMode

Optional. Mode for parsing entities in the title. See formatting options for more details.

Definition at line 19 of file InputChecklist.hpp.

◆ tasks

std::vector<Ptr<InputChecklistTask> > tgbotxx::InputChecklist::tasks

List of 1-30 tasks in the checklist.

Definition at line 27 of file InputChecklist.hpp.

◆ title

std::string tgbotxx::InputChecklist::title

Title of the checklist; 1-255 characters after entities parsing.

Definition at line 16 of file InputChecklist.hpp.

◆ titleEntities

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

Optional. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.

Definition at line 24 of file InputChecklist.hpp.


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