pinChatMessage Class Reference

Inherits Function.

Description

Pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel.

Returns object_ptr<Ok>.

Public Fields
int53	chat_id_
	Identifier of the chat.
int53	message_id_
	Identifier of the new pinned message.
bool	disable_notification_
	True, if there must be no notification about the pinned message. Notifications are always disabled in channels and private chats.
bool	only_for_self_
	True, if the message needs to be pinned for one side only; private chats only.

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

Public Instance Methods
	pinChatMessage ()
	pinChatMessage (int53 chat_id_, int53 message_id_, bool disable_notification_, bool only_for_self_)
std::int32_t	get_id () const final
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 = 2034719663
	Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

pinChatMessage() [1/2]

pinChatMessage

(

)

Default constructor for a function, which pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel.

Returns object_ptr<Ok>.

pinChatMessage() [2/2]

pinChatMessage	(	int53	chat_id_,
		int53	message_id_,
		bool	disable_notification_,
		bool	only_for_self_
	)

Creates a function, which pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel.

Returns object_ptr<Ok>.

Parameters

[in]	chat_id_	Identifier of the chat.
[in]	message_id_	Identifier of the new pinned message.
[in]	disable_notification_	True, if there must be no notification about the pinned message. Notifications are always disabled in channels and private chats.
[in]	only_for_self_	True, if the message needs to be pinned for one side only; private chats only.

Method Documentation

get_id()

std::int32_t get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements TlObject.

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