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

Inherits Function.

Description

Changes a note of a contact user.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 setUserNote ()
 setUserNote (int53 user_id_, object_ptr< formattedText > &&note_)
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< formattedText > note_
 Note to set for the user; 0-getOption("user_note_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.
int53 user_id_
 User identifier.

Static Public Attributes

static const std::int32_t ID = -351487655
 Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

◆ setUserNote() [1/2]

setUserNote ( )

Default constructor for a function, which changes a note of a contact user.

Returns object_ptr<Ok>.

◆ setUserNote() [2/2]

setUserNote ( int53 user_id_,
object_ptr< formattedText > && note_ )

Creates a function, which changes a note of a contact user.

Returns object_ptr<Ok>.

Parameters
[in]user_id_User identifier.
[in]note_Note to set for the user; 0-getOption("user_note_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, and DateTime entities are allowed.

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: