net.dv8tion.jda.api.requests.restaction.pagination.ThreadChannelPaginationAction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0

/*
 * 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.
 * 
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.
 *
 * Must provide not-null {@link IThreadContainer IThreadContainer} to compile a valid
 * pagination route.
 *
 * 
Limits:

 * Minimum - 1
 * 
Maximum - 100
 *
 * 
Example

 * 
{@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();
 *         }
 *     );
 * }
 * }
 *
 * @see    IThreadContainer#retrieveArchivedPublicThreadChannels()
 * @see    IThreadContainer#retrieveArchivedPrivateThreadChannels()
 * @see    IThreadContainer#retrieveArchivedPrivateJoinedThreadChannels()
 */
public interface ThreadChannelPaginationAction extends PaginationAction
{
    /**
     * The {@link IThreadContainerUnion} for this action
     * 
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();
    }
}