libtd-ktx / kotlinx.telegram.coroutines / getChatHistory

getChatHistory

suspend fun TelegramFlow.getChatHistory(chatId: Long, fromMessageId: Long, offset: Int, limit: Int, onlyLocal: Boolean): Messages

Suspend function, which returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing messageId). For optimal performance the number of returned messages is chosen by the library. This is an offline request if onlyLocal is true.

Parameters

chatId - Chat identifier.

fromMessageId - Identifier of the message starting from which history must be fetched; use 0 to get results from the last message.

offset - Specify 0 to get results from exactly the fromMessageId or a negative offset up to 99 to get additionally some newer messages.

limit - The maximum number of messages to be returned; must be positive and can’t be greater than 100. If the offset is negative, the limit must be greater or equal to -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached.

onlyLocal - If true, returns only messages that are available locally without sending network requests.

Return Messages Contains a list of messages.