toggleChatIsPinned Class Reference

Inherits Function.

Description

Changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_chat_count_max") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium.

Returns object_ptr<Ok>.

Public Fields
object_ptr< ChatList >	chat_list_
	Chat list in which to change the pinned state of the chat.
int53	chat_id_
	Chat identifier.
bool	is_pinned_
	Pass true to pin the chat; pass false to unpin it.

Public Types
using	ReturnType = object_ptr< ok >
	Typedef for the type returned by the function.

Public Instance Methods
	toggleChatIsPinned ()
	toggleChatIsPinned (object_ptr< ChatList > &&chat_list_, int53 chat_id_, bool is_pinned_)
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

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

Constructor & Destructor Documentation

toggleChatIsPinned() [1/2]

toggleChatIsPinned

(

)

Default constructor for a function, which changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_chat_count_max") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium.

Returns object_ptr<Ok>.

toggleChatIsPinned() [2/2]

toggleChatIsPinned	(	object_ptr< ChatList > &&	chat_list_,
		int53	chat_id_,
		bool	is_pinned_
	)

Creates a function, which changes the pinned state of a chat. There can be up to getOption("pinned_chat_count_max")/getOption("pinned_archived_chat_count_max") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium.

Returns object_ptr<Ok>.

Parameters

[in]	chat_list_	Chat list in which to change the pinned state of the chat.
[in]	chat_id_	Chat identifier.
[in]	is_pinned_	Pass true to pin the chat; pass false to unpin it.

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]	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