List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
setPinnedGifts Class Referencefinal

Inherits Function.

Description

Changes the list of pinned gifts on the current user's or the channel's profile page; requires can_post_messages administrator right in the channel chat.

Returns object_ptr<Ok>.

Public Fields

object_ptr< MessageSenderowner_id_
 Identifier of the user or the channel chat that received the gifts.
 
array< stringreceived_gift_ids_
 New list of pinned gifts. All gifts must be upgraded and saved on the profile page first. There can be up to getOption("pinned_gift_count_max") pinned gifts.
 

Public Types

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

Public Instance Methods

 setPinnedGifts ()
 
 setPinnedGifts (object_ptr< MessageSender > &&owner_id_, array< string > &&received_gift_ids_)
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ setPinnedGifts() [1/2]

Default constructor for a function, which changes the list of pinned gifts on the current user's or the channel's profile page; requires can_post_messages administrator right in the channel chat.

Returns object_ptr<Ok>.

◆ setPinnedGifts() [2/2]

setPinnedGifts ( object_ptr< MessageSender > &&  owner_id_,
array< string > &&  received_gift_ids_ 
)

Creates a function, which changes the list of pinned gifts on the current user's or the channel's profile page; requires can_post_messages administrator right in the channel chat.

Returns object_ptr<Ok>.

Parameters
[in]owner_id_Identifier of the user or the channel chat that received the gifts.
[in]received_gift_ids_New list of pinned gifts. All gifts must be upgraded and saved on the profile page first. There can be up to getOption("pinned_gift_count_max") pinned gifts.

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