Package net.dv8tion.jda.api.managers

Interface CustomEmojiManager

All Superinterfaces:

AuditableRestAction<Void>, Manager<CustomEmojiManager>, RestAction<Void>

public interface CustomEmojiManager
extends Manager<CustomEmojiManager>

Manager providing functionality to update one or more fields for an RichCustomEmoji.

Example

 manager.setName("minn")
        .setRoles(null)
        .queue();
 manager.reset(CustomEmojiManager.NAME | CustomEmojiManager.ROLES)
        .setName("dv8")
        .setRoles(roles)
        .queue();
 

See Also:

• RichCustomEmoji.getManager()

Field Summary

Fields

Modifier and Type	Field	Description
static final long	NAME	Used to reset the name field
static final long	ROLES	Used to reset the roles field

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
RichCustomEmoji	getEmoji()	The target RichCustomEmoji that will be modified by this Manager
default Guild	getGuild()	The Guild this Manager's RichCustomEmoji is in.
CustomEmojiManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
CustomEmojiManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
CustomEmojiManager	setName(String name)	Sets the name of the selected RichCustomEmoji.
CustomEmojiManager	setRoles(Set<Role> roles)	Sets the restriction roles of the selected RichCustomEmoji.

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

Methods inherited from interface net.dv8tion.jda.api.managers.Manager

deadline, reset, setCheck, timeout

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Field Details

NAME

static final long NAME

Used to reset the name field

See Also:

• Constant Field Values

ROLES

static final long ROLES

Used to reset the roles field

See Also:

• Constant Field Values

Method Details

reset

@Nonnull
@CheckReturnValue
CustomEmojiManager reset(long fields)

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: manager.reset(CustomEmojiManager.NAME | CustomEmojiManager.ROLES);

Flag Constants:

• NAME
• ROLES

Specified by:

reset in interface Manager<CustomEmojiManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

CustomEmojiManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
CustomEmojiManager reset(@Nonnull
 long... fields)

Resets the fields specified by the provided bit-flag patterns.
Example: manager.reset(CustomEmojiManager.NAME, CustomEmojiManager.ROLES);

Flag Constants:

• NAME
• ROLES

Specified by:

reset in interface Manager<CustomEmojiManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

CustomEmojiManager for chaining convenience

getGuild

@Nonnull
default Guild getGuild()

The Guild this Manager's RichCustomEmoji is in.
This is logically the same as calling getEmoji().getGuild()

Returns:

The parent Guild

getEmoji

@Nonnull
RichCustomEmoji getEmoji()

The target RichCustomEmoji that will be modified by this Manager

Returns:

The target emoji

setName

@Nonnull
@CheckReturnValue
CustomEmojiManager setName(@Nonnull
 String name)

Sets the name of the selected RichCustomEmoji.

An emoji name must be between 2-32 characters long!
Emoji names may only be populated with alphanumeric (with underscore and dash).

Example: tatDab or fmgSUP

Parameters:

name - The new name for the selected RichCustomEmoji

Returns:

CustomEmojiManager for chaining convenience

Throws:

IllegalArgumentException - If the provided name is null or not between 2-32 characters long

setRoles

@Nonnull
@CheckReturnValue
CustomEmojiManager setRoles(@Nullable
 Set<Role> roles)

Sets the restriction roles of the selected 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 null!

Parameters:

roles - The new set of Roles for the selected RichCustomEmoji to be restricted to, or null to clear the roles

Returns:

CustomEmojiManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided values is null