qTbot 0.2.107.d8fc923
qTbot is base back end library for your c++ Qt projects.
qTbot::TelegramArgs Struct Reference

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

#include <telegramargs.h>

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)
 
QMap< QString, QVariant > toMap (bool textAsCaption=false) const
 toMap convert all arguments to the 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 id message call bak function. Will be inwoked when request finished successful.
 
iRequest::RequestPriority requestPriority = iRequest::RequestPriority::NormalPriority
 

Detailed Description

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

Definition at line 20 of file telegramargs.h.

Collaboration diagram for qTbot::TelegramArgs:
Collaboration graph

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 
)

Definition at line 11 of file telegramargs.cpp.

Member Function Documentation

◆ toMap()

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

toMap convert all arguments to the map.

Parameters
textAsCaptionThis option force to replace text key to caption. Used on some requests as a 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 48 of file telegramargs.h.

◆ chatId

QVariant qTbot::TelegramArgs::chatId = {}

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

Definition at line 42 of file telegramargs.h.

◆ disableWebPagePreview

bool qTbot::TelegramArgs::disableWebPagePreview = false

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

Definition at line 66 of file telegramargs.h.

◆ msgIdCB

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

msgIdCB This is id message call bak function. Will be inwoked when request finished successful.

Definition at line 78 of file telegramargs.h.

◆ parseMode

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

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

Definition at line 60 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 54 of file telegramargs.h.

◆ requestPriority

Definition at line 80 of file telegramargs.h.

◆ text

QString qTbot::TelegramArgs::text = ""

Text of the message. Default: "".

Definition at line 36 of file telegramargs.h.


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