tgbot-cpp
Loading...
Searching...
No Matches
TgBot::BanChatMemberArgs Struct Reference

Arguments for Api::banChatMember. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target group or username of the target supergroup or channel in the format @username.
std::int64_t userId { }
 Unique identifier of the target user.
std::int32_t untilDate = 0
 Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
bool revokeMessages = true
 Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

Detailed Description

Arguments for Api::banChatMember.

Definition at line 14643 of file Types.h.

Member Data Documentation

◆ chatId

std::variant<std::int64_t, std::string> TgBot::BanChatMemberArgs::chatId { }

Unique identifier for the target group or username of the target supergroup or channel in the format @username.

Definition at line 14648 of file Types.h.

◆ revokeMessages

bool TgBot::BanChatMemberArgs::revokeMessages = true

Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.

Definition at line 14669 of file Types.h.

◆ untilDate

std::int32_t TgBot::BanChatMemberArgs::untilDate = 0

Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.

Definition at line 14661 of file Types.h.

◆ userId

std::int64_t TgBot::BanChatMemberArgs::userId { }

Unique identifier of the target user.

Definition at line 14653 of file Types.h.


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