/
MessagePaginationAction.java
82 lines (77 loc) · 2.75 KB
/
MessagePaginationAction.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.requests.restaction.pagination;
import net.dv8tion.jda.api.entities.ChannelType;
import net.dv8tion.jda.api.entities.Message;
import net.dv8tion.jda.api.entities.MessageChannel;
import javax.annotation.Nonnull;
/**
* {@link PaginationAction PaginationAction} that paginates the message history endpoint.
* <br>Note that this implementation is not considered thread-safe as modifications to the cache are not done
* with a lock. Calling methods on this class from multiple threads is not recommended.
*
* <p><b>Must provide not-null {@link net.dv8tion.jda.api.entities.MessageChannel MessageChannel} to compile a valid
* pagination route.</b>
*
* <h2>Limits:</h2>
* Minimum - 1
* <br>Maximum - 100
*
* <h2>Example</h2>
* <pre><code>
* /**
* * Iterates messages in an async stream and stops once the limit has been reached.
* */
* public static void onEachMessageAsync(MessageChannel channel, {@literal Consumer<Message>} consumer, int limit)
* {
* if (limit{@literal <} 1)
* return;
* MessagePaginationAction action = channel.getIterableHistory();
* AtomicInteger counter = new AtomicInteger(limit);
* action.forEachAsync( (message){@literal ->}
* {
* consumer.accept(message);
* // if false the iteration is terminated; else it continues
* return counter.decrementAndGet() == 0;
* });
* }
* </code></pre>
*
* @since 3.1
*
* @see MessageChannel#getIterableHistory()
*/
public interface MessagePaginationAction extends PaginationAction<Message, MessagePaginationAction>
{
/**
* The {@link net.dv8tion.jda.api.entities.ChannelType ChannelType} of
* the targeted {@link net.dv8tion.jda.api.entities.MessageChannel MessageChannel}.
*
* @return {@link net.dv8tion.jda.api.entities.ChannelType ChannelType}
*/
@Nonnull
default ChannelType getType()
{
return getChannel().getType();
}
/**
* The targeted {@link net.dv8tion.jda.api.entities.MessageChannel MessageChannel}
*
* @return The MessageChannel instance
*/
@Nonnull
MessageChannel getChannel();
}