net.dv8tion.jda.api.entities.channel.forums.BaseForumTag 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.entities.channel.forums;

import net.dv8tion.jda.api.entities.emoji.CustomEmoji;
import net.dv8tion.jda.api.entities.emoji.EmojiUnion;
import net.dv8tion.jda.api.entities.emoji.UnicodeEmoji;
import net.dv8tion.jda.api.utils.data.DataObject;
import net.dv8tion.jda.api.utils.data.SerializableData;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Information describing a forum tag.
 * 
This is an abstraction used to simplify managing tags.
 *
 * @see ForumTag
 * @see ForumTagData
 * @see ForumTagSnowflake
 */
public interface BaseForumTag extends SerializableData
{
    /**
     * The name of the tag.
     *
     * @return The name
     */
    @Nonnull
    String getName();

    /**
     * Whether this tag can only be applied by moderators with the {@link net.dv8tion.jda.api.Permission#MANAGE_THREADS MANAGE_THREADS} permission (aka Manage Posts).
     *
     * @return True, if this tag can only be applied by moderators with the required permission
     */
    boolean isModerated();

    /**
     * The emoji used as the tag icon.
     * 
For custom emoji, this will have an empty name and {@link CustomEmoji#isAnimated()} is always {@code false}, due to discord chicanery.
     *
     * @return {@link EmojiUnion} representing the tag emoji, or null if no emoji is applied.
     */
    @Nullable
    EmojiUnion getEmoji();

    @Nonnull
    @Override
    default DataObject toData()
    {
        DataObject json = DataObject.empty()
                .put("name", getName())
                .put("moderated", isModerated());
        EmojiUnion emoji = getEmoji();
        if (emoji instanceof UnicodeEmoji)
            json.put("emoji_name", emoji.getName());
        else if (emoji instanceof CustomEmoji)
            json.put("emoji_id", ((CustomEmoji) emoji).getId());
        return json;
    }
}