tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ChatInviteLink Class Reference

Represents an invite link for a chat. More...

#include <ChatInviteLink.h>

Public Types

typedef std::shared_ptr< ChatInviteLinkPtr
 

Public Attributes

std::string inviteLink
 The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
 
User::Ptr creator
 Creator of the link.
 
bool createsJoinRequest
 True, if users joining the chat via the link need to be approved by chat administrators.
 
bool isPrimary
 True, if the link is primary.
 
bool isRevoked
 True, if the link is revoked.
 
std::string name
 Optional. Invite link name.
 
std::uint32_t expireDate
 Optional. Point in time (Unix timestamp) when the link will expire or has been expired.
 
std::uint32_t memberLimit
 Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.
 
std::uint32_t pendingJoinRequestCount
 Optional. Number of pending join requests created using this link.
 

Detailed Description

Represents an invite link for a chat.

Definition at line 17 of file ChatInviteLink.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<ChatInviteLink> TgBot::ChatInviteLink::Ptr

Definition at line 20 of file ChatInviteLink.h.

Member Data Documentation

◆ createsJoinRequest

bool TgBot::ChatInviteLink::createsJoinRequest

True, if users joining the chat via the link need to be approved by chat administrators.

Definition at line 36 of file ChatInviteLink.h.

◆ creator

User::Ptr TgBot::ChatInviteLink::creator

Creator of the link.

Definition at line 31 of file ChatInviteLink.h.

◆ expireDate

std::uint32_t TgBot::ChatInviteLink::expireDate

Optional. Point in time (Unix timestamp) when the link will expire or has been expired.

Definition at line 56 of file ChatInviteLink.h.

◆ inviteLink

std::string TgBot::ChatInviteLink::inviteLink

The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.

Definition at line 26 of file ChatInviteLink.h.

◆ isPrimary

bool TgBot::ChatInviteLink::isPrimary

True, if the link is primary.

Definition at line 41 of file ChatInviteLink.h.

◆ isRevoked

bool TgBot::ChatInviteLink::isRevoked

True, if the link is revoked.

Definition at line 46 of file ChatInviteLink.h.

◆ memberLimit

std::uint32_t TgBot::ChatInviteLink::memberLimit

Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

Definition at line 61 of file ChatInviteLink.h.

◆ name

std::string TgBot::ChatInviteLink::name

Optional. Invite link name.

Definition at line 51 of file ChatInviteLink.h.

◆ pendingJoinRequestCount

std::uint32_t TgBot::ChatInviteLink::pendingJoinRequestCount

Optional. Number of pending join requests created using this link.

Definition at line 66 of file ChatInviteLink.h.


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