SendbirdUIKit/com.sendbird.uikit.modules.components/BaseMessageListComponent

BaseMessageListComponent

abstract class BaseMessageListComponent<LA : BaseMessageListAdapter?>

Types

Link copied to clipboard
open class Params
A collection of parameters, which can be applied to a default View.

Functions

Link copied to clipboard
open fun animateMessage(@NonNull message: BaseMessage)
Animates the message on the message list.
Link copied to clipboard
@Nullable
open fun getRecyclerView(): RecyclerView
Returns the recycler view used in the list component by default.
Link copied to clipboard
@Nullable
open fun getRootView(): View
Returns the view created by onCreateView.
Link copied to clipboard
@NonNull
protected open fun getTooltipMessage(@NonNull context: Context, count: Int): String
Returns the text on the tooltip.
Link copied to clipboard
open fun moveToFocusedMessage(viewPoint: Long, @Nullable shouldAnimateMessage: BaseMessage)
Moves the screen to the focused message, based on the created timestamp of message.
Link copied to clipboard
open fun notifyChannelChanged(@NonNull channel: GroupChannel)
Handles a new channel when data has changed.
Link copied to clipboard
open fun notifyDataSetChanged(@NonNull messageList: List<BaseMessage>, @NonNull channel: GroupChannel, @Nullable callback: OnMessageListUpdateHandler)
Handles the data needed to draw the message list has changed.
Link copied to clipboard
open fun notifyMessagesFilled(scrollToFirstIfPossible: Boolean)
After the messages are updated, calculate the current position and re-calculate the position of the scroll.
Link copied to clipboard
open fun notifyOtherMessageReceived(showTooltipIfPossible: Boolean)
After receiving the message from another user, handle the necessary tasks at this component.
Link copied to clipboard
open fun notifyTypingIndicatorUpdated(scrollToFirstIfPossible: Boolean)
After updating the typing indicator, determines whether to scroll to the bottom.
Link copied to clipboard
@NonNull
open fun onCreateView(@NonNull context: Context, @NonNull inflater: LayoutInflater, @NonNull parent: ViewGroup, @Nullable args: Bundle): View
Called after the component was created to make views.
Link copied to clipboard
protected open fun onEmojiReactionClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage, @NonNull reactionKey: String)
Called when the emoji reaction of the message is clicked.
Link copied to clipboard
protected open fun onEmojiReactionLongClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage, @NonNull reactionKey: String)
Called when the emoji reaction of the message is long-clicked.
Link copied to clipboard
protected open fun onEmojiReactionMoreButtonClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage)
Called when the button to see more emojis on the message is clicked.
Link copied to clipboard
protected open fun onFeedbackRatingClicked(@NonNull message: BaseMessage, @NonNull rating: FeedbackRating)
Called when the feedback rating of the message is clicked.
Link copied to clipboard
protected open fun onMessageClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage)
Called when the item of the message list is clicked.
Link copied to clipboard
protected open fun onMessageLongClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage)
Called when the item of the message list is long-clicked.
Link copied to clipboard
protected open fun onMessageMentionClicked(@NonNull view: View, position: Int, @NonNull user: User)
Called when the mentioned user of the message is clicked.
Link copied to clipboard
protected open fun onMessageProfileClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage)
Called when the profile view of the message is clicked.
Link copied to clipboard
protected open fun onMessageProfileLongClicked(@NonNull view: View, position: Int, @NonNull message: BaseMessage)
Called when the profile view of the message is long-clicked.
Link copied to clipboard
protected open fun onMessageTooltipClicked(@NonNull view: View)
Called when the tooltip view is clicked.
Link copied to clipboard
protected open fun onScrollBottomButtonClicked(@NonNull view: View)
Called when the button to scroll to the bottom is clicked.
Link copied to clipboard
protected open fun onScrollFirstButtonClicked(@NonNull view: View): Boolean
Called when the button to scroll to the first position is clicked.
Link copied to clipboard
open fun scrollToBottom()
Scrolls to the bottom of the message list.
Link copied to clipboard
open fun scrollToFirst()
Scrolls to the first position of the recycler view.
Link copied to clipboard
open fun setOnEmojiReactionClickListener(@Nullable emojiReactionClickListener: OnEmojiReactionClickListener)
Register a callback to be invoked when the emoji reaction of the message is clicked.
Link copied to clipboard
open fun setOnEmojiReactionLongClickListener(@Nullable emojiReactionLongClickListener: OnEmojiReactionLongClickListener)
Register a callback to be invoked when the emoji reaction of the message is long-clicked.
open fun setOnEmojiReactionMoreButtonClickListener(@Nullable emojiReactionMoreButtonClickListener: OnItemClickListener<BaseMessage>)
Register a callback to be invoked when the button to see more emojis on the message is clicked.
Link copied to clipboard
open fun setOnFeedbackRatingClickListener(@Nullable feedbackRatingClickListener: OnFeedbackRatingClickListener)
Register a callback to be invoked when the feedback rating of the message is clicked.
Link copied to clipboard
open fun setOnMessageClickListener(@Nullable messageClickListener: OnItemClickListener<BaseMessage>)
Register a callback to be invoked when the message is clicked.
Link copied to clipboard
open fun setOnMessageLongClickListener(@Nullable messageLongClickListener: OnItemLongClickListener<BaseMessage>)
Register a callback to be invoked when the message is long-clicked.
Link copied to clipboard
open fun setOnMessageMentionClickListener(@Nullable messageMentionClickListener: OnItemClickListener<User>)
Register a callback to be invoked when the mentioned user of the message is clicked.
Link copied to clipboard
open fun setOnMessageProfileClickListener(@Nullable messageProfileClickListener: OnItemClickListener<BaseMessage>)
Register a callback to be invoked when the profile view of the message is clicked.
Link copied to clipboard
open fun setOnMessageProfileLongClickListener(@Nullable messageProfileLongClickListener: OnItemLongClickListener<BaseMessage>)
Register a callback to be invoked when the profile view of the message is long-clicked.
Link copied to clipboard
open fun setOnScrollBottomButtonClickListener(@Nullable scrollBottomButtonClickListener: View.OnClickListener)
Register a callback to be invoked when the button to scroll to the bottom is clicked.
Link copied to clipboard
open fun setOnScrollFirstButtonClickListener(@Nullable scrollFirstButtonClickListener: OnConsumableClickListener)
Register a callback to be invoked when the button to scroll to the first position is clicked.
Link copied to clipboard
open fun setOnTooltipClickListener(@Nullable tooltipClickListener: View.OnClickListener)
Register a callback to be invoked when the tooltip view is clicked.
Link copied to clipboard
open fun setPagedDataLoader(@NonNull pagedDataLoader: OnPagedDataLoader<List<BaseMessage>>)
Sets the paged data loader for message list.

Properties

Link copied to clipboard
@Nullable
@get:Nullable
open var adapter: LA
Link copied to clipboard

Inheritors

Link copied to clipboard
Link copied to clipboard