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

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

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

Public Types

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

Public Member Functions

 startLiveStory ()
 
 startLiveStory (int53 chat_id_, object_ptr< StoryPrivacySettings > &&privacy_settings_, bool protect_content_, bool is_rtmp_stream_, bool enable_messages_, int53 paid_message_star_count_)
 
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

int53 chat_id_
 Identifier of the chat that will start the live story. Pass Saved Messages chat identifier when starting a live story on behalf of the current user, or a channel chat identifier.
 
object_ptr< StoryPrivacySettingsprivacy_settings_
 The privacy settings for the story; ignored for stories posted on behalf of channel chats.
 
bool protect_content_
 Pass true if the content of the story must be protected from screenshotting.
 
bool is_rtmp_stream_
 Pass true to create an RTMP stream instead of an ordinary group call.
 
bool enable_messages_
 Pass true to allow viewers of the story to send messages.
 
int53 paid_message_star_count_
 The minimum number of Telegram Stars that must be paid by viewers for each sent message to the call; 0-getOption("paid_group_call_message_star_count_max").
 

Static Public Attributes

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

Detailed Description

Starts a new live story on behalf of a chat; requires can_post_stories administrator right for channel chats.

Returns object_ptr<StartLiveStoryResult>.

Definition at line 134786 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 134834 of file td_api.h.

Constructor & Destructor Documentation

◆ startLiveStory() [1/2]

td::td_api::startLiveStory::startLiveStory ( )

Default constructor for a function, which starts a new live story on behalf of a chat; requires can_post_stories administrator right for channel chats.

Returns object_ptr<StartLiveStoryResult>.

◆ startLiveStory() [2/2]

td::td_api::startLiveStory::startLiveStory ( int53  chat_id_,
object_ptr< StoryPrivacySettings > &&  privacy_settings_,
bool  protect_content_,
bool  is_rtmp_stream_,
bool  enable_messages_,
int53  paid_message_star_count_ 
)

Creates a function, which starts a new live story on behalf of a chat; requires can_post_stories administrator right for channel chats.

Returns object_ptr<StartLiveStoryResult>.

Parameters
[in]chat_id_Identifier of the chat that will start the live story. Pass Saved Messages chat identifier when starting a live story on behalf of the current user, or a channel chat identifier.
[in]privacy_settings_The privacy settings for the story; ignored for stories posted on behalf of channel chats.
[in]protect_content_Pass true if the content of the story must be protected from screenshotting.
[in]is_rtmp_stream_Pass true to create an RTMP stream instead of an ordinary group call.
[in]enable_messages_Pass true to allow viewers of the story to send messages.
[in]paid_message_star_count_The minimum number of Telegram Stars that must be paid by viewers for each sent message to the call; 0-getOption("paid_group_call_message_star_count_max").

Member Function Documentation

◆ store()

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

◆ chat_id_

int53 td::td_api::startLiveStory::chat_id_

Identifier of the chat that will start the live story. Pass Saved Messages chat identifier when starting a live story on behalf of the current user, or a channel chat identifier.

Definition at line 134797 of file td_api.h.

◆ enable_messages_

bool td::td_api::startLiveStory::enable_messages_

Pass true to allow viewers of the story to send messages.

Definition at line 134805 of file td_api.h.

◆ ID

const std::int32_t td::td_api::startLiveStory::ID = 1253467958
static

Identifier uniquely determining a type of the object.

Definition at line 134831 of file td_api.h.

◆ is_rtmp_stream_

bool td::td_api::startLiveStory::is_rtmp_stream_

Pass true to create an RTMP stream instead of an ordinary group call.

Definition at line 134803 of file td_api.h.

◆ paid_message_star_count_

int53 td::td_api::startLiveStory::paid_message_star_count_

The minimum number of Telegram Stars that must be paid by viewers for each sent message to the call; 0-getOption("paid_group_call_message_star_count_max").

Definition at line 134807 of file td_api.h.

◆ privacy_settings_

object_ptr<StoryPrivacySettings> td::td_api::startLiveStory::privacy_settings_

The privacy settings for the story; ignored for stories posted on behalf of channel chats.

Definition at line 134799 of file td_api.h.

◆ protect_content_

bool td::td_api::startLiveStory::protect_content_

Pass true if the content of the story must be protected from screenshotting.

Definition at line 134801 of file td_api.h.


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