docs/dev.inmo.tgbotapi.types/ChatId

ChatId

@Serializable(with = ChatIdentifierSerializer::class)

@JvmInline

value class ChatId(val chatId: RawChatId) : IdChatIdentifier(source)

Numeric Telegram chat identifier without embedded request context.

Constructors

ChatId

constructor(chatId: RawChatId)

Properties

businessConnectionId

open val businessConnectionId: BusinessConnectionId?

Business connection carried as default request context, when available.

businessConnectionId

val ChatIdentifier.businessConnectionId: BusinessConnectionId?

Returns the embedded business connection, or null when no business connection is available.

chatId

open override val chatId: RawChatId

Raw numeric identifier.

chatLink

val IdChatIdentifier.chatLink: String

directMessageThreadId

open val directMessageThreadId: DirectMessageThreadId?

Direct-message thread carried as default request context, when available.

directMessageThreadId

val ChatIdentifier.directMessageThreadId: DirectMessageThreadId?

Returns the embedded channel direct-message thread, or null when no direct-message thread is available.

directMessageThreadIdOrMessageThreadIdAsDirectMessageThreadId

val ChatIdentifier.directMessageThreadIdOrMessageThreadIdAsDirectMessageThreadId: DirectMessageThreadId?

ephemeralMessageId

open val ephemeralMessageId: EphemeralMessageId?

Existing ephemeral message targeted by an operation, when available.

ephemeralMessageId

val ChatIdentifier.ephemeralMessageId: EphemeralMessageId?

Returns the embedded ephemeral-message identifier, or null when no identifier is available.

receiverUser

open val receiverUser: UserId?

User receiving an ephemeral message, when available.

receiverUser

val ChatIdentifier.receiverUser: UserId?

Returns the embedded ephemeral-message receiver, or null when no receiver is available.

threadId

open val threadId: MessageThreadId?

Message thread carried as default request context, when available.

threadId

val ChatIdentifier.threadId: MessageThreadId?

Returns the embedded message thread, or null when no message thread is available.

threadIdOrDirectMessageThreadIdAsThreadId

val ChatIdentifier.threadIdOrDirectMessageThreadIdAsThreadId: MessageThreadId?

userLink

val UserId.userLink: String

https://core.telegram.org/bots/api#formatting-options

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

ephemeralChatIdOrNull

inline fun ChatIdentifier.ephemeralChatIdOrNull(): EphemeralChatId?

ephemeralChatIdOrThrow

inline fun ChatIdentifier.ephemeralChatIdOrThrow(): EphemeralChatId

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?

ifEphemeralChatId

inline fun <T> ChatIdentifier.ifEphemeralChatId(block: (EphemeralChatId) -> T): T?

ifIdChatIdentifier

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

ifUsername

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

link

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

mentionTextSource

fun UserId.mentionTextSource(text: String): TextMentionTextSource

fun UserId.mentionTextSource(parts: TextSourcesList): TextMentionTextSource

toBusinessChatId

fun IdChatIdentifier.toBusinessChatId(businessConnectionId: BusinessConnectionId): BusinessChatId

Replaces embedded request context with the supplied businessConnectionId.

toChatId

fun IdChatIdentifier.toChatId(): ChatId

Drops all embedded request context and returns a plain ChatId.

toChatIdWithChannelDirectMessageThreadId

fun IdChatIdentifier.toChatIdWithChannelDirectMessageThreadId(threadId: DirectMessageThreadId): ChatIdWithChannelDirectMessageThreadId

Replaces embedded request context with the supplied channel direct-message threadId.

toChatWithThreadId

fun IdChatIdentifier.toChatWithThreadId(threadId: MessageThreadId): ChatIdWithThreadId

Replaces embedded request context with the supplied message threadId.

toEphemeralChatId

fun IdChatIdentifier.toEphemeralChatId(receiverUser: UserId, ephemeralMessageId: EphemeralMessageId? = null): EphemeralChatId

Replaces embedded request context with ephemeral delivery context for receiverUser.

usernameOrNull

inline fun ChatIdentifier.usernameOrNull(): Username?

usernameOrThrow

inline fun ChatIdentifier.usernameOrThrow(): Username