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

Arguments for Api::restrictChatMember. More...

#include <Types.h>

Public Attributes

std::variant< std::int64_t, std::string > chatId { }
 Unique identifier for the target chat or username of the target supergroup in the format @username.
std::int64_t userId { }
 Unique identifier of the target user.
std::shared_ptr< ChatPermissions > permissions { }
 A JSON-serialized object for new user permissions.
std::int32_t untilDate = 0
 Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
bool useIndependentChatPermissions = false
 Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Detailed Description

Arguments for Api::restrictChatMember.

Definition at line 17339 of file Types.h.

Member Data Documentation

◆ chatId

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

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

Definition at line 17344 of file Types.h.

◆ permissions

std::shared_ptr<ChatPermissions> TgBot::RestrictChatMemberArgs::permissions { }

A JSON-serialized object for new user permissions.

Definition at line 17354 of file Types.h.

◆ untilDate

std::int32_t TgBot::RestrictChatMemberArgs::untilDate = 0

Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.

Definition at line 17361 of file Types.h.

◆ useIndependentChatPermissions

bool TgBot::RestrictChatMemberArgs::useIndependentChatPermissions = false

Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.

Definition at line 17371 of file Types.h.

◆ userId

std::int64_t TgBot::RestrictChatMemberArgs::userId { }

Unique identifier of the target user.

Definition at line 17349 of file Types.h.


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