stream-chat-android-ui-common/io.getstream.chat.android.ui.common.feature.messages.composer.mention/Mention

Mention

interface Mention

Represents a mention token inside the message composer.

Built-in types are User, Channel, Here, Role, and Group. You can extend this interface to define custom mentions if needed.

Inheritors

Types

object Channel : Mention

An @channel mention: notifies every channel member.

data class Group(val group: UserGroup) : Mention

A user-group mention.

object Here : Mention

An @here mention: notifies online channel members.

data class Role(val role: String) : Mention

A role mention (e.g. @admin).

data class User(val user: User) : Mention

A user mention.

Properties

abstract val display: String

The primary display text of the mention, used when inserting a token into the composer. Implementations must guarantee a non-empty value so autocomplete and linkification produce a stable @token even when the underlying source lacks a human-readable name.

open val tokens: List<String>

All candidate @<token> forms that should match this mention in rendered message text.

abstract val type: MentionType

The type of the mention.