List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
getSupergroupMembers Class Referencefinal

Inherits Function.

Description

Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters.

Returns object_ptr<ChatMembers>.

Public Fields

int53 supergroup_id_
 Identifier of the supergroup or channel.
 
object_ptr< SupergroupMembersFilterfilter_
 The type of users to return; pass null to use supergroupMembersFilterRecent.
 
int32 offset_
 Number of users to skip.
 
int32 limit_
 The maximum number of users to be returned; up to 200.
 

Public Types

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

Public Instance Methods

 getSupergroupMembers ()
 
 getSupergroupMembers (int53 supergroup_id_, object_ptr< SupergroupMembersFilter > &&filter_, int32 offset_, int32 limit_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getSupergroupMembers() [1/2]

Default constructor for a function, which returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters.

Returns object_ptr<ChatMembers>.

◆ getSupergroupMembers() [2/2]

getSupergroupMembers ( int53  supergroup_id_,
object_ptr< SupergroupMembersFilter > &&  filter_,
int32  offset_,
int32  limit_ 
)

Creates a function, which returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters.

Returns object_ptr<ChatMembers>.

Parameters
[in]supergroup_id_Identifier of the supergroup or channel.
[in]filter_The type of users to return; pass null to use supergroupMembersFilterRecent.
[in]offset_Number of users to skip.
[in]limit_The maximum number of users to be returned; up to 200.

Method 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: