From 66914aefee3fb6177b11db97bbc5e6a30ebded98 Mon Sep 17 00:00:00 2001 From: Infi Date: Sat, 28 Sep 2024 11:14:05 +0200 Subject: [PATCH] chore: add kdoc to [loadMessages] fun Signed-off-by: Infi --- .../screens/chat/views/channel/ChannelScreenViewModel.kt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/app/src/main/java/chat/revolt/screens/chat/views/channel/ChannelScreenViewModel.kt b/app/src/main/java/chat/revolt/screens/chat/views/channel/ChannelScreenViewModel.kt index 26f875fc..e4a54363 100644 --- a/app/src/main/java/chat/revolt/screens/chat/views/channel/ChannelScreenViewModel.kt +++ b/app/src/main/java/chat/revolt/screens/chat/views/channel/ChannelScreenViewModel.kt @@ -390,6 +390,15 @@ class ChannelScreenViewModel @Inject constructor( } } + /** + * Load messages from the channel. If the channel is switched, the job will be cancelled. + * + * @param amount The amount of messages to load. + * @param before Load [amount] messages before this message ID. Do not use with [around] or [after]. + * @param after Load [amount] messages after this message ID. Do not use with [around] or [before]. + * @param around Load [amount] messages around this message ID. Do not use with [before] or [after]. + * @param ignoreExisting If true, messages that are already in the list will not be added again. Possible performance degradation. + */ fun loadMessages( amount: Int, before: String? = null,