startLiveStory Class Reference

Inherits Function.

Description

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

Returns object_ptr<StartLiveStoryResult>.

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 TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (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.
bool	enable_messages_
	Pass true to allow viewers of the story to send messages.
bool	is_rtmp_stream_
	Pass true to create an RTMP stream instead of an ordinary group call.
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").
object_ptr< StoryPrivacySettings >	privacy_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.

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

Constructor & Destructor Documentation

startLiveStory() [1/2]

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]

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