/
ThreadChannelPaginationAction.java
81 lines (76 loc) · 3.06 KB
/
ThreadChannelPaginationAction.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
/*
* 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.Guild;
import net.dv8tion.jda.api.entities.channel.attribute.IThreadContainer;
import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
import net.dv8tion.jda.api.entities.channel.unions.IThreadContainerUnion;
import javax.annotation.Nonnull;
/**
* {@link PaginationAction PaginationAction} that paginates the thread members 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 IThreadContainer IThreadContainer} to compile a valid
* pagination route.</b>
*
* <p><b>Limits:</b><br>
* Minimum - 1
* <br>Maximum - 100
*
* <p><b>Example</b><br>
* <pre>{@code
* // Clean up all private threads older than 2 weeks
* public static void cleanupPrivateThreads(TextChannel channel) {
* // get 2-week offset
* long 2WeekAgoTimestamp = System.currentTimeMillis() - (14 * 24 * 60 * 60 * 1000);
* // get paginator
* ThreadChannelPaginationAction threads = channel.retrieveArchivedPrivateThreadChannels();
* // remove each thread older than 2 weeks
* threads.forEachAsync((thread) ->
* long threadArchiveTimestamp = thread.getTimeArchiveInfoLastModified().toInstant().toEpochMilli();
* if (threadArchiveTimestamp < 2WeeksAgoTimestamp) {
* thread.delete().reason("Cleaning up old private threads").queue();
* }
* );
* }
* }</pre>
*
* @see IThreadContainer#retrieveArchivedPublicThreadChannels()
* @see IThreadContainer#retrieveArchivedPrivateThreadChannels()
* @see IThreadContainer#retrieveArchivedPrivateJoinedThreadChannels()
*/
public interface ThreadChannelPaginationAction extends PaginationAction<ThreadChannel, ThreadChannelPaginationAction>
{
/**
* The {@link IThreadContainerUnion} for this action
* <br>This can also be used for casting down to more concrete types.
*
* @return {@link IThreadContainerUnion}
*/
@Nonnull
IThreadContainerUnion getChannel();
/**
* The current target {@link net.dv8tion.jda.api.entities.Guild Guild} for this ThreadChannelPaginationAction.
*
* @return The never-null target Guild
*/
@Nonnull
default Guild getGuild()
{
return getChannel().getGuild();
}
}