TDLib
Loading...
Searching...
No Matches
getChatInviteLinkMembers Class Referencefinal

Inherits Function.

Description

Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLinkMembers>.

Public Types

using ReturnType = object_ptr<chatInviteLinkMembers>
 Typedef for the type returned by the function.

Public Member Functions

 getChatInviteLinkMembers ()
 getChatInviteLinkMembers (int53 chat_id_, string const &invite_link_, bool only_with_expired_subscription_, object_ptr< chatInviteLinkMember > &&offset_member_, int32 limit_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

int53 chat_id_
 Chat identifier.
string invite_link_
 Invite link for which to return chat members.
int32 limit_
 The maximum number of chat members to return; up to 100.
object_ptr< chatInviteLinkMember > offset_member_
 A chat member from which to return next chat members; pass null to get results from the beginning.
bool only_with_expired_subscription_
 Pass true if the link is a subscription link and only members with expired subscription must be returned.

Static Public Attributes

static const std::int32_t ID = 1728376124
 Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

◆ getChatInviteLinkMembers() [1/2]

getChatInviteLinkMembers ( )

Default constructor for a function, which returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLinkMembers>.

◆ getChatInviteLinkMembers() [2/2]

getChatInviteLinkMembers ( int53 chat_id_,
string const & invite_link_,
bool only_with_expired_subscription_,
object_ptr< chatInviteLinkMember > && offset_member_,
int32 limit_ )

Creates a function, which returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLinkMembers>.

Parameters
[in]chat_id_Chat identifier.
[in]invite_link_Invite link for which to return chat members.
[in]only_with_expired_subscription_Pass true if the link is a subscription link and only members with expired subscription must be returned.
[in]offset_member_A chat member from which to return next chat members; pass null to get results from the beginning.
[in]limit_The maximum number of chat members to return; up to 100.

Member Function Documentation

◆ store()

void store ( TlStorerToString & s,
const char * field_name ) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


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