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

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<ChatInviteLink>

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 “…”.
std::shared_ptr< User >	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::optional< std::string >	name { }
	Optional. Invite link name.
std::optional< std::int32_t >	expireDate { }
	Optional. Point in time (Unix timestamp) when the link will expire or has been expired.
std::optional< std::int32_t >	memberLimit { }
	Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.
std::optional< std::int32_t >	pendingJoinRequestCount { }
	Optional. Number of pending join requests created using this link.
std::optional< std::int32_t >	subscriptionPeriod { }
	Optional. The number of seconds the subscription will be active for before the next payment.
std::optional< std::int32_t >	subscriptionPrice { }
	Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link.

Detailed Description

Represents an invite link for a chat.

Definition at line 2192 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::ChatInviteLink::Ptr = std::shared_ptr<ChatInviteLink>

Definition at line 2193 of file Types.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 2209 of file Types.h.

◆ creator

std::shared_ptr<User> TgBot::ChatInviteLink::creator { }

Creator of the link.

Definition at line 2204 of file Types.h.

◆ expireDate

std::optional<std::int32_t> TgBot::ChatInviteLink::expireDate { }

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

Definition at line 2229 of file Types.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 2199 of file Types.h.

◆ isPrimary

bool TgBot::ChatInviteLink::isPrimary { }

True, if the link is primary.

Definition at line 2214 of file Types.h.

◆ isRevoked

bool TgBot::ChatInviteLink::isRevoked { }

True, if the link is revoked.

Definition at line 2219 of file Types.h.

◆ memberLimit

std::optional<std::int32_t> TgBot::ChatInviteLink::memberLimit { }

Optional. The 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 2235 of file Types.h.

◆ name

std::optional<std::string> TgBot::ChatInviteLink::name { }

Optional. Invite link name.

Definition at line 2224 of file Types.h.

◆ pendingJoinRequestCount

std::optional<std::int32_t> TgBot::ChatInviteLink::pendingJoinRequestCount { }

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

Definition at line 2240 of file Types.h.

◆ subscriptionPeriod

std::optional<std::int32_t> TgBot::ChatInviteLink::subscriptionPeriod { }

Optional. The number of seconds the subscription will be active for before the next payment.

Definition at line 2246 of file Types.h.

◆ subscriptionPrice

std::optional<std::int32_t> TgBot::ChatInviteLink::subscriptionPrice { }

Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link.

Definition at line 2252 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes