docs/dev.inmo.tgbotapi.types/Username

Username

@Serializable(with = ChatIdentifierSerializer::class)

value class Username(val full: String) : ChatIdentifier(source)

A value class representing a username that always starts with the "@" symbol.

This class is used to encapsulate the concept of a username, enforce its format, and ensure consistency when dealing with usernames throughout the application.

Throws

IllegalArgumentException

if the provided full value doesn't start with "@" during initialization.

Constructors

Username

constructor(full: String)

Types

Companion

object Companion

Properties

businessConnectionId

val ChatIdentifier.businessConnectionId: BusinessConnectionId?

deepLinkPrefix

val Username.deepLinkPrefix: String

directMessageThreadId

val ChatIdentifier.directMessageThreadId: DirectMessageThreadId?

full

val full: String

The full username string, guaranteed to start with "@".

startattachPrefix

val Username.startattachPrefix: String

threadId

val ChatIdentifier.threadId: MessageThreadId?

username

val username: String

Retrieves the full username as a string.

usernameLink

val Username.usernameLink: String

withoutAt

val withoutAt: String

A property that returns the username string without the leading "@" symbol.

Functions

businessChatIdOrNull

inline fun ChatIdentifier.businessChatIdOrNull(): BusinessChatId?

businessChatIdOrThrow

inline fun ChatIdentifier.businessChatIdOrThrow(): BusinessChatId

chatIdOrNull

inline fun ChatIdentifier.chatIdOrNull(): ChatId?

chatIdOrThrow

inline fun ChatIdentifier.chatIdOrThrow(): ChatId

chatIdWithChannelDirectMessageThreadIdOrNull

inline fun ChatIdentifier.chatIdWithChannelDirectMessageThreadIdOrNull(): ChatIdWithChannelDirectMessageThreadId?

chatIdWithChannelDirectMessageThreadIdOrThrow

inline fun ChatIdentifier.chatIdWithChannelDirectMessageThreadIdOrThrow(): ChatIdWithChannelDirectMessageThreadId

chatIdWithThreadIdOrNull

inline fun ChatIdentifier.chatIdWithThreadIdOrNull(): ChatIdWithThreadId?

chatIdWithThreadIdOrThrow

inline fun ChatIdentifier.chatIdWithThreadIdOrThrow(): ChatIdWithThreadId

idChatIdentifierOrNull

inline fun ChatIdentifier.idChatIdentifierOrNull(): IdChatIdentifier?

idChatIdentifierOrThrow

inline fun ChatIdentifier.idChatIdentifierOrThrow(): IdChatIdentifier

ifBusinessChatId

inline fun <T> ChatIdentifier.ifBusinessChatId(block: (BusinessChatId) -> T): T?

ifChatId

inline fun <T> ChatIdentifier.ifChatId(block: (ChatId) -> T): T?

ifChatIdWithChannelDirectMessageThreadId

inline fun <T> ChatIdentifier.ifChatIdWithChannelDirectMessageThreadId(block: (ChatIdWithChannelDirectMessageThreadId) -> T): T?

ifChatIdWithThreadId

inline fun <T> ChatIdentifier.ifChatIdWithThreadId(block: (ChatIdWithThreadId) -> T): T?

ifIdChatIdentifier

inline fun <T> ChatIdentifier.ifIdChatIdentifier(block: (IdChatIdentifier) -> T): T?

ifUsername

inline fun <T> ChatIdentifier.ifUsername(block: (Username) -> T): T?

link

fun Username.link(threadId: MessageThreadId?): String

toString

open override fun toString(): String

usernameOrNull

inline fun ChatIdentifier.usernameOrNull(): Username?

usernameOrThrow

inline fun ChatIdentifier.usernameOrThrow(): Username