net.dv8tion.jda

Class MessageHistory

java.lang.Object

net.dv8tion.jda.MessageHistory

public class MessageHistory
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MessageHistory(JDA api, PrivateChannel channel)
MessageHistory(JDA api, TextChannel channel)

Method Summary

Modifier and Type	Method and Description
java.util.List<Message>	getRecent() Returns all already by the retrieve methods pulled messages of this history
java.util.List<Message>	retrieve() Queues the next set of 100 Messages and returns them If the end of the chat was already reached, this function returns null
java.util.List<Message>	retrieve(int amount) Queues the next set of Messages and returns them If the end of the chat was already reached, this function returns null
java.util.List<Message>	retrieveAll() Gets all available Messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageHistory

public MessageHistory(JDA api,
                      TextChannel channel)

MessageHistory

public MessageHistory(JDA api,
                      PrivateChannel channel)

Method Detail

retrieveAll

public java.util.List<Message> retrieveAll()

Gets all available Messages. Can be called multiple times and always returns the full set

Returns:

all available Messages

getRecent

public java.util.List<Message> getRecent()

Returns all already by the retrieve methods pulled messages of this history

Returns:

the list of already pulled messages

retrieve

public java.util.List<Message> retrieve()

Queues the next set of 100 Messages and returns them If the end of the chat was already reached, this function returns null

Returns:

a list of the next 100 Messages (max), or null if at end of chat

retrieve

public java.util.List<Message> retrieve(int amount)

Queues the next set of Messages and returns them If the end of the chat was already reached, this function returns null

Parameters:

amount - the amount to Messages to queue

Returns:

a list of the next [amount] Messages (max), or null if at end of chat