InsanusMokrassar/tgbotapi
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/TelegramBotAPI.git synced 2024-11-22 16:23:48 +00:00
Code Releases Activity

add kdocs to LocationContent

Browse Source
This commit is contained in:
InsanusMokrassar 2021-09-21 18:57:12 +06:00
parent aeb6fad409
commit fe169fafaf
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/message/content/LocationContent.kt
View File

@ -15,6 +15,13 @@ import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.descriptors.buildClassSerialDescriptor import kotlinx.serialization.descriptors.buildClassSerialDescriptor
import kotlinx.serialization.encoding.* import kotlinx.serialization.encoding.*
/**
* [MessageContent] with [location]. This interface contains [copy] method for cases when you do not want to use some
* class casts for copying of content
*
* @see LocationContentSerializer
* @see Location
*/
@Serializable(LocationContentSerializer::class) @Serializable(LocationContentSerializer::class)
sealed interface LocationContent : MessageContent { sealed interface LocationContent : MessageContent {
val location: Location val location: Location
@ -48,6 +55,9 @@ sealed interface LocationContent : MessageContent {
} }
} }
/**
* [KSerializer] for [LocationContent]
*/
@Serializer(LocationContent::class) @Serializer(LocationContent::class)
object LocationContentSerializer : KSerializer<LocationContent> { object LocationContentSerializer : KSerializer<LocationContent> {
override val descriptor: SerialDescriptor = buildClassSerialDescriptor("LocationContent") { override val descriptor: SerialDescriptor = buildClassSerialDescriptor("LocationContent") {
@ -78,6 +88,12 @@ object LocationContentSerializer : KSerializer<LocationContent> {
} }
/**
* [LocationContent] which represents content with [LiveLocation]. In case you are tracking this content throw message
* changes, may evolve to [StaticLocationContent]
*
* @see dev.inmo.tgbotapi.extensions.behaviour_builder.utils.followLocation
*/
@Serializable(LocationContentSerializer::class) @Serializable(LocationContentSerializer::class)
data class LiveLocationContent( data class LiveLocationContent(
override val location: LiveLocation override val location: LiveLocation
@ -103,6 +119,10 @@ data class LiveLocationContent(
) as SendMessageRequest<ContentMessage<LiveLocationContent>> ) as SendMessageRequest<ContentMessage<LiveLocationContent>>
} }
/**
* Just a [LocationContent] with [StaticLocation] [location]. It could be [LiveLocationContent] in previous time in case
* when somebody has sent [LiveLocation] in chat and then stop to broadcast location
*/
@Serializable(LocationContentSerializer::class) @Serializable(LocationContentSerializer::class)
data class StaticLocationContent( data class StaticLocationContent(
override val location: StaticLocation override val location: StaticLocation