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

Represents a chat member that has some additional privileges. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<ChatMemberAdministrator>

Public Attributes

std::string status { STATUS }
 The member's status in the chat, always “administrator”
std::shared_ptr< Useruser { }
 Information about the user.
bool canBeEdited { }
 True, if the bot is allowed to edit administrator privileges of that user.
bool isAnonymous { }
 True, if the user's presence in the chat is hidden.
bool canManageChat { }
 True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
bool canDeleteMessages { }
 True, if the administrator can delete messages of other users.
bool canManageVideoChats { }
 True, if the administrator can manage video chats.
bool canRestrictMembers { }
 True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics.
bool canPromoteMembers { }
 True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user).
bool canChangeInfo { }
 True, if the user is allowed to change the chat title, photo and other settings.
bool canInviteUsers { }
 True, if the user is allowed to invite new users to the chat.
bool canPostStories { }
 True, if the administrator can post stories to the chat.
bool canEditStories { }
 True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive.
bool canDeleteStories { }
 True, if the administrator can delete stories posted by other users.
std::optional< bool > canPostMessages { }
 Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only.
std::optional< bool > canEditMessages { }
 Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only.
std::optional< bool > canPinMessages { }
 Optional. True, if the user is allowed to pin messages; for groups and supergroups only.
std::optional< bool > canManageTopics { }
 Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only.
std::optional< bool > canManageDirectMessages { }
 Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only.
std::optional< bool > canManageTags { }
 Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages.
std::optional< std::string > customTitle { }
 Optional. Custom title for this user.

Static Public Attributes

static TGBOT_API const std::string STATUS

Detailed Description

Represents a chat member that has some additional privileges.

Definition at line 2354 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 2355 of file Types.h.

Member Data Documentation

◆ canBeEdited

bool TgBot::ChatMemberAdministrator::canBeEdited { }

True, if the bot is allowed to edit administrator privileges of that user.

Definition at line 2372 of file Types.h.

◆ canChangeInfo

bool TgBot::ChatMemberAdministrator::canChangeInfo { }

True, if the user is allowed to change the chat title, photo and other settings.

Definition at line 2413 of file Types.h.

◆ canDeleteMessages

bool TgBot::ChatMemberAdministrator::canDeleteMessages { }

True, if the administrator can delete messages of other users.

Definition at line 2390 of file Types.h.

◆ canDeleteStories

bool TgBot::ChatMemberAdministrator::canDeleteStories { }

True, if the administrator can delete stories posted by other users.

Definition at line 2434 of file Types.h.

◆ canEditMessages

std::optional<bool> TgBot::ChatMemberAdministrator::canEditMessages { }

Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only.

Definition at line 2446 of file Types.h.

◆ canEditStories

bool TgBot::ChatMemberAdministrator::canEditStories { }

True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive.

Definition at line 2429 of file Types.h.

◆ canInviteUsers

bool TgBot::ChatMemberAdministrator::canInviteUsers { }

True, if the user is allowed to invite new users to the chat.

Definition at line 2418 of file Types.h.

◆ canManageChat

bool TgBot::ChatMemberAdministrator::canManageChat { }

True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.

Definition at line 2385 of file Types.h.

◆ canManageDirectMessages

std::optional<bool> TgBot::ChatMemberAdministrator::canManageDirectMessages { }

Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only.

Definition at line 2463 of file Types.h.

◆ canManageTags

std::optional<bool> TgBot::ChatMemberAdministrator::canManageTags { }

Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages.

Definition at line 2469 of file Types.h.

◆ canManageTopics

std::optional<bool> TgBot::ChatMemberAdministrator::canManageTopics { }

Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only.

Definition at line 2457 of file Types.h.

◆ canManageVideoChats

bool TgBot::ChatMemberAdministrator::canManageVideoChats { }

True, if the administrator can manage video chats.

Definition at line 2395 of file Types.h.

◆ canPinMessages

std::optional<bool> TgBot::ChatMemberAdministrator::canPinMessages { }

Optional. True, if the user is allowed to pin messages; for groups and supergroups only.

Definition at line 2451 of file Types.h.

◆ canPostMessages

std::optional<bool> TgBot::ChatMemberAdministrator::canPostMessages { }

Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only.

Definition at line 2440 of file Types.h.

◆ canPostStories

bool TgBot::ChatMemberAdministrator::canPostStories { }

True, if the administrator can post stories to the chat.

Definition at line 2423 of file Types.h.

◆ canPromoteMembers

bool TgBot::ChatMemberAdministrator::canPromoteMembers { }

True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user).

Definition at line 2408 of file Types.h.

◆ canRestrictMembers

bool TgBot::ChatMemberAdministrator::canRestrictMembers { }

True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics.

Definition at line 2401 of file Types.h.

◆ customTitle

std::optional<std::string> TgBot::ChatMemberAdministrator::customTitle { }

Optional. Custom title for this user.

Definition at line 2474 of file Types.h.

◆ isAnonymous

bool TgBot::ChatMemberAdministrator::isAnonymous { }

True, if the user's presence in the chat is hidden.

Definition at line 2377 of file Types.h.

◆ STATUS

TGBOT_API const std::string TgBot::ChatMemberAdministrator::STATUS
static

Definition at line 2357 of file Types.h.

◆ status

std::string TgBot::ChatMemberAdministrator::status { STATUS }

The member's status in the chat, always “administrator”

Definition at line 2362 of file Types.h.

◆ user

std::shared_ptr<User> TgBot::ChatMemberAdministrator::user { }

Information about the user.

Definition at line 2367 of file Types.h.


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