getSupergroupMembers Class Reference

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 Types
using	ReturnType = object_ptr<chatMembers>
	Typedef for the type returned by the function.

Public Member Functions
	getSupergroupMembers ()
	getSupergroupMembers (int53 supergroup_id_, object_ptr< SupergroupMembersFilter > &&filter_, int32 offset_, 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
object_ptr< SupergroupMembersFilter >	filter_
	The type of users to return; pass null to use supergroupMembersFilterRecent.
int32	limit_
	The maximum number of users to be returned; up to 200.
int32	offset_
	Number of users to skip.
int53	supergroup_id_
	Identifier of the supergroup or channel.

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

Constructor & Destructor Documentation

getSupergroupMembers() [1/2]

getSupergroupMembers

(

)

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.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h