The TelegramArgs class is the base structure for all telegram message arguments. More...

#include <telegramargs.h>

Collaboration diagram for qTbot::TelegramArgs:

Public Member Functions
	TelegramArgs (const QVariant &id, const QString &text="", unsigned long long replyToMessageId=0, const QString &parseMode="html", bool disableWebPagePreview=false, const QString &callBackQueryId="", const std::function< void(int msgId)> &msgIdCB={}, iRequest::RequestPriority priority=iRequest::RequestPriority::NormalPriority)
	TelegramArgs main constructor of the message arguments.
QMap< QString, QVariant >	toMap (bool textAsCaption=false) const
	toMap This method converts all arguments to a map.

Public Attributes
QString	text = ""
	Text of the message. Default: "".
QVariant	chatId = {}
	Chat ID where the message will be sent. Default: {}.
QString	callBackQueryId = {}
	Callback query ID. Default: "".
unsigned long long	replyToMessageId = 0
	ID of the message to which a reply will be given. Default: 0.
QString	parseMode = "html"
	Parse mode of the message. Default: "html".
bool	disableWebPagePreview = false
	Disable web page preview when sending links. Default: false.
std::function< void(int msgId)>	msgIdCB = {}
	msgIdCB This is the message id callback function. It will be invoked when the request finishes successfully.
iRequest::RequestPriority	requestPriority = iRequest::RequestPriority::NormalPriority
	requestPriority This is the priority of the request.

Detailed Description

The TelegramArgs class is the base structure for all telegram message arguments.

Definition at line 20 of file telegramargs.h.

Constructor & Destructor Documentation

◆ TelegramArgs()

qTbot::TelegramArgs::TelegramArgs	(	const QVariant &	id,
		const QString &	text = "",
		unsigned long long	replyToMessageId = 0,
		const QString &	parseMode = "html",
		bool	disableWebPagePreview = false,
		const QString &	callBackQueryId = "",
		const std::function< void(int msgId)> &	msgIdCB = {},
		iRequest::RequestPriority	priority = iRequest::RequestPriority::NormalPriority )

TelegramArgs main constructor of the message arguments.

Parameters

id	This is the id of the target chat or user.
text	This is the text of the message.
replyToMessageId	This is the id of the message to reply to.
parseMode	This is the parse mode of the message.
disableWebPagePreview	Disable web page preview when sending links.
callBackQueryId	This is the callback query id.
msgIdCB	This is the callback function that is invoked with the sent message id.
priority	This is the priority of the request.

Definition at line 11 of file telegramargs.cpp.

Here is the caller graph for this function:

Member Function Documentation

◆ toMap()

QMap< QString, QVariant > qTbot::TelegramArgs::toMap ( bool textAsCaption = false ) const

toMap This method converts all arguments to a map.

Parameters

textAsCaption This option forces to replace the text key with the caption key. Used in some requests such as sendDocument.

Returns: list of arguments.

Definition at line 30 of file telegramargs.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ callBackQueryId

QString qTbot::TelegramArgs::callBackQueryId = {}

Callback query ID. Default: "".

Definition at line 59 of file telegramargs.h.

◆ chatId

QVariant qTbot::TelegramArgs::chatId = {}

Chat ID where the message will be sent. Default: {}.

Definition at line 53 of file telegramargs.h.

◆ disableWebPagePreview

bool qTbot::TelegramArgs::disableWebPagePreview = false

Disable web page preview when sending links. Default: false.

Definition at line 77 of file telegramargs.h.

◆ msgIdCB

std::function<void(int msgId)> qTbot::TelegramArgs::msgIdCB = {}

msgIdCB This is the message id callback function. It will be invoked when the request finishes successfully.

Definition at line 89 of file telegramargs.h.

◆ parseMode

QString qTbot::TelegramArgs::parseMode = "html"

Parse mode of the message. Default: "html".

Definition at line 71 of file telegramargs.h.

◆ replyToMessageId

unsigned long long qTbot::TelegramArgs::replyToMessageId = 0

ID of the message to which a reply will be given. Default: 0.

Definition at line 65 of file telegramargs.h.

◆ requestPriority

iRequest::RequestPriority qTbot::TelegramArgs::requestPriority = iRequest::RequestPriority::NormalPriority

requestPriority This is the priority of the request.

Definition at line 94 of file telegramargs.h.

◆ text

QString qTbot::TelegramArgs::text = ""

Text of the message. Default: "".

Definition at line 47 of file telegramargs.h.

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

src/qTbot/src/public/qTbot/telegramargs.h
src/qTbot/src/public/qTbot/telegramargs.cpp

Public Member Functions

Public Attributes