net.dv8tion.jda.api.managers.CustomEmojiManager Maven / Gradle / Ivy

Go to download
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.managers;

import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.emoji.RichCustomEmoji;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Set;

/**
 * Manager providing functionality to update one or more fields for an {@link RichCustomEmoji}.
 *
 * Example
 * 
{@code
 * manager.setName("minn")
 *        .setRoles(null)
 *        .queue();
 * manager.reset(CustomEmojiManager.NAME | CustomEmojiManager.ROLES)
 *        .setName("dv8")
 *        .setRoles(roles)
 *        .queue();
 * }
 *
 * @see RichCustomEmoji#getManager()
 */
public interface CustomEmojiManager extends Manager
{
    /** Used to reset the name field */
    long NAME  = 1;
    /** Used to reset the roles field */
    long ROLES = 1 << 1;

    /**
     * Resets the fields specified by the provided bit-flag pattern.
     * You can specify a combination by using a bitwise OR concat of the flag constants.
     * 
Example: {@code manager.reset(CustomEmojiManager.NAME | CustomEmojiManager.ROLES);}
     *
     * Flag Constants:
     * 

     *     {@link #NAME}
     *     {@link #ROLES}
     * 
     *
     * @param  fields
     *         Integer value containing the flags to reset.
     *
     * @return CustomEmojiManager for chaining convenience
     */
    @Nonnull
    @Override
    CustomEmojiManager reset(long fields);

    /**
     * Resets the fields specified by the provided bit-flag patterns.
     * 
Example: {@code manager.reset(CustomEmojiManager.NAME, CustomEmojiManager.ROLES);}
     *
     * Flag Constants:
     * 

     *     {@link #NAME}
     *     {@link #ROLES}
     * 
     *
     * @param  fields
     *         Integer values containing the flags to reset.
     *
     * @return CustomEmojiManager for chaining convenience
     */
    @Nonnull
    @Override
    CustomEmojiManager reset(long... fields);

    /**
     * The {@link net.dv8tion.jda.api.entities.Guild Guild} this Manager's
     * {@link RichCustomEmoji} is in.
     * 
This is logically the same as calling {@code getEmoji().getGuild()}
     *
     * @return The parent {@link net.dv8tion.jda.api.entities.Guild Guild}
     */
    @Nonnull
    default Guild getGuild()
    {
        return getEmoji().getGuild();
    }

    /**
     * The target {@link RichCustomEmoji} that will be modified by this Manager
     *
     * @return The target emoji
     */
    @Nonnull
    RichCustomEmoji getEmoji();

    /**
     * Sets the name of the selected {@link RichCustomEmoji}.
     *
     * An emoji name must be between 2-32 characters long!
     * 
Emoji names may only be populated with alphanumeric (with underscore and dash).
     *
     * 
Example: {@code tatDab} or {@code fmgSUP}
     *
     * @param  name
     *         The new name for the selected {@link RichCustomEmoji}
     *
     * @throws IllegalArgumentException
     *         If the provided name is {@code null} or not between 2-32 characters long
     *
     * @return CustomEmojiManager for chaining convenience
     */
    @Nonnull
    @CheckReturnValue
    CustomEmojiManager setName(@Nonnull String name);

    /**
     * Sets the restriction roles of the selected {@link RichCustomEmoji}.
     * 
If these are empty the emoji will be available to everyone otherwise only available to the specified roles.
     *
     * An emoji's restriction roles must not contain {@code null}!
     *
     * @param  roles
     *         The new set of {@link net.dv8tion.jda.api.entities.Role Roles} for the selected {@link RichCustomEmoji}
     *         to be restricted to, or {@code null} to clear the roles
     *
     * @throws IllegalArgumentException
     *         If any of the provided values is {@code null}
     *
     * @return CustomEmojiManager for chaining convenience
     */
    @Nonnull
    @CheckReturnValue
    CustomEmojiManager setRoles(@Nullable Set roles);
}