Skip to main content
Version: v6

Pinned Message List

PinnedMessageListView is a UI Component that shows a list of pinned messages.

Light ModeDark Mode
Light modeDark mode


You can add this View via XML:

android:layout_height="match_parent" />

We recommend using this view with its ViewModel, which supplies it with data from the Stream API.

The basic setup of the ViewModel and connecting it to the View is done the following way:

val viewModel: PinnedMessageListViewModel by viewModels {
PinnedMessageListViewModelFactory(cid = "messaging:123")
viewModel.bindView(pinnedMessageListView, viewLifecycleOwner)

From that point, you should be able to see the list of pinned messages.


bindView sets listeners on the View and the ViewModel. Any additional listeners should be set after calling bindView.

Handling Actions

PinnedMessageListView allows you to configure certain actions on it:

pinnedMessageListView.setPinnedMessageSelectedListener { message ->
// Handle a pinned message item being clicked

The full list of available listeners is available here.

Did you find this page helpful?