docs/dev.inmo.tgbotapi.types.chat/CommonUser

CommonUser

@Serializable

data class CommonUser(val id: UserId, val firstName: String, val lastName: String = "", val username: Username? = null, val ietfLanguageCode: IetfLanguageCode? = null, val isPremium: Boolean = false, val addedToAttachmentMenu: Boolean = false) : User, WithOptionalLanguageCode, PossiblyPremiumChat, AbleToAddInAttachmentMenuChat

Constructors

fun CommonUser(id: UserId, firstName: String, lastName: String = "", username: Username? = null, languageCode: String)

fun CommonUser(id: UserId, firstName: String, lastName: String = "", username: Username? = null, ietfLanguageCode: IetfLanguageCode? = null, isPremium: Boolean = false, addedToAttachmentMenu: Boolean = false)

Properties

addedToAttachmentMenu

open override val addedToAttachmentMenu: Boolean = false

open override val firstName: String

open override val id: UserId

ietfLanguageCode

@Serializable(with = IetfLanguageCodeSerializer::class)

open override val ietfLanguageCode: IetfLanguageCode? = null

open override val isPremium: Boolean = false

open val languageCode: String?

open override val lastName: String

open override val username: Username? = null

Extensions

ableToAddInAttachmentMenuChatOrNull

inline fun Chat.ableToAddInAttachmentMenuChatOrNull(): AbleToAddInAttachmentMenuChat?

ableToAddInAttachmentMenuChatOrThrow

inline fun Chat.ableToAddInAttachmentMenuChatOrThrow(): AbleToAddInAttachmentMenuChat

asAbleToAddInAttachmentMenuChat

inline fun Chat.asAbleToAddInAttachmentMenuChat(): AbleToAddInAttachmentMenuChat?

inline fun Chat.asBot(): Bot?

inline fun Chat.asChannelChat(): ChannelChat?

inline fun Chat.asCommonBot(): CommonBot?

inline fun Chat.asCommonUser(): CommonUser?

inline fun Chat.asExtendedBot(): ExtendedBot?

asExtendedChannelChat

inline fun Chat.asExtendedChannelChat(): ExtendedChannelChat?

inline fun Chat.asExtendedChat(): ExtendedChat?

asExtendedGroupChat

inline fun Chat.asExtendedGroupChat(): ExtendedGroupChat?

asExtendedPrivateChat

inline fun Chat.asExtendedPrivateChat(): ExtendedPrivateChat?

asExtendedPublicChat

inline fun Chat.asExtendedPublicChat(): ExtendedPublicChat?

asExtendedSupergroupChat

inline fun Chat.asExtendedSupergroupChat(): ExtendedSupergroupChat?

inline fun Chat.asGroupChat(): GroupChat?

asPossiblyPremiumChat

inline fun Chat.asPossiblyPremiumChat(): PossiblyPremiumChat?

inline fun Chat.asPrivateChat(): PrivateChat?

inline fun Chat.asPublicChat(): PublicChat?

asSupergroupChat

inline fun Chat.asSupergroupChat(): SupergroupChat?

asSuperPublicChat

inline fun Chat.asSuperPublicChat(): SuperPublicChat?

asUnknownChatType

inline fun Chat.asUnknownChatType(): UnknownChatType?

inline fun Chat.asUser(): User?

inline fun Chat.asUsernameChat(): UsernameChat?

inline fun Chat.botOrNull(): Bot?

inline fun Chat.botOrThrow(): Bot

channelChatImplOrNull

inline fun Chat.channelChatImplOrNull(): ChannelChatImpl?

channelChatImplOrThrow

inline fun Chat.channelChatImplOrThrow(): ChannelChatImpl

channelChatOrNull

inline fun Chat.channelChatOrNull(): ChannelChat?

channelChatOrThrow

inline fun Chat.channelChatOrThrow(): ChannelChat

val Chat.chatLink: String?

Link which can be used as by any user to get access to Chat. Returns null in case when there are no known way to build link

commonBotOrNull

inline fun Chat.commonBotOrNull(): CommonBot?

commonBotOrThrow

inline fun Chat.commonBotOrThrow(): CommonBot

commonUserOrNull

inline fun Chat.commonUserOrNull(): CommonUser?

commonUserOrThrow

inline fun Chat.commonUserOrThrow(): CommonUser

extendedBotOrNull

inline fun Chat.extendedBotOrNull(): ExtendedBot?

extendedBotOrThrow

inline fun Chat.extendedBotOrThrow(): ExtendedBot

extendedChannelChatImplOrNull

inline fun Chat.extendedChannelChatImplOrNull(): ExtendedChannelChatImpl?

extendedChannelChatImplOrThrow

inline fun Chat.extendedChannelChatImplOrThrow(): ExtendedChannelChatImpl

extendedChannelChatOrNull

inline fun Chat.extendedChannelChatOrNull(): ExtendedChannelChat?

extendedChannelChatOrThrow

inline fun Chat.extendedChannelChatOrThrow(): ExtendedChannelChat

extendedChatOrNull

inline fun Chat.extendedChatOrNull(): ExtendedChat?

extendedChatOrThrow

inline fun Chat.extendedChatOrThrow(): ExtendedChat

extendedChatWithUsernameOrNull

inline fun Chat.extendedChatWithUsernameOrNull(): ExtendedChatWithUsername?

extendedChatWithUsernameOrThrow

inline fun Chat.extendedChatWithUsernameOrThrow(): ExtendedChatWithUsername

extendedForumChatImplOrNull

inline fun Chat.extendedForumChatImplOrNull(): ExtendedForumChatImpl?

extendedForumChatImplOrThrow

inline fun Chat.extendedForumChatImplOrThrow(): ExtendedForumChatImpl

extendedForumChatOrNull

inline fun Chat.extendedForumChatOrNull(): ExtendedForumChat?

extendedForumChatOrThrow

inline fun Chat.extendedForumChatOrThrow(): ExtendedForumChat

extendedGroupChatImplOrNull

inline fun Chat.extendedGroupChatImplOrNull(): ExtendedGroupChatImpl?

extendedGroupChatImplOrThrow

inline fun Chat.extendedGroupChatImplOrThrow(): ExtendedGroupChatImpl

extendedGroupChatOrNull

inline fun Chat.extendedGroupChatOrNull(): ExtendedGroupChat?

extendedGroupChatOrThrow

inline fun Chat.extendedGroupChatOrThrow(): ExtendedGroupChat

extendedPrivateChatImplOrNull

inline fun Chat.extendedPrivateChatImplOrNull(): ExtendedPrivateChatImpl?

extendedPrivateChatImplOrThrow

inline fun Chat.extendedPrivateChatImplOrThrow(): ExtendedPrivateChatImpl

extendedPrivateChatOrNull

inline fun Chat.extendedPrivateChatOrNull(): ExtendedPrivateChat?

extendedPrivateChatOrThrow

inline fun Chat.extendedPrivateChatOrThrow(): ExtendedPrivateChat

extendedPublicChatOrNull

inline fun Chat.extendedPublicChatOrNull(): ExtendedPublicChat?

extendedPublicChatOrThrow

inline fun Chat.extendedPublicChatOrThrow(): ExtendedPublicChat

extendedSupergroupChatImplOrNull

inline fun Chat.extendedSupergroupChatImplOrNull(): ExtendedSupergroupChatImpl?

extendedSupergroupChatImplOrThrow

inline fun Chat.extendedSupergroupChatImplOrThrow(): ExtendedSupergroupChatImpl

extendedSupergroupChatOrNull

inline fun Chat.extendedSupergroupChatOrNull(): ExtendedSupergroupChat?

extendedSupergroupChatOrThrow

inline fun Chat.extendedSupergroupChatOrThrow(): ExtendedSupergroupChat

forumChatImplOrNull

inline fun Chat.forumChatImplOrNull(): ForumChatImpl?

forumChatImplOrThrow

inline fun Chat.forumChatImplOrThrow(): ForumChatImpl

forumChatOrNull

inline fun Chat.forumChatOrNull(): ForumChat?

forumChatOrThrow

inline fun Chat.forumChatOrThrow(): ForumChat

groupChatImplOrNull

inline fun Chat.groupChatImplOrNull(): GroupChatImpl?

groupChatImplOrThrow

inline fun Chat.groupChatImplOrThrow(): GroupChatImpl

groupChatOrNull

inline fun Chat.groupChatOrNull(): GroupChat?

groupChatOrThrow

inline fun Chat.groupChatOrThrow(): GroupChat

ifAbleToAddInAttachmentMenuChat

inline fun <T> Chat.ifAbleToAddInAttachmentMenuChat(block: (AbleToAddInAttachmentMenuChat) -> T): T?

inline fun <T> Chat.ifBot(block: (Bot) -> T): T?

inline fun <T> Chat.ifChannelChat(block: (ChannelChat) -> T): T?

ifChannelChatImpl

inline fun <T> Chat.ifChannelChatImpl(block: (ChannelChatImpl) -> T): T?

inline fun <T> Chat.ifCommonBot(block: (CommonBot) -> T): T?

inline fun <T> Chat.ifCommonUser(block: (CommonUser) -> T): T?

inline fun <T> Chat.ifExtendedBot(block: (ExtendedBot) -> T): T?

ifExtendedChannelChat

inline fun <T> Chat.ifExtendedChannelChat(block: (ExtendedChannelChat) -> T): T?

ifExtendedChannelChatImpl

inline fun <T> Chat.ifExtendedChannelChatImpl(block: (ExtendedChannelChatImpl) -> T): T?

inline fun <T> Chat.ifExtendedChat(block: (ExtendedChat) -> T): T?

ifExtendedChatWithUsername

inline fun <T> Chat.ifExtendedChatWithUsername(block: (ExtendedChatWithUsername) -> T): T?

ifExtendedForumChat

inline fun <T> Chat.ifExtendedForumChat(block: (ExtendedForumChat) -> T): T?

ifExtendedForumChatImpl

inline fun <T> Chat.ifExtendedForumChatImpl(block: (ExtendedForumChatImpl) -> T): T?

ifExtendedGroupChat

inline fun <T> Chat.ifExtendedGroupChat(block: (ExtendedGroupChat) -> T): T?

ifExtendedGroupChatImpl

inline fun <T> Chat.ifExtendedGroupChatImpl(block: (ExtendedGroupChatImpl) -> T): T?

ifExtendedPrivateChat

inline fun <T> Chat.ifExtendedPrivateChat(block: (ExtendedPrivateChat) -> T): T?

ifExtendedPrivateChatImpl

inline fun <T> Chat.ifExtendedPrivateChatImpl(block: (ExtendedPrivateChatImpl) -> T): T?

ifExtendedPublicChat

inline fun <T> Chat.ifExtendedPublicChat(block: (ExtendedPublicChat) -> T): T?

ifExtendedSupergroupChat

inline fun <T> Chat.ifExtendedSupergroupChat(block: (ExtendedSupergroupChat) -> T): T?

ifExtendedSupergroupChatImpl

inline fun <T> Chat.ifExtendedSupergroupChatImpl(block: (ExtendedSupergroupChatImpl) -> T): T?

inline fun <T> Chat.ifForumChat(block: (ForumChat) -> T): T?

ifForumChatImpl

inline fun <T> Chat.ifForumChatImpl(block: (ForumChatImpl) -> T): T?

inline fun <T> Chat.ifGroupChat(block: (GroupChat) -> T): T?

ifGroupChatImpl

inline fun <T> Chat.ifGroupChatImpl(block: (GroupChatImpl) -> T): T?

ifPossiblyPremiumChat

inline fun <T> Chat.ifPossiblyPremiumChat(block: (PossiblyPremiumChat) -> T): T?

inline fun <T> Chat.ifPrivateChat(block: (PrivateChat) -> T): T?

ifPrivateChatImpl

inline fun <T> Chat.ifPrivateChatImpl(block: (PrivateChatImpl) -> T): T?

inline fun <T> Chat.ifPublicChat(block: (PublicChat) -> T): T?

ifSupergroupChat

inline fun <T> Chat.ifSupergroupChat(block: (SupergroupChat) -> T): T?

ifSupergroupChatImpl

inline fun <T> Chat.ifSupergroupChatImpl(block: (SupergroupChatImpl) -> T): T?

ifSuperPublicChat

inline fun <T> Chat.ifSuperPublicChat(block: (SuperPublicChat) -> T): T?

ifUnknownChatType

inline fun <T> Chat.ifUnknownChatType(block: (UnknownChatType) -> T): T?

ifUnknownExtendedChat

inline fun <T> Chat.ifUnknownExtendedChat(block: (UnknownExtendedChat) -> T): T?

inline fun <T> Chat.ifUser(block: (User) -> T): T?

inline fun <T> Chat.ifUsernameChat(block: (UsernameChat) -> T): T?

fun WithOptionalLanguageCode?.javaLocale(): Locale?

inline fun User.mention(parts: TextSourcesList): TextMentionTextSource

inline fun User.mention(text: String): TextMentionTextSource

possiblyPremiumChatOrNull

inline fun Chat.possiblyPremiumChatOrNull(): PossiblyPremiumChat?

possiblyPremiumChatOrThrow

inline fun Chat.possiblyPremiumChatOrThrow(): PossiblyPremiumChat

privateChatImplOrNull

inline fun Chat.privateChatImplOrNull(): PrivateChatImpl?

privateChatImplOrThrow

inline fun Chat.privateChatImplOrThrow(): PrivateChatImpl

privateChatOrNull

inline fun Chat.privateChatOrNull(): PrivateChat?

privateChatOrThrow

inline fun Chat.privateChatOrThrow(): PrivateChat

publicChatOrNull

inline fun Chat.publicChatOrNull(): PublicChat?

publicChatOrThrow

inline fun Chat.publicChatOrThrow(): PublicChat

requireAbleToAddInAttachmentMenuChat

inline fun Chat.requireAbleToAddInAttachmentMenuChat(): AbleToAddInAttachmentMenuChat

inline fun Chat.requireBot(): Bot

requireChannelChat

inline fun Chat.requireChannelChat(): ChannelChat

requireCommonBot

inline fun Chat.requireCommonBot(): CommonBot

requireCommonUser

inline fun Chat.requireCommonUser(): CommonUser

requireExtendedBot

inline fun Chat.requireExtendedBot(): ExtendedBot

requireExtendedChannelChat

inline fun Chat.requireExtendedChannelChat(): ExtendedChannelChat

requireExtendedChat

inline fun Chat.requireExtendedChat(): ExtendedChat

requireExtendedGroupChat

inline fun Chat.requireExtendedGroupChat(): ExtendedGroupChat

requireExtendedPrivateChat

inline fun Chat.requireExtendedPrivateChat(): ExtendedPrivateChat

requireExtendedPublicChat

inline fun Chat.requireExtendedPublicChat(): ExtendedPublicChat

requireExtendedSupergroupChat

inline fun Chat.requireExtendedSupergroupChat(): ExtendedSupergroupChat

requireGroupChat

inline fun Chat.requireGroupChat(): GroupChat

requirePossiblyPremiumChat

inline fun Chat.requirePossiblyPremiumChat(): PossiblyPremiumChat

requirePrivateChat

inline fun Chat.requirePrivateChat(): PrivateChat

requirePublicChat

inline fun Chat.requirePublicChat(): PublicChat

requireSupergroupChat

inline fun Chat.requireSupergroupChat(): SupergroupChat

requireSuperPublicChat

inline fun Chat.requireSuperPublicChat(): SuperPublicChat

requireUnknownChatType

inline fun Chat.requireUnknownChatType(): UnknownChatType

inline fun Chat.requireUser(): User

requireUsernameChat

inline fun Chat.requireUsernameChat(): UsernameChat

supergroupChatImplOrNull

inline fun Chat.supergroupChatImplOrNull(): SupergroupChatImpl?

supergroupChatImplOrThrow

inline fun Chat.supergroupChatImplOrThrow(): SupergroupChatImpl

supergroupChatOrNull

inline fun Chat.supergroupChatOrNull(): SupergroupChat?

supergroupChatOrThrow

inline fun Chat.supergroupChatOrThrow(): SupergroupChat

superPublicChatOrNull

inline fun Chat.superPublicChatOrNull(): SuperPublicChat?

superPublicChatOrThrow

inline fun Chat.superPublicChatOrThrow(): SuperPublicChat

unknownChatTypeOrNull

inline fun Chat.unknownChatTypeOrNull(): UnknownChatType?

unknownChatTypeOrThrow

inline fun Chat.unknownChatTypeOrThrow(): UnknownChatType

unknownExtendedChatOrNull

inline fun Chat.unknownExtendedChatOrNull(): UnknownExtendedChat?

unknownExtendedChatOrThrow

inline fun Chat.unknownExtendedChatOrThrow(): UnknownExtendedChat

val User.userLink: String

usernameChatOrNull

inline fun Chat.usernameChatOrNull(): UsernameChat?

usernameChatOrThrow

inline fun Chat.usernameChatOrThrow(): UsernameChat

inline fun Chat.userOrNull(): User?

inline fun Chat.userOrThrow(): User

whenAbleToAddInAttachmentMenuChat

inline fun <T> Chat.whenAbleToAddInAttachmentMenuChat(block: (AbleToAddInAttachmentMenuChat) -> T): T?

inline fun <T> Chat.whenBot(block: (Bot) -> T): T?

whenChannelChat

inline fun <T> Chat.whenChannelChat(block: (ChannelChat) -> T): T?

inline fun <T> Chat.whenCommonBot(block: (CommonBot) -> T): T?

inline fun <T> Chat.whenCommonUser(block: (CommonUser) -> T): T?

whenExtendedBot

inline fun <T> Chat.whenExtendedBot(block: (ExtendedBot) -> T): T?

whenExtendedChannelChat

inline fun <T> Chat.whenExtendedChannelChat(block: (ExtendedChannelChat) -> T): T?

whenExtendedChat

inline fun <T> Chat.whenExtendedChat(block: (ExtendedChat) -> T): T?

whenExtendedGroupChat

inline fun <T> Chat.whenExtendedGroupChat(block: (ExtendedGroupChat) -> T): T?

whenExtendedPrivateChat

inline fun <T> Chat.whenExtendedPrivateChat(block: (ExtendedPrivateChat) -> T): T?

whenExtendedPublicChat

inline fun <T> Chat.whenExtendedPublicChat(block: (ExtendedPublicChat) -> T): T?

whenExtendedSupergroupChat

inline fun <T> Chat.whenExtendedSupergroupChat(block: (ExtendedSupergroupChat) -> T): T?

inline fun <T> Chat.whenGroupChat(block: (GroupChat) -> T): T?

whenPossiblyPremiumChat

inline fun <T> Chat.whenPossiblyPremiumChat(block: (PossiblyPremiumChat) -> T): T?

whenPrivateChat

inline fun <T> Chat.whenPrivateChat(block: (PrivateChat) -> T): T?

inline fun <T> Chat.whenPublicChat(block: (PublicChat) -> T): T?

whenSupergroupChat

inline fun <T> Chat.whenSupergroupChat(block: (SupergroupChat) -> T): T?

whenSuperPublicChat

inline fun <T> Chat.whenSuperPublicChat(block: (SuperPublicChat) -> T): T?

whenUnknownChatType

inline fun <T> Chat.whenUnknownChatType(block: (UnknownChatType) -> T): T?

inline fun <T> Chat.whenUser(block: (User) -> T): T?

whenUsernameChat

inline fun <T> Chat.whenUsernameChat(block: (UsernameChat) -> T): T?