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::setGiftCollectionName Class Referencefinal

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

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

Public Types

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

Public Member Functions

 setGiftCollectionName ()
 
 setGiftCollectionName (object_ptr< MessageSender > &&owner_id_, int32 collection_id_, string const &name_)
 
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.
 
string name_
 New name of the collection; 1-12 characters.
 

Static Public Attributes

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

Detailed Description

Changes name of a gift 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 130859 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 130898 of file td_api.h.

Constructor & Destructor Documentation

◆ setGiftCollectionName() [1/2]

td::td_api::setGiftCollectionName::setGiftCollectionName ( )

Default constructor for a function, which changes name of a gift 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>.

◆ setGiftCollectionName() [2/2]

td::td_api::setGiftCollectionName::setGiftCollectionName ( object_ptr< MessageSender > &&  owner_id_,
int32  collection_id_,
string const &  name_ 
)

Creates a function, which changes name of a gift 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]name_New name of the collection; 1-12 characters.

Member Function Documentation

◆ store()

void td::td_api::setGiftCollectionName::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::setGiftCollectionName::collection_id_

Identifier of the gift collection.

Definition at line 130872 of file td_api.h.

◆ ID

const std::int32_t td::td_api::setGiftCollectionName::ID = 1108355593
static

Identifier uniquely determining a type of the object.

Definition at line 130895 of file td_api.h.

◆ name_

string td::td_api::setGiftCollectionName::name_

New name of the collection; 1-12 characters.

Definition at line 130874 of file td_api.h.

◆ owner_id_

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

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

Definition at line 130870 of file td_api.h.


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