tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::addGiftCollectionGifts Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::addGiftCollectionGifts:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

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

Public Attributes

object_ptr< MessageSenderowner_id_
 Identifier of the user or the channel chat that owns the collection.
 
int32 collection_id_
 Identifier of the gift collection.
 
array< stringreceived_gift_ids_
 Identifier of the gifts to add to the collection; 1-getOption("gift_collection_size_max") identifiers. If after addition the collection has more than getOption("gift_collection_size_max") gifts, then the last one are removed from the collection.
 

Static Public Attributes

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

Detailed Description

Adds gifts to the beginning of a previously created collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection.

Returns object_ptr<GiftCollection>.

Definition at line 88212 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 88251 of file td_api.h.

Constructor & Destructor Documentation

◆ addGiftCollectionGifts() [1/2]

td::td_api::addGiftCollectionGifts::addGiftCollectionGifts ( )

Default constructor for a function, which adds gifts to the beginning of a previously created collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection.

Returns object_ptr<GiftCollection>.

◆ addGiftCollectionGifts() [2/2]

td::td_api::addGiftCollectionGifts::addGiftCollectionGifts ( object_ptr< MessageSender > &&  owner_id_,
int32  collection_id_,
array< string > &&  received_gift_ids_ 
)

Creates a function, which adds gifts to the beginning of a previously created collection. If the collection is owned by a channel chat, then requires can_post_messages administrator right in the channel chat. Returns the changed collection.

Returns object_ptr<GiftCollection>.

Parameters
[in]owner_id_Identifier of the user or the channel chat that owns the collection.
[in]collection_id_Identifier of the gift collection.
[in]received_gift_ids_Identifier of the gifts to add to the collection; 1-getOption("gift_collection_size_max") identifiers. If after addition the collection has more than getOption("gift_collection_size_max") gifts, then the last one are removed from the collection.

Member Function Documentation

◆ store()

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

Member Data Documentation

◆ collection_id_

int32 td::td_api::addGiftCollectionGifts::collection_id_

Identifier of the gift collection.

Definition at line 88225 of file td_api.h.

◆ ID

const std::int32_t td::td_api::addGiftCollectionGifts::ID = -263464606
static

Identifier uniquely determining a type of the object.

Definition at line 88248 of file td_api.h.

◆ owner_id_

object_ptr<MessageSender> td::td_api::addGiftCollectionGifts::owner_id_

Identifier of the user or the channel chat that owns the collection.

Definition at line 88223 of file td_api.h.

◆ received_gift_ids_

array<string> td::td_api::addGiftCollectionGifts::received_gift_ids_

Identifier of the gifts to add to the collection; 1-getOption("gift_collection_size_max") identifiers. If after addition the collection has more than getOption("gift_collection_size_max") gifts, then the last one are removed from the collection.

Definition at line 88227 of file td_api.h.


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