td::td_api::pinChatMessage Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	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 Member Functions inherited from td::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

Public Attributes
int53	chat_id_
	Identifier of the chat.
int53	message_id_
	Identifier of the new pinned message.
bool	disable_notification_
	Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats.
bool	only_for_self_
	Pass true to pin the message only for self; private chats only.

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

Detailed Description

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

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

pinChatMessage() [1/2]

td::td_api::pinChatMessage::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]

td::td_api::pinChatMessage::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_	Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats.
[in]	only_for_self_	Pass true to pin the message only for self; private chats only.

Member Function Documentation

get_id()

std::int32_t td::td_api::pinChatMessage::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

void td::td_api::pinChatMessage::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 td::TlObject.

---

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

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