Arguments for Api::postStory. More...

#include <Types.h>

Public Attributes
std::int32_t	activePeriod { }
	Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400.
std::string	businessConnectionId { }
	Unique identifier of the business connection.
std::shared_ptr< InputStoryContent >	content { }
	Content of the story.
std::vector< std::shared_ptr< StoryArea > >	areas = { }
	A JSON-serialized list of clickable areas to be shown on the story.
std::string	caption = ""
	Caption of the story, 0-2048 characters after entities parsing.
std::vector< std::shared_ptr< MessageEntity > >	captionEntities = { }
	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
std::string	parseMode = ""
	Mode for parsing entities in the story caption. See formatting options for more details.
bool	postToChatPage = false
	Pass True to keep the story accessible after it expires.
bool	protectContent = false
	Pass True if the content of the story must be protected from forwarding and screenshotting.
std::vector< InputFileAttachment >	attachments = { }
	Files uploaded as named multipart parts. Reference each file from a composite Telegram API argument as attach://<name> and use the same name in InputFileAttachment.

Detailed Description

Arguments for Api::postStory.

Definition at line 16958 of file Types.h.

Member Data Documentation

◆ activePeriod

std::int32_t TgBot::PostStoryArgs::activePeriod { }

Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400.

Definition at line 16963 of file Types.h.

◆ areas

std::vector<std::shared_ptr<StoryArea> > TgBot::PostStoryArgs::areas = { }

A JSON-serialized list of clickable areas to be shown on the story.

Definition at line 16978 of file Types.h.

◆ attachments

std::vector<InputFileAttachment> TgBot::PostStoryArgs::attachments = { }

Files uploaded as named multipart parts. Reference each file from a composite Telegram API argument as attach://<name> and use the same name in InputFileAttachment.

Definition at line 17013 of file Types.h.

◆ businessConnectionId

std::string TgBot::PostStoryArgs::businessConnectionId { }

Unique identifier of the business connection.

Definition at line 16968 of file Types.h.

◆ caption

std::string TgBot::PostStoryArgs::caption = ""

Caption of the story, 0-2048 characters after entities parsing.

Definition at line 16983 of file Types.h.

◆ captionEntities

std::vector<std::shared_ptr<MessageEntity> > TgBot::PostStoryArgs::captionEntities = { }

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 16989 of file Types.h.

◆ content

std::shared_ptr<InputStoryContent> TgBot::PostStoryArgs::content { }

Content of the story.

Definition at line 16973 of file Types.h.

◆ parseMode

std::string TgBot::PostStoryArgs::parseMode = ""

Mode for parsing entities in the story caption. See formatting options for more details.

Definition at line 16995 of file Types.h.

◆ postToChatPage

bool TgBot::PostStoryArgs::postToChatPage = false

Pass True to keep the story accessible after it expires.

Definition at line 17000 of file Types.h.

◆ protectContent

bool TgBot::PostStoryArgs::protectContent = false

Pass True if the content of the story must be protected from forwarding and screenshotting.

Definition at line 17006 of file Types.h.

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

include/tgbot/Types.h

Public Attributes