Package net.dv8tion.jda.core.entities

Class MessageHistory.MessageRetrieveAction

java.lang.Object

net.dv8tion.jda.core.requests.RestAction<MessageHistory>

net.dv8tion.jda.core.entities.MessageHistory.MessageRetrieveAction

Enclosing class:

MessageHistory

public static class MessageHistory.MessageRetrieveAction
extends RestAction<MessageHistory>

Constructs a MessageHistory object with initially retrieved Messages before or after a certain pivot message id.
Allows to limit the amount to retrieve for better performance!

Nested Class Summary

Nested classes/interfaces inherited from class net.dv8tion.jda.core.requests.RestAction

RestAction.EmptyRestAction<T>

Field Summary

Fields inherited from class net.dv8tion.jda.core.requests.RestAction

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Method Summary

Modifier and Type	Method	Description
MessageHistory.MessageRetrieveAction	limit(java.lang.Integer limit)	Limit between 1-100 messages that should be retrieved.

Methods inherited from class java.lang.Object

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

Methods inherited from class net.dv8tion.jda.core.requests.RestAction

complete, complete, completeAfter, getJDA, isPassContext, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setCheck, setPassContext, submit, submit, submitAfter, submitAfter

Method Detail

limit

public MessageHistory.MessageRetrieveAction limit(java.lang.Integer limit)

Limit between 1-100 messages that should be retrieved.

Parameters:

limit - The limit to use, or null to use default 50

Returns:

The current MessageRetrieveAction for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided limit is not between 1-100