createGiftCollection Class Reference

Inherits Function.

Description

Creates a collection from gifts on the current user's or a channel's profile page; requires can_post_messages administrator right in the channel chat. An owner can have up to getOption("gift_collection_count_max") gift collections. The new collection will be added to the end of the gift collection list of the owner. Returns the created collection.

Returns object_ptr<GiftCollection>.

Public Fields
object_ptr< MessageSender >	owner_id_
	Identifier of the user or the channel chat that received the gifts.
string	name_
	Name of the collection; 1-12 characters.
array< string >	received_gift_ids_
	Identifier of the gifts to add to the collection; 0-getOption("gift_collection_gift_count_max") identifiers.

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

Public Instance Methods
	createGiftCollection ()
	createGiftCollection (object_ptr< MessageSender > &&owner_id_, string const &name_, 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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

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

Constructor & Destructor Documentation

createGiftCollection() [1/2]

createGiftCollection

(

)

Default constructor for a function, which creates a collection from gifts on the current user's or a channel's profile page; requires can_post_messages administrator right in the channel chat. An owner can have up to getOption("gift_collection_count_max") gift collections. The new collection will be added to the end of the gift collection list of the owner. Returns the created collection.

Returns object_ptr<GiftCollection>.

createGiftCollection() [2/2]

createGiftCollection	(	object_ptr< MessageSender > &&	owner_id_,
		string const &	name_,
		array< string > &&	received_gift_ids_
	)

Creates a function, which creates a collection from gifts on the current user's or a channel's profile page; requires can_post_messages administrator right in the channel chat. An owner can have up to getOption("gift_collection_count_max") gift collections. The new collection will be added to the end of the gift collection list of the owner. Returns the created collection.

Returns object_ptr<GiftCollection>.

Parameters

[in]	owner_id_	Identifier of the user or the channel chat that received the gifts.
[in]	name_	Name of the collection; 1-12 characters.
[in]	received_gift_ids_	Identifier of the gifts to add to the collection; 0-getOption("gift_collection_gift_count_max") identifiers.

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