TDLib
Loading...
Searching...
No Matches
pinChatMessage Class Referencefinal

Inherits Function.

Description

Pins a message in a chat. A message can be pinned only if messageProperties.can_be_pinned.

Returns object_ptr<Ok>.

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_)
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

int53 chat_id_
 Identifier of the chat.
bool disable_notification_
 Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats.
int53 message_id_
 Identifier of the new pinned message.
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.

Constructor & Destructor Documentation

◆ pinChatMessage() [1/2]

pinChatMessage ( )

Default constructor for a function, which pins a message in a chat. A message can be pinned only if messageProperties.can_be_pinned.

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. A message can be pinned only if messageProperties.can_be_pinned.

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

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