docs/dev.inmo.tgbotapi.requests.stories/PostStory

PostStory

@Serializable

data class PostStory : BusinessRequest.Multipart<Story> , TextedOutput(source)

Constructors

constructor(businessConnectionId: BusinessConnectionId, content: InputStoryContent, activePeriod: Seconds, textSources: List<TextSource>, areas: List<StoryArea> = emptyList(), postToChatPage: Boolean = false, protectContent: Boolean = false)

constructor(businessConnectionId: BusinessConnectionId, content: InputStoryContent, activePeriod: Seconds, text: String, parseMode: ParseMode? = null, areas: List<StoryArea> = emptyList(), postToChatPage: Boolean = false, protectContent: Boolean = false)

constructor(businessConnectionId: BusinessConnectionId, content: InputStoryContent, activePeriod: Seconds, areas: List<StoryArea> = emptyList(), postToChatPage: Boolean = false, protectContent: Boolean = false)

Types

Companion

object Companion

Properties

activePeriod

@SerialName(value = "active_period")

val activePeriod: Seconds

areas

@SerialName(value = "areas")

val areas: List<StoryArea>

businessConnectionId

@SerialName(value = "business_connection_id")

open override val businessConnectionId: BusinessConnectionId

content

@SerialName(value = "content")

val content: InputStoryContent

data

open override val data: SimpleRequest<Story>

entities

open val entities: List<TextSource>?

mediaMap

open override val mediaMap: Map<String, MultipartFile>

paramsJson

open override val paramsJson: JsonObject

parseMode

@SerialName(value = "parse_mode")

open override val parseMode: ParseMode?

postToChatPage

@SerialName(value = "post_to_chat_page")

val postToChatPage: Boolean

protectContent

@SerialName(value = "protect_content")

val protectContent: Boolean

requestSerializer

open override val requestSerializer: SerializationStrategy<*>

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<Story>

text

@SerialName(value = "caption")

open override val text: String?

textSources

open override val textSources: List<TextSource>?

Full list of TextSources

Functions

method

open override fun method(): String

parseCommandsWithArgs

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: String): Map<String, Array<String>>

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

Parse commands and their args. Logic will find command, get all subsequent data as args until new command

parseCommandsWithArgsSources

fun TextedWithTextSources.parseCommandsWithArgsSources(): Map<BotCommandTextSource, Array<TextSource>>

Parse text sources to find commands with their arguments. This method will skip all the text sources before first command and all following text sources until the next command will be guessed as an args of last found command

parseCommandsWithNamedArgs

fun TextedWithTextSources.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

fun TextedWithTextSources.parseCommandsWithNamedArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

Uses parseCommandsWithArgs to create base argsSeparator split args for commands and map their as k-v pairs. Sample: